marsultor/learn-wgpu
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix all broken cross-reference links

Browse Source
This commit is contained in:
Krishna Ayyalasomayajula
2026-05-30 20:30:24 -05:00
parent ecea7ce77e
commit 6d72ecf45d
4 changed files with 14 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/01-rainbow-triangle.md
View File

@@ -13,7 +13,7 @@ blending the three vertex colors proportionally to their distance. The result
is a smooth rainbow gradient across a single primitive. We do not need a texture, is a smooth rainbow gradient across a single primitive. We do not need a texture,
a colormap, or a fragment shader with any branching — just three colored a colormap, or a fragment shader with any branching — just three colored
vertices and the default linear interpolation the [rasterizer](concepts/GLOSSARY.md#rasterizer) vertices and the default linear interpolation the [rasterizer](concepts/GLOSSARY.md#rasterizer)
applies to every [varying](concepts/GLOSSARY.md#varying). applies to every [interpolated value](concepts/GLOSSARY.md#interpolation).
If you haven't read the [concept overview](concepts/graphics-pipeline.md), do so If you haven't read the [concept overview](concepts/graphics-pipeline.md), do so
now. [Coordinate systems](concepts/coordinate-systems.md) explains how the GPU now. [Coordinate systems](concepts/coordinate-systems.md) explains how the GPU
@@ -242,10 +242,9 @@ struct State {
(e.g., after a compositor restart or display hotplug), recovery requires (e.g., after a compositor restart or display hotplug), recovery requires
reconfiguring the swapchain with the window's live size — and that requires reconfiguring the swapchain with the window's live size — and that requires
holding a reference to the window itself. holding a reference to the window itself.
- **`pipeline`** — the compiled [render pipeline](concepts/GLOSSARY.md#render-pipeline). - **`pipeline`** — the compiled [render pipeline](concepts/GLOSSARY.md#pipeline).
A render pipeline is an immutable configuration combining a shader, a vertex A render pipeline is an immutable configuration combining a shader, a vertex
buffer layout, a primitive topology, and a [color target](concepts/GLOSSARY.md#color-target) buffer layout, a primitive topology, and a color target setup. Switching pipelines mid-frame is expensive; most applications use a few
setup. Switching pipelines mid-frame is expensive; most applications use a few
pipelines and change them between draw calls. pipelines and change them between draw calls.
- **`vertex_buffer`** — GPU memory holding our vertex data. The GPU reads - **`vertex_buffer`** — GPU memory holding our vertex data. The GPU reads
position and color data directly from this buffer during the vertex shader position and color data directly from this buffer during the vertex shader
@@ -436,7 +435,7 @@ to a `VkQueue`.
**Step 5 — SurfaceConfiguration:** This allocates the **Step 5 — SurfaceConfiguration:** This allocates the
[swapchain](concepts/GLOSSARY.md#swapchain) [framebuffers](concepts/GLOSSARY.md#framebuffer). [swapchain](concepts/GLOSSARY.md#swapchain) [framebuffers](concepts/GLOSSARY.md#framebuffer).
We negotiate the pixel format with the driver (preferring an We negotiate the pixel format with the driver (preferring an
[sRGB](concepts/GLOSSARY.md#srgb) format for correct color display), pick the [sRGB](concepts/GLOSSARY.md) format for correct color display), pick the
window dimensions (clamped to at least 1x1 to allow minimize-and-restore on some window dimensions (clamped to at least 1x1 to allow minimize-and-restore on some
platforms), and select the [present mode](concepts/GLOSSARY.md#present-mode). platforms), and select the [present mode](concepts/GLOSSARY.md#present-mode).
`PresentMode::Mailbox` is a triple-buffered present mode that provides `PresentMode::Mailbox` is a triple-buffered present mode that provides
@@ -685,7 +684,7 @@ const VERTICES: &[Vertex] = &[
red → blue → green. In a standard right-handed coordinate system, connecting red → blue → green. In a standard right-handed coordinate system, connecting
vertices in this sequence traces the triangle counter-clockwise. This vertices in this sequence traces the triangle counter-clockwise. This
determines which face is "front" and which is "back" — critical for determines which face is "front" and which is "back" — critical for
[culling](concepts/GLOSSARY.md#rasterizer) and correct normal computation. [culling](concepts/GLOSSARY.md) and correct normal computation.
### Buffer Upload ### Buffer Upload
@@ -1103,7 +1102,7 @@ color_attachments: &[Some(wgpu::RenderPassColorAttachment {
**`RenderPassColorAttachment` has exactly 4 fields:** **`RenderPassColorAttachment` has exactly 4 fields:**
- **`view: &texture_view`** — the framebuffer we draw into. Must match the - **`view: &texture_view`** — the framebuffer we draw into. Must match the
color target format in the [render pipeline](concepts/GLOSSARY.md#render-pipeline). color target format in the [render pipeline](concepts/GLOSSARY.md#pipeline).
- **`depth_slice: None`** — only used for 3D texture slices. Not applicable - **`depth_slice: None`** — only used for 3D texture slices. Not applicable
to 2D rendering. to 2D rendering.
- **`resolve_target: None`** — only used for MSAA resolve. When multisampling - **`resolve_target: None`** — only used for MSAA resolve. When multisampling
@@ -1134,7 +1133,7 @@ that pass the depth test). Useful for visibility-based culling.
### Binding State and Drawing ### Binding State and Drawing
**`render_pass.set_pipeline(&self.pipeline)`** — Tells the GPU which **`render_pass.set_pipeline(&self.pipeline)`** — Tells the GPU which
[render pipeline](concepts/GLOSSARY.md#render-pipeline) to use for subsequent [render pipeline](concepts/GLOSSARY.md#pipeline) to use for subsequent
draw calls. The pipeline encapsulates the shader programs, vertex format, draw calls. The pipeline encapsulates the shader programs, vertex format,
primitive topology, and output configuration. Must be set before any draw call primitive topology, and output configuration. Must be set before any draw call
in a render pass. Switching pipelines mid-pass is expensive and should be in a render pass. Switching pipelines mid-pass is expensive and should be
@@ -1341,7 +1340,7 @@ each piece does:
Each layer adds a capability: driver connection, window binding, GPU selection, Each layer adds a capability: driver connection, window binding, GPU selection,
resource management, and swapchain allocation. resource management, and swapchain allocation.
- **The [render pipeline](concepts/GLOSSARY.md#pipeline-render):** Shaders, - **The [render pipeline](concepts/GLOSSARY.md#pipeline):** Shaders,
topology, and vertex layout compiled into a GPU configuration. Created once, topology, and vertex layout compiled into a GPU configuration. Created once,
reused every frame. Expensive to create, cheap to execute. reused every frame. Expensive to create, cheap to execute.

4
docs/TROUBLESHOOTING.md
View File

@@ -57,7 +57,7 @@ vulkaninfo # verify installation
**Symptom:** Program crashes with a surface lost error during rendering. **Symptom:** Program crashes with a surface lost error during rendering.
**Cause:** Display server restarted or GPU context was reset. The [Surface](concepts/GLOSSARY.md#Surface) is permanently invalidated. **Cause:** Display server restarted or GPU context was reset. The [Surface](concepts/GLOSSARY.md#surface) is permanently invalidated.
**Fix:** In the tutorial, this means the window needs to be reopened. In production code, handle the `Lost` variant of `CurrentSurfaceTexture` by recreating the surface via `Instance::create_surface()`. **Fix:** In the tutorial, this means the window needs to be reopened. In production code, handle the `Lost` variant of `CurrentSurfaceTexture` by recreating the surface via `Instance::create_surface()`.
@@ -108,7 +108,7 @@ fn exiting(&mut self, event_loop_ctl: &ActiveEventLoop) {
**Symptom:** Triangle renders but is a single uniform color instead of smoothly blending. **Symptom:** Triangle renders but is a single uniform color instead of smoothly blending.
**Cause:** Fragment shader returns a constant color instead of passing through `input.vertex_color`. The [rasterizer](concepts/GLOSSARY.md#Rasterizer) interpolates vertex colors automatically, but only if the fragment shader uses them. **Cause:** Fragment shader returns a constant color instead of passing through `input.vertex_color`. The [rasterizer](concepts/GLOSSARY.md#rasterizer) interpolates vertex colors automatically, but only if the fragment shader uses them.
**Fix:** Ensure fragment shader returns the interpolated vertex color: **Fix:** Ensure fragment shader returns the interpolated vertex color:
```wgsl ```wgsl

4
docs/concepts/GLOSSARY.md
View File

@@ -32,7 +32,7 @@ The logical connection to the GPU. Created from an [[adapter]](#adapter), the de
## Fragment ## Fragment
A potential pixel produced by the [[rasterizer]](#rasterizer). One fragment is generated per screen pixel that a [[primitive]](#primitive) covers. A fragment carries interpolated [[vertex]](#vertex) shader outputs, a depth value, and a color. The fragment may be later discarded by depth testing, stencil testing, or alpha testing during the [[output merge]](#output-merge)(graphics-pipeline.md#stage-5-output-merge) stage. Not every fragment becomes a visible pixel. A potential pixel produced by the [[rasterizer]](#rasterizer). One fragment is generated per screen pixel that a [[primitive]](#primitive) covers. A fragment carries interpolated [[vertex]](#vertex) shader outputs, a depth value, and a color. The fragment may be later discarded by depth testing, stencil testing, or alpha testing during the [[output merge]](#output-merge) ([Stage 5](graphics-pipeline.md#stage-5-output-merge)) stage. Not every fragment becomes a visible pixel.
## Fragment shader ## Fragment shader
@@ -74,7 +74,7 @@ The strategy passed to `device.poll()`, which processes all completed GPU comman
How the display compositor handles frame buffer presentation: `PresentMode::Mailbox` uses triple buffering for tear-free rendering, `PresentMode::Fifo` provides VSYNC-locked double buffering, `PresentMode::Immediate` renders without synchronization (may show tearing). How the display compositor handles frame buffer presentation: `PresentMode::Mailbox` uses triple buffering for tear-free rendering, `PresentMode::Fifo` provides VSYNC-locked double buffering, `PresentMode::Immediate` renders without synchronization (may show tearing).
## Ndc ## NDC
Normalized Device Coordinates. The GPU's native intermediate coordinate space. X and Y range from -1.0 (left/bottom) to +1.0 (right/top). Z ranges from 0.0 (near clipping plane) to 1.0 (far clipping plane). Geometry is mapped into NDC by the GPU after perspective division. Anything outside this cube is clipped. See [[coordinate-systems.md]](coordinate-systems.md). Normalized Device Coordinates. The GPU's native intermediate coordinate space. X and Y range from -1.0 (left/bottom) to +1.0 (right/top). Z ranges from 0.0 (near clipping plane) to 1.0 (far clipping plane). Geometry is mapped into NDC by the GPU after perspective division. Anything outside this cube is clipped. See [[coordinate-systems.md]](coordinate-systems.md).

2
docs/concepts/shader-basics.md
View File

@@ -79,7 +79,7 @@ Data flows between the vertex and fragment stages through a shared struct. The s
The vertex shader produces a struct containing a `@builtin(position)` output plus any number of `@location` interpolants. The rasterizer takes these outputs, assembles [[primitives]](GLOSSARY.md#primitive), and for every pixel inside the triangle computes [[barycentric coordinates]](GLOSSARY.md#barycentric-coordinates) and blends all `@location` fields. The fragment shader receives the fully interpolated struct and outputs a `vec4<f32>` color at `@location(0)`, which maps to the [[pipeline]](GLOSSARY.md#pipeline)'s color attachment target. The vertex shader produces a struct containing a `@builtin(position)` output plus any number of `@location` interpolants. The rasterizer takes these outputs, assembles [[primitives]](GLOSSARY.md#primitive), and for every pixel inside the triangle computes [[barycentric coordinates]](GLOSSARY.md#barycentric-coordinates) and blends all `@location` fields. The fragment shader receives the fully interpolated struct and outputs a `vec4<f32>` color at `@location(0)`, which maps to the [[pipeline]](GLOSSARY.md#pipeline)'s color attachment target.
For a complete line-by-line walkthrough of our rainbow triangle shader, see [Section 4](01-rainbow-triangle.md#section-4-writing-the-shaders). For a complete line-by-line walkthrough of our rainbow triangle shader, see [Section 4](01-rainbow-triangle.md#s4-writing-the-shaders).
## WGSL Source Embedding ## WGSL Source Embedding