#[repr(C)]
pub struct IndirectParameters { pub vertex_or_index_count: u32, pub instance_count: u32, pub first_vertex: u32, pub base_vertex_or_first_instance: u32, pub first_instance: u32, }
Expand description

The wgpu indirect parameters structure.

This is actually a union of the two following structures:

#[repr(C)]
struct ArrayIndirectParameters {
    vertex_count: u32,
    instance_count: u32,
    first_vertex: u32,
    first_instance: u32,
}

#[repr(C)]
struct ElementIndirectParameters {
    index_count: u32,
    instance_count: u32,
    first_vertex: u32,
    base_vertex: u32,
    first_instance: u32,
}

We actually generally treat these two variants identically in code. To do that, we make the following two observations:

  1. instance_count is in the same place in both structures. So we can access it regardless of the structure we’re looking at.

  2. The second structure is one word larger than the first. Thus we need to pad out the first structure by one word in order to place both structures in an array. If we pad out ArrayIndirectParameters by copying the first_instance field into the padding, then the resulting union structure will always have a read-only copy of first_instance in the final word. We take advantage of this in the shader to reduce branching.

Fields§

§vertex_or_index_count: u32

For ArrayIndirectParameters, vertex_count; for ElementIndirectParameters, index_count.

§instance_count: u32

The number of instances we’re going to draw.

This field is in the same place in both structures.

§first_vertex: u32

The index of the first vertex we’re to draw.

§base_vertex_or_first_instance: u32

For ArrayIndirectParameters, first_instance; for ElementIndirectParameters, base_vertex.

§first_instance: u32

For ArrayIndirectParameters, this is padding; for ElementIndirectParameters, this is first_instance.

Conventionally, we copy first_instance into this field when padding out ArrayIndirectParameters. That way, shader code can read this value at the same place, regardless of the specific structure this represents.

Trait Implementations§

source§

impl Clone for IndirectParameters

source§

fn clone(&self) -> IndirectParameters

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl CreateFrom for IndirectParameters
where Self: ShaderType<ExtraMetadata = StructMetadata<5usize>>, for<'__, '__, '__, '__, '__> u32: CreateFrom,

source§

fn create_from<B: BufferRef>(reader: &mut Reader<B>) -> Self

source§

impl ReadFrom for IndirectParameters
where Self: ShaderType<ExtraMetadata = StructMetadata<5usize>>, for<'__, '__, '__, '__, '__> u32: ReadFrom,

source§

fn read_from<B: BufferRef>(&mut self, reader: &mut Reader<B>)

source§

impl ShaderSize for IndirectParameters
where u32: ShaderSize,

source§

const SHADER_SIZE: NonZero<u64> = _

Represents WGSL Size (equivalent to ShaderType::min_size)
source§

impl ShaderType for IndirectParameters

source§

fn size(&self) -> NonZeroU64

Returns the size of Self at runtime Read more
source§

fn min_size() -> NonZero<u64>

Represents the minimum size of Self (equivalent to GPUBufferBindingLayout.minBindingSize) Read more
source§

fn assert_uniform_compat()

source§

impl WriteInto for IndirectParameters
where Self: ShaderType<ExtraMetadata = StructMetadata<5usize>>, for<'__, '__, '__, '__, '__> u32: WriteInto,

source§

fn write_into<B: BufferMut>(&self, writer: &mut Writer<B>)

source§

impl Zeroable for IndirectParameters

source§

fn zeroed() -> Self

source§

impl Copy for IndirectParameters

source§

impl Pod for IndirectParameters

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, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
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> CheckedBitPattern for T
where T: AnyBitPattern,

§

type Bits = T

Self must have the same layout as the specified Bits except for the possible invalid bit patterns being checked during is_valid_bit_pattern.
source§

fn is_valid_bit_pattern(_bits: &T) -> bool

If this function returns true, then it must be valid to reinterpret bits as &Self.
source§

impl<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

impl<T> Downcast for T
where T: Any,

source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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,

§

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

§

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> TypeData for T
where T: 'static + Send + Sync + Clone,

source§

impl<T> Upcast<T> for T

source§

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

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> AnyBitPattern for T
where T: Pod,

source§

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

source§

impl<T> GpuArrayBufferable for T

source§

impl<T> NoUninit for T
where T: Pod,

source§

impl<T> Settings for T
where T: 'static + Send + Sync,

source§

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

source§

impl<T> WasmNotSendSync for T

source§

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