Skip to main content

DispatchIndirectArgs

Struct DispatchIndirectArgs 

Source
#[repr(C)]
pub struct DispatchIndirectArgs { pub x: u32, pub y: u32, pub z: u32, }
Expand description

Layout-stable representation of workgroup dispatch dimensions stored in GPU memory.

The struct is repr(C) so that its in-memory byte layout is well-defined and can be written directly to a GPU buffer via wgpu::Queue::write_buffer. It corresponds to the 12-byte VkDispatchIndirectCommand structure (and its equivalents in D3D12 and Metal).

§Layout

BytesFieldMeaning
0–3xWorkgroup count along X axis
4–7yWorkgroup count along Y axis
8–11zWorkgroup count along Z axis

All values are stored in little-endian byte order when serialised via DispatchIndirectArgs::as_bytes.

Fields§

§x: u32

Workgroup count along the X dispatch dimension.

§y: u32

Workgroup count along the Y dispatch dimension.

§z: u32

Workgroup count along the Z dispatch dimension.

Implementations§

Source§

impl DispatchIndirectArgs

Source

pub fn new(x: u32, y: u32, z: u32) -> Self

Create new dispatch arguments with explicit x / y / z workgroup counts.

Source

pub fn for_1d(total: u32, workgroup_size: u32) -> Self

Create 1-D dispatch arguments for total elements with a workgroup size of workgroup_size.

The Y and Z dimensions are set to 1. If workgroup_size is 0 the X count is also 0.

Source

pub fn as_bytes(&self) -> [u8; 12]

Serialise the struct into a 12-byte little-endian array suitable for writing to a GPU buffer.

Trait Implementations§

Source§

impl Clone for DispatchIndirectArgs

Source§

fn clone(&self) -> DispatchIndirectArgs

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for DispatchIndirectArgs

Source§

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

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

impl PartialEq for DispatchIndirectArgs

Source§

fn eq(&self, other: &DispatchIndirectArgs) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for DispatchIndirectArgs

Source§

impl Eq for DispatchIndirectArgs

Source§

impl StructuralPartialEq for DispatchIndirectArgs

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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> 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
Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

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