Struct wgpu::ComputePass
source · [−]pub struct ComputePass<'a> { /* private fields */ }Expand description
In-progress recording of a compute pass.
It can be created with CommandEncoder::begin_compute_pass.
Corresponds to WebGPU GPUComputePassEncoder.
Implementations
sourceimpl<'a> ComputePass<'a>
impl<'a> ComputePass<'a>
sourcepub fn set_bind_group(
&mut self,
index: u32,
bind_group: &'a BindGroup,
offsets: &[DynamicOffset]
)
pub fn set_bind_group(
&mut self,
index: u32,
bind_group: &'a BindGroup,
offsets: &[DynamicOffset]
)
Sets the active bind group for a given bind group index. The bind group layout
in the active pipeline when the dispatch() function is called must match the layout of this bind group.
If the bind group have dynamic offsets, provide them in the binding order.
These offsets have to be aligned to Limits::min_uniform_buffer_offset_alignment
or Limits::min_storage_buffer_offset_alignment appropriately.
sourcepub fn set_pipeline(&mut self, pipeline: &'a ComputePipeline)
pub fn set_pipeline(&mut self, pipeline: &'a ComputePipeline)
Sets the active compute pipeline.
sourcepub fn insert_debug_marker(&mut self, label: &str)
pub fn insert_debug_marker(&mut self, label: &str)
Inserts debug marker.
sourcepub fn push_debug_group(&mut self, label: &str)
pub fn push_debug_group(&mut self, label: &str)
Start record commands and group it into debug marker group.
sourcepub fn pop_debug_group(&mut self)
pub fn pop_debug_group(&mut self)
Stops command recording and creates debug group.
sourcepub fn dispatch_workgroups(&mut self, x: u32, y: u32, z: u32)
pub fn dispatch_workgroups(&mut self, x: u32, y: u32, z: u32)
Dispatches compute work operations.
x, y and z denote the number of work groups to dispatch in each dimension.
sourcepub fn dispatch_workgroups_indirect(
&mut self,
indirect_buffer: &'a Buffer,
indirect_offset: BufferAddress
)
pub fn dispatch_workgroups_indirect(
&mut self,
indirect_buffer: &'a Buffer,
indirect_offset: BufferAddress
)
Dispatches compute work operations, based on the contents of the indirect_buffer.
The structure expected in indirect_buffer must conform to DispatchIndirect.
sourceimpl<'a> ComputePass<'a>
impl<'a> ComputePass<'a>
Features::PUSH_CONSTANTS must be enabled on the device in order to call these functions.
sourcepub fn set_push_constants(&mut self, offset: u32, data: &[u8])
pub fn set_push_constants(&mut self, offset: u32, data: &[u8])
Set push constant data for subsequent dispatch calls.
Write the bytes in data at offset offset within push constant
storage. Both offset and the length of data must be
multiples of PUSH_CONSTANT_ALIGNMENT, which is always 4.
For example, if offset is 4 and data is eight bytes long, this
call will write data to bytes 4..12 of push constant storage.
sourceimpl<'a> ComputePass<'a>
impl<'a> ComputePass<'a>
Features::WRITE_TIMESTAMP_INSIDE_PASSES must be enabled on the device in order to call these functions.
sourcepub fn write_timestamp(&mut self, query_set: &QuerySet, query_index: u32)
pub fn write_timestamp(&mut self, query_set: &QuerySet, query_index: u32)
Issue a timestamp command at this point in the queue. The timestamp will be written to the specified query set, at the specified index.
Must be multiplied by Queue::get_timestamp_period to get
the value in nanoseconds. Absolute values have no meaning,
but timestamps can be subtracted to get the time it takes
for a string of operations to complete.
sourceimpl<'a> ComputePass<'a>
impl<'a> ComputePass<'a>
Features::PIPELINE_STATISTICS_QUERY must be enabled on the device in order to call these functions.
sourcepub fn begin_pipeline_statistics_query(
&mut self,
query_set: &QuerySet,
query_index: u32
)
pub fn begin_pipeline_statistics_query(
&mut self,
query_set: &QuerySet,
query_index: u32
)
Start a pipeline statistics query on this render pass. It can be ended with
end_pipeline_statistics_query. Pipeline statistics queries may not be nested.
sourcepub fn end_pipeline_statistics_query(&mut self)
pub fn end_pipeline_statistics_query(&mut self)
End the pipeline statistics query on this render pass. It can be started with
begin_pipeline_statistics_query. Pipeline statistics queries may not be nested.