Fix WASM build #312

armansito · 2023-04-23T19:06:38Z

Rolled wgpu to 0.16.
Incorprated the instant crate in lieu of std::time::Instant which works on WASM and native builds.
Fixed the issue with window scaling by setting the canvas size based on winit Window dimensions.

This resolves #276

crates.io/crates/instant provides a std::time::Instant implementation that works on both WASM and non-wasm builds.

This prevents the scaling caused by the hardcoded canvas dimensions on high dpi platforms.

DJMcNab

Code seems reasonable to me, although I can't test it without a WebGPU compatible browser.

DJMcNab · 2023-04-23T20:00:42Z

examples/scenes/Cargo.toml

@@ -16,6 +16,7 @@ vello_svg = { path = "../../integrations/vello_svg" }
 anyhow = { workspace = true }
 clap = { workspace = true, features = ["derive"] }
 image = "0.24.5"
+instant = "0.1.12"


According to instant's documentation, one of the stdweb or wasm-bindgen features need to be updated.

I still don't have a working browser with WebGPU, so maybe this works? Perhaps instant's docs need updating

Good catch. I went ahead and enabled wasm-bindgen though AFAICT all the animated scenes still worked without it.

DJMcNab · 2023-04-23T20:10:34Z

src/engine.rs

-                            bytes_per_row: NonZeroU32::new(
-                                image_proxy.width * format.describe().block_size as u32,
+                            bytes_per_row: Some(
+                                image_proxy.width * format.block_size(None).unwrap(),


Suggested change

image_proxy.width * format.block_size(None).unwrap(),

image_proxy.width * format.block_size(None).expect("All supported ImageFormats have a valid block size"),

or words to that effect

The potential division by zero in this line led to visible visual artifacts when running against WebGPU in Chrome.

armansito · 2023-04-24T03:46:55Z

Unfortunately this PR breaks the bevy example since bevy_render currently depends on wgpu 0.15.

DJMcNab

All the changes here are good, there are just a few additions I think should be included in this PR.

I think this can probably incorporate the changes from #301. In particular, that's an update of cargo-run-wasm, including the new support for the -p shorthand; adding the WASM target to the instructions is optional but would be nice.

Also, I'd like us to add a Warning to the Bevy section of the README that the example temporarily doesn't compile. (For context, we decided on Zulip that the Bevy example shouldn't block needed changes, so long as there's a reasonable expectation it won't be broken for long)

Warning
This example currently does not compile. We expect to resolve this as soon as bevy's has updated to wgpu 0.16

Additionally, we specify the wgpu version in a badge in README.md. This also needs to be updated. There should probably also be a comment to this effect in the root Cargo.toml.

armansito · 2023-04-24T23:00:38Z

All the changes here are good, there are just a few additions I think should be included in this PR.

I think this can probably incorporate the changes from #301. In particular, that's an update of cargo-run-wasm, including the new support for the -p shorthand; adding the WASM target to the instructions is optional but would be nice.

Also, I'd like us to add a Warning to the Bevy section of the README that the example temporarily doesn't compile. (For context, we decided on Zulip that the Bevy example shouldn't block needed changes, so long as there's a reasonable expectation it won't be broken for long)

Warning
This example currently does not compile. We expect to resolve this as soon as bevy's has updated to wgpu 0.16

Additionally, we specify the wgpu version in a badge in README.md. This also needs to be updated. There should probably also be a comment to this effect in the root Cargo.toml.

Done. I cherry-picked your change from #301 into the PR and updated the WASM build instructions to say cargo run_wasm -p with_winit --bin with_winit_bin (as the --bin part is still necessary for it to work correctly).

DJMcNab

So long as the most recent changes have been tested (i.e. in a browser), this seems all good

README.md

Co-authored-by: Daniel McNab <[email protected]>

armansito added 3 commits April 23, 2023 12:02

Roll wgpu to 0.16

8a35c51

[examples] Use instant crate's time::Instant

5543ad0

crates.io/crates/instant provides a std::time::Instant implementation that works on both WASM and non-wasm builds.

[with_winit] Set the canvas size to thw winit Window's inner size

4642fa0

This prevents the scaling caused by the hardcoded canvas dimensions on high dpi platforms.

armansito requested review from raphlinus and DJMcNab April 23, 2023 19:06

DJMcNab reviewed Apr 23, 2023

View reviewed changes

armansito added 3 commits April 23, 2023 16:00

Enable wasm-bindgen feature of instant crate

bb117da

Use expect instead of unwrap on image format block size

84915dc

Update run_wasm instructions

7526d1c

armansito force-pushed the fix-wasm branch from 6990b14 to b965dec Compare April 23, 2023 23:09

Add check for division-by-zero in path_coarse_full

bc903d1

The potential division by zero in this line led to visible visual artifacts when running against WebGPU in Chrome.

armansito force-pushed the fix-wasm branch from b965dec to bc903d1 Compare April 23, 2023 23:28

Fix the headless example for wgpu 0.16

51f00fb

dfrg approved these changes Apr 24, 2023

View reviewed changes

DJMcNab reviewed Apr 24, 2023

View reviewed changes

DJMcNab and others added 3 commits April 24, 2023 15:46

Update cargo-run-wasm

1529945

Include --bin with_winit_bin in run_wasm instructions

d3c54ed

Update wgpu version badge in README

b442ba5

Add warning to README about the Bevy example's compilation status

b0cc221

armansito force-pushed the fix-wasm branch from 855ee5a to b0cc221 Compare April 24, 2023 23:03

armansito requested a review from DJMcNab April 24, 2023 23:05

DJMcNab approved these changes Apr 25, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

Put the Warning label in its own line

c9d7a15

Co-authored-by: Daniel McNab <[email protected]>

armansito merged commit 8b2ea01 into linebender:main Apr 25, 2023

armansito deleted the fix-wasm branch April 25, 2023 07:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix WASM build #312

Fix WASM build #312

armansito commented Apr 23, 2023

DJMcNab left a comment

DJMcNab Apr 23, 2023

armansito Apr 23, 2023

DJMcNab Apr 23, 2023

armansito Apr 23, 2023

armansito commented Apr 24, 2023

DJMcNab left a comment

armansito commented Apr 24, 2023 •

edited

Loading

DJMcNab left a comment

	image_proxy.width * format.block_size(None).unwrap(),
	image_proxy.width * format.block_size(None).expect("All supported ImageFormats have a valid block size"),

Fix WASM build #312

Fix WASM build #312

Conversation

armansito commented Apr 23, 2023

DJMcNab left a comment

Choose a reason for hiding this comment

DJMcNab Apr 23, 2023

Choose a reason for hiding this comment

armansito Apr 23, 2023

Choose a reason for hiding this comment

DJMcNab Apr 23, 2023

Choose a reason for hiding this comment

armansito Apr 23, 2023

Choose a reason for hiding this comment

armansito commented Apr 24, 2023

DJMcNab left a comment

Choose a reason for hiding this comment

armansito commented Apr 24, 2023 • edited Loading

DJMcNab left a comment

Choose a reason for hiding this comment

armansito commented Apr 24, 2023 •

edited

Loading