Skip to content

Commit

Permalink
more typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Vrixyz committed Dec 2, 2024
1 parent 02dffce commit 4cced3f
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/user_guides/templates/wgcore/buffers_readback.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The code described in this section can be run from the
:::

After our buffer have been [initialized](./buffers_initialization.mdx), and our compute kernels have run, you might need
to read the results back to RAM for further processing on the CPU side. Reading the content of a GPU buffers require a
to read the results back to RAM for further processing on the CPU side. Reading the content of a GPU buffer require a
few steps:
1. Be sure that the buffer you want to read from was initialized with `BufferUsages::COPY_SRC`:
```rust
Expand Down
6 changes: 3 additions & 3 deletions docs/user_guides/templates/wgcore/hot_reloading.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,16 @@ Say you are working on an application’s code (like, for example, one of the ex
[wgebra](https://github.com/dimforge/wgmath)) using a [cargo patch](https://doc.rust-lang.org/cargo/reference/overriding-dependencies.html).
Using the code snippet from the previous section, you can leverage hot-reloading on **any** shader, even the ones
from the local dependencies. The `derive(Shader)` macros will automatically figure out the absolute path of all the
shaders at compile-time so the can be watched with `Shader::watch_sources`.
shaders at compile-time so they can be watched with `Shader::watch_sources`.

:::danger
This automatic detection of shader paths might not work properly if you run your application from a directory that is
different from the root of the rust workspace it is built from. This is due to some limitations in the Rust libraries
that will hopefully be stabilized in future versions of the compiler.
:::

This won’t work for shaders of a dependency that is not available locally on your machine, since there is no way to
actual shader file that could be modified (since they are embedded in the library directly). In order to make it work
This won’t work for shaders of a dependency that is not available locally on your machine, since there is no way that
the actual shader file could be modified (since they are embedded in the library directly). In order to make it work
for these shaders, you can [overwrite them](./overwriting_shaders.mdx) with a local version of the shader by specifying
their path with `Shader::set_wgsl_path`. After their path is overwritten, `Shader::watch_sources` needs to be called
and hot-reloading will work.
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guides/templates/wgcore/shaders_composition.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Your output will differ from this one due to various factors like different UUID
## Running the kernel

In addition to initializing the compute pipeline, `wgcore` exports some convenient utilities for actually running it.
First, the input buffers can be initialized easily using the `GpuScalar`, `GpuVector`, `GpuMatrix` wrappers (the all
First, the input buffers can be initialized easily using the `GpuScalar`, `GpuVector`, `GpuMatrix` wrappers (they all
initialize and contain a regular wgpu `Buffer`).

```rust
Expand Down

0 comments on commit 4cced3f

Please sign in to comment.