Add explaination of the raw wasm module #42
Conversation
alfiedotwtf
changed the title
There was a problem hiding this comment.
Thanks for cleaning a lot of this stuff up @alfiedotwtf :)
I have a few nitpicks inline below that we should fix before merging. Also some things that I think @ashleygwilliams or @mgattozzi should sign off on regarding the wasm-pack tutorial bits.
Thanks!
src/game-of-life/implementing.md
Outdated
| cell is dead or alive, respectively. By working with pointers and overlays, we | ||
| avoid copying the cells across the boundary on every tick. | ||
| We can directly access WebAssembly's linear memory via `memory`, which is | ||
| defined in the raw wasw module `wasm_game_of_life_bg`. To draw the cells, we |
src/game-of-life/setup.md
Outdated
| have to worry about it too much and just write Rust code for the most part. If | ||
| you want to know the full extent of its capabilities check out the README on | ||
| its repo which can be found | ||
| [here](https://github.com/alexcrichton/wasm-bindgen). For our purposes we need |
There was a problem hiding this comment.
nitpick: the canonical repo is https://github.com/rustwasm/wasm-bindgen now
src/game-of-life/setup.md
Outdated
| you want to know the full extent of its capabilities check out the README on | ||
| its repo which can be found | ||
| [here](https://github.com/alexcrichton/wasm-bindgen). For our purposes we need | ||
| to know that if we want functions to work with wasm easily we'll need it. |
There was a problem hiding this comment.
This last sentence isn't very clear to me.
In fact, I think we can replace these first two paragraphs with simply:
> We will use [wasm-bindgen](https://github.com/rustwasm/wasm-bindgen) to
> communicate between Rust/wasm and JavaScript. `wasm-bindgen` currently
> relies on nightly-only features (`proc_macro`, etc...) that we must opt
> into using.I want to keep the intro very short and to the point because people bounce off of walls of text, especially when first getting started before they are hooked.
src/game-of-life/setup.md
Outdated
| [here](https://github.com/alexcrichton/wasm-bindgen). For our purposes we need | ||
| to know that if we want functions to work with wasm easily we'll need it. | ||
|
|
||
| The `extern crate` call lets the compiler know what crates to link in and the |
There was a problem hiding this comment.
nitpick: "call" is not the right word here, because it isn't a function or method.
We could either completely drop it, or replace with "declaration".
There was a problem hiding this comment.
I agree to removing this.
src/game-of-life/time-profiling.md
Outdated
| @@ -28,8 +28,8 @@ Calling `performance.now` has very little overhead, so we can create simple | |||
| measurements from it without distorting the performance of the rest of the | |||
| system. | |||
|
|
|||
| For example, we can create a simple FPS counter that we update on each iteration | |||
| of our `renderLoop`: | |||
| For example, we can create a simple FPS (frames per second) counter that we | |||
There was a problem hiding this comment.
Let's flip this to "frames per second (FPS)"
src/wasm-pack/rust-code.md
Outdated
| prelude from `wasm-bindgen`. The `extern crate` call lets the compiler know what crates to link in | ||
| and the `prelude` contains all the types and functions that `wasm-bindgen` needs to work properly! | ||
|
|
||
| Cool let's import the `alert` function from JS so that we can call it in our Rust code! |
There was a problem hiding this comment.
I'm unsure whether we want to remove all this and what level of wasm-bindgen familiarity the wasm-pack tutorial is expecting.
There was a problem hiding this comment.
Cool. I've put them back in.
|
I think that's everything. Let me know if you find anything else needing changes 👍 |
There was a problem hiding this comment.
LGTM, thanks @alfiedotwtf!
Would still like to hold off on merging before @ashleygwilliams signs off on the wasm-pack tutorial changes.
|
I've dropped the wasm-pack tutorial commits, so that the rest can be merged. I'll submit a separate PR for them so that these don't go stale. |
In reference to #38