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§

source§

impl<'a> ComputePass<'a>

source

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.

source

pub fn set_pipeline(&mut self, pipeline: &'a ComputePipeline)

Sets the active compute pipeline.

source

pub fn insert_debug_marker(&mut self, label: &str)

Inserts debug marker.

source

pub fn push_debug_group(&mut self, label: &str)

Start record commands and group it into debug marker group.

source

pub fn pop_debug_group(&mut self)

Stops command recording and creates debug group.

source

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.

source

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.

source§

impl<'a> ComputePass<'a>

Features::PUSH_CONSTANTS must be enabled on the device in order to call these functions.

source

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.

source§

impl<'a> ComputePass<'a>

Features::TIMESTAMP_QUERY_INSIDE_PASSES must be enabled on the device in order to call these functions.

source

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.

source§

impl<'a> ComputePass<'a>

Features::PIPELINE_STATISTICS_QUERY must be enabled on the device in order to call these functions.

source

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.

source

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.

Trait Implementations§

source§

impl<'a> Debug for ComputePass<'a>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'a> Drop for ComputePass<'a>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for ComputePass<'a>

§

impl<'a> Send for ComputePass<'a>

§

impl<'a> Sync for ComputePass<'a>

§

impl<'a> Unpin for ComputePass<'a>

§

impl<'a> !UnwindSafe for ComputePass<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Upcast<T> for T

source§

fn upcast(&self) -> Option<&T>

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSync for T
where T: Sync,