Skip to main content

IndirectDispatchBuffer

Struct IndirectDispatchBuffer 

Source
pub struct IndirectDispatchBuffer { /* private fields */ }
Expand description

A GPU buffer that holds one or more DispatchIndirectArgs slots for use with wgpu::ComputePass::dispatch_workgroups_indirect.

Each slot occupies exactly 12 bytes (the size of one DispatchIndirectArgs). The buffer is created with INDIRECT | COPY_DST | STORAGE usages so it can both receive CPU-side writes and be written by a preceding compute shader pass.

§Multi-slot layout

Offset 0       12     24     36 …
        ├──────┼──────┼──────┤
        │ [0]  │ [1]  │ [2]  │  …
        └──────┴──────┴──────┘
          12 B   12 B   12 B

The active slot for a dispatch is selected via IndirectDispatchBuffer::offset (defaults to slot 0) and can be overridden by calling IndirectDispatchBuffer::update_at to write to a specific slot and then constructing a view with the desired byte offset — or by creating separate buffers for each independently-driven dispatch.

Implementations§

Source§

impl IndirectDispatchBuffer

Source

pub fn new(ctx: &GpuContext, args: DispatchIndirectArgs) -> GpuResult<Self>

Create a single-slot indirect dispatch buffer initialised with args.

The buffer is 12 bytes and supports INDIRECT | COPY_DST | STORAGE usages.

§Errors

Returns GpuError::InvalidKernelParams if the device rejects the buffer descriptor (should not happen in practice).

Source

pub fn new_with_capacity( ctx: &GpuContext, max_dispatches: u32, ) -> GpuResult<Self>

Create a multi-slot indirect dispatch buffer with max_dispatches slots, all initialised to zero.

The total buffer size is 12 * max_dispatches bytes. Each slot can be written individually via IndirectDispatchBuffer::update_at.

§Errors

Returns GpuError::InvalidKernelParams if max_dispatches is 0.

Source

pub fn update(&self, ctx: &GpuContext, args: DispatchIndirectArgs)

Overwrite slot 0 with new dispatch arguments.

This is a CPU-side write using queue.write_buffer; the data is uploaded before the next queue.submit.

Source

pub fn update_at( &self, ctx: &GpuContext, slot_idx: u32, args: DispatchIndirectArgs, ) -> GpuResult<()>

Overwrite a specific slot (0-indexed) with new dispatch arguments.

§Errors

Returns GpuError::InvalidKernelParams if slot_idx >= capacity.

Source

pub fn buffer(&self) -> &Buffer

Return a reference to the underlying wgpu::Buffer.

Source

pub fn offset(&self) -> BufferAddress

Return the byte offset of slot 0 within the buffer.

This is the value passed as the second argument to ComputePass::dispatch_workgroups_indirect.

Source

pub fn capacity(&self) -> u32

Return the number of 12-byte dispatch slots in the buffer.

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

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>,

Source§

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> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more