Skip to main content

Module cmd

Module cmd 

Source
Expand description

Strongly-typed Graph commands.

§Lifecycle

Commands follow a builder-style chain:

  1. Graph::begin_cmd opens a Command.
  2. Declare resource accesses with Command::resource_access or bind a shader pipeline with Command::bind_pipeline, returning a PipelineCommand.
  3. With a pipeline, declare shader bindings with PipelineCommand::shader_resource_access.
  4. Record work with record_cmd — available on both Command and PipelineCommand.
  5. The command auto-closes when dropped or when Graph::finalize is called.

A single command can call record_cmd multiple times — each call creates a separate “execution” within that command. Executions within a command stay in the specified order, but the graph system may re-order entire commands or merge them during submission for optimal scheduling.

Re-exports§

pub use super::LoadOp;
pub use super::StoreOp;

Structs§

Binding
Describes the SPIR-V binding index, and optionally a specific descriptor set and array index.
BuildAccelerationStructureIndirectInfo
Specifies the information and data used to build an acceleration structure with some parameters sourced on the device.
BuildAccelerationStructureInfo
Specifies the information and data used to build an acceleration structure.
Command
A general-purpose Vulkan command which may contain acceleration structure operations, transfers, or shader pipelines.
CommandBuilder
Builder for incrementally constructing a Command.
CommandRef
Recording interface for general Vulkan commands.
ComputeCommandRef
Recording interface for compute commands.
GraphicsCommandRef
Recording interface for drawing commands.
PipelineCommand
A Command which has been bound to a particular compute, graphics, or ray tracing pipeline.
RayTracingCommandRef
Recording interface for ray tracing commands.
UpdateAccelerationStructureIndirectInfo
Specifies the information and data used to update an acceleration structure with some parameters sourced on the device.
UpdateAccelerationStructureInfo
Specifies the information and data used to update an acceleration structure.

Enums§

ClearColorValue
Structure specifying a clear color value.

Traits§

Pipeline
A trait for pipelines which may be bound to a Command.
Subresource
Allows for a resource to be reinterpreted as differently formatted data.