Skip to content

Web: document dlink_enabled as the GDExtension tradeoff it is, not a requirement #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
octopusburrow wants to merge 1 commit into
base: webgpu-4.6.2
Choose a base branch
from
Open

Web: document dlink_enabled as the GDExtension tradeoff it is, not a requirement #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,10 +210,21 @@ Pre-built macOS editor with WebGPU export support.
## Building from Source

```bash
# WebGPU-only release template:
# WebGPU release template (no GDExtension support — smaller, faster boot):
scons platform=web target=template_release webgpu=yes opengl3=no threads=no

# WebGPU release template WITH GDExtension support (dynamic linking):
scons platform=web target=template_release dlink_enabled=yes webgpu=yes opengl3=no threads=no
```

Build-flag decisions (each is a per-project tradeoff, not a requirement):

| Flag | Engine default | Effect of deviating |
|---|---|---|
| `dlink_enabled=yes` | off | Enables GDExtension plugins on web. Costs a larger download (split main+side module) and a multi-second main-thread link/relocation step after the download bar completes — measured ~10s of silent post-bar stall on a mid-size template vs ~2-3s without. Only needed if the project uses GDExtensions (upstream Godot ships both template variants and selects per-project via the export preset's "Extensions Support" checkbox). |
| `opengl3=no` | on | Strips the GL driver: smaller template, but no `gl_compatibility` fallback for browsers without WebGPU. Keep GL in (like the debug recipe above does) if you want graceful fallback. |
| `threads=no` | on | Single-threaded build: avoids the COOP/COEP cross-origin-isolation hosting requirement. Currently required by this backend's single-threaded design assumptions. |

Requirements:
- Emscripten 4.0.10+ (for the emdawnwebgpu port)
- No Rust toolchain needed (Tint C++ translator is compiled directly into the engine)
Expand Down
2 changes: 1 addition & 1 deletion webgpu_site/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ All major desktop browsers with WebGPU enabled. Mobile browser support is emergi
scons platform=web target=template_release dlink_enabled=yes webgpu=yes opengl3=no threads=no
```

The `dlink_enabled=yes` flag enables Emscripten dynamic linking, which produces a main module (`godot.wasm`) and a side module (`godot.side.wasm`). This is required for the WebGPU export template.
The `dlink_enabled=yes` flag enables Emscripten dynamic linking, which produces a main module (`godot.wasm`) and a side module (`godot.side.wasm`). It is required only for GDExtension support on web — the WebGPU template builds and runs without it (verified: compile, desktop rendering, and immersive-vr entry all work on a non-dlink build), and the monolithic build is smaller and avoids a multi-second main-thread linking step after download. Use `dlink_enabled=yes` when the project ships GDExtensions; omit it otherwise.

Requirements:
- Emscripten 4.0.10+ (for the emdawnwebgpu port)
Expand Down