Module command

Source

Modulesยง

allocator ๐Ÿ”’
bind ๐Ÿ”’
bundle ๐Ÿ”’
Render Bundles
bundle_ffi
clear ๐Ÿ”’
compute ๐Ÿ”’
compute_command ๐Ÿ”’
draw ๐Ÿ”’
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::ComputePass or render::RenderPass and 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ยง

ArcRenderPassDepthStencilAttachment
Describes a depth/stencil attachment to a render pass.
BakedCommands ๐Ÿ”’
Look at the documentation for CommandBufferMutable for an explanation of the fields in this struct. This is the โ€œbuiltโ€ counterpart to that type.
BindGroupStateChange ๐Ÿ”’
CommandBuffer
A buffer of commands to be submitted to the GPU for execution.
CommandBufferMutable
The mutable state of a CommandBuffer.
CommandEncoder ๐Ÿ”’
A raw CommandEncoder, and the raw CommandBuffers built from it.
ComputePass
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.
ComputePassDescriptor
ComputePassError
Error encountered when performing a compute pass, stored for later reporting when encoding ends.
PassChannel
Describes an individual channel within a render pass, such as color, depth, or stencil.
PassStateError
Variant of EncoderStateError that includes the pass scope.
PassTimestampWrites
Describes the writing of timestamp values in a render or compute pass.
RecordingGuard ๐Ÿ”’
A guard to enforce error reporting, for a CommandBuffer in the Recording state.
Rect
RenderBundle
RenderBundleEncoder
RenderBundleEncoderDescriptor
Describes a RenderBundleEncoder.
RenderBundleError
Error encountered when finishing recording a render bundle.
RenderPass
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.
RenderPassColorAttachment
Describes a color attachment to a render pass.
RenderPassDepthStencilAttachment
Describes a depth/stencil attachment to a render pass.
RenderPassDescriptor
Describes the attachments of a render pass.
RenderPassError
Error encountered when performing a render pass.
StateChange ๐Ÿ”’

Enumsยง

AttachmentError
AttachmentErrorLocation
Describes an attachment location in words.
ClearError
Error encountered while attempting a clear.
ColorAttachmentError
CommandEncoderError
CommandEncoderStatus ๐Ÿ”’
The current state of a command or pass encoder.
ComputeCommand
ComputePassErrorInner
Error encountered when performing a compute pass.
CopySide
CreateRenderBundleError
Error type returned from RenderBundleEncoder::new if the sample count is invalid.
DispatchError
DrawError
Error validating a draw call.
DrawKind
EncoderStateError
Errors related to the state of a command or pass encoder.
ExecutionError
Error type returned from RenderBundleEncoder::new if the sample count is invalid.
LoadOp
Operation to perform to the output attachment at the start of a render pass.
PassErrorScope
A command that can be recorded in a pass or bundle.
QueryError
Error encountered when dealing with queries
QueryUseError
Error encountered while trying to use queries
RenderCommandError
Error encountered when encoding a render command. This is the shared error set between render bundles and passes.
RenderPassErrorInner
Error encountered when performing a render pass.
ResolveError
Error encountered while trying to resolve a query.
ResolvedPassChannel
SimplifiedQueryType
StoreOp
Operation to perform to the output attachment at the end of a render pass.
TimestampWritesError
TransferError
Error encountered while attempting a data transfer.

Constantsยง

PUSH_CONSTANT_CLEAR_ARRAY ๐Ÿ”’

Traitsยง

MapPassErr ๐Ÿ”’
Helper to attach PassErrorScope to errors.

Functionsยง

push_constant_clear ๐Ÿ”’

Type Aliasesยง

ArcRenderPassColorAttachment
ComputeBasePass
CopyExternalImageDestInfo
RenderBasePass
RenderBundleDescriptor
TexelCopyBufferInfo
TexelCopyTextureInfo