Expand description
§Command Encoding
TODO: High-level description of command encoding.
The convention in this module is that functions accepting a [&mut dyn hal::DynCommandEncoder] are low-level helpers and may assume the encoder is
in the open state, ready to encode commands. Encoders that are not open
should be nested within some other container that provides additional
state tracking, like InnerCommandEncoder.
Modules§
- allocator 🔒
- bind 🔒
- bundle 🔒
- Render Bundles
- bundle_
ffi - clear 🔒
- compute 🔒
- compute_
command 🔒 - draw 🔒
- encoder 🔒
- encoder_
command 🔒 - ffi
- Types that are useful for FFI bindings to
wgpu. - memory_
init 🔒 - pass 🔒
- Generic pass functions that both compute and render passes need.
- query 🔒
- ray_
tracing 🔒 - render 🔒
- render_
command 🔒 - timestamp_
writes 🔒 - transfer 🔒
- transition_
resources 🔒
Macros§
- pass_
base 🔒 - Checks the state of a
compute::ComputePassorrender::RenderPassand evaluates to a mutable reference to the [BasePass], if the pass is open and valid. - pass_
try 🔒 - Handles the error case in an expression of type
Result<T, E>.
Structs§
- ArcReferences
- Reference wgpu objects via
Arcs. - Baked
Commands 🔒 - Look at the documentation for
CommandBufferMutablefor an explanation of the fields in this struct. This is the “built” counterpart to that type. - Bind
Group 🔒State Change - Command
Buffer - A buffer of commands to be submitted to the GPU for execution.
- Command
Buffer Mutable - The mutable state of a
CommandBuffer. - Command
Encoder 🔒 - Compute
Pass - A pass’s encoder state and its validity are two distinct conditions, i.e., the full matrix of (open, ended) x (valid, invalid) is possible.
- Compute
Pass Descriptor - Compute
Pass Error - Error encountered when performing a compute pass, stored for later reporting when encoding ends.
- IdReferences
- Reference wgpu objects via numeric IDs assigned by
crate::identity::IdentityManager. - Inner
Command 🔒Encoder - A raw
CommandEncoder, and the rawCommandBuffers built from it. - Pass
Channel - Describes an individual channel within a render pass, such as color, depth, or stencil.
- Pass
State Error - Variant of
EncoderStateErrorthat includes the pass scope. - Pass
Timestamp Writes - Describes the writing of timestamp values in a render or compute pass.
- Recording
Guard 🔒 - A guard to enforce error reporting, for a
CommandBufferin theRecordingstate. - Rect
- Render
Bundle - cbindgen:ignore
- Render
Bundle Encoder - Render
Bundle Encoder Descriptor - Describes a
RenderBundleEncoder. - Render
Bundle Error - Error encountered when finishing recording a render bundle.
- Render
Pass - A pass’s encoder state and its validity are two distinct conditions, i.e., the full matrix of (open, ended) x (valid, invalid) is possible.
- Render
Pass Color Attachment - Describes a color attachment to a render pass.
- Render
Pass Depth Stencil Attachment - Describes a depth/stencil attachment to a render pass.
- Render
Pass Descriptor - Describes the attachments of a render pass.
- Render
Pass Error - Error encountered when performing a render pass.
- Resolved
Render Pass Depth Stencil Attachment - Describes a depth/stencil attachment to a render pass.
- State
Change 🔒
Enums§
- Attachment
Error - Attachment
Error Location - Describes an attachment location in words.
- Clear
Error - Error encountered while attempting a clear.
- Color
Attachment Error - Command
- Command
Encoder Error - Command
Encoder 🔒Status - The current state of a command or pass encoder.
- Compute
Command - cbindgen:ignore cbindgen:ignore
- Compute
Pass Error Inner - Error encountered when performing a compute pass.
- Copy
Side - Create
Render Bundle Error - Error type returned from
RenderBundleEncoder::newif the sample count is invalid. - Debug
Group Error - Dispatch
Error - Draw
Command Family - The type of draw command(indexed or not, or mesh shader)
- Draw
Error - Error validating a draw call.
- Draw
Kind - Encoder
State Error - Errors related to the state of a command or pass encoder.
- Encoding
Api - The encoding API being used with a
CommandEncoder. - Execution
Error - Error type returned from
RenderBundleEncoder::newif the sample count is invalid. - LoadOp
- Operation to perform to the output attachment at the start of a render pass.
- Pass
Error Scope - A command that can be recorded in a pass or bundle.
- Query
Error - Error encountered when dealing with queries
- Query
UseError - Error encountered while trying to use queries
- Render
Bundle Error Inner - Error encountered when finishing recording a render bundle.
- Render
Command Error - Error encountered when encoding a render command. This is the shared error set between render bundles and passes.
- Render
Pass Error Inner - Error encountered when performing a render pass.
- Resolve
Error - Error encountered while trying to resolve a query.
- Resolved
Pass Channel - Describes an individual channel within a render pass, such as color, depth, or stencil.
- Simplified
Query Type - StoreOp
- Operation to perform to the output attachment at the end of a render pass.
- Timestamp
Writes Error - Transfer
Error - Error encountered while attempting a data transfer.
Constants§
Traits§
- MapPass
Err 🔒 - Helper to attach
PassErrorScopeto errors. - Reference
Type
Functions§
Type Aliases§
- ArcCommand
- ArcCompute
Command - cbindgen:ignore
- ArcRender
Command - Equivalent to
RenderCommandwith the Ids resolved into resource Arcs. - ArcRender
Pass Color Attachment - Color
Attachments - Compute
Base Pass - Copy
External Image Dest Info - cbindgen:ignore
- Render
Base Pass - Render
Bundle Descriptor - Texel
Copy Buffer Info - cbindgen:ignore
- Texel
Copy Texture Info - cbindgen:ignore