Enum wgpu::VertexStepMode

source ·
#[repr(C)]
pub enum VertexStepMode { Vertex = 0, Instance = 1, }
Expand description

Whether a vertex buffer is indexed by vertex or by instance.

Consider a call to RenderPass::draw like this:

render_pass.draw(vertices, instances)

where vertices is a Range<u32> of vertex indices, and instances is a Range<u32> of instance indices.

For this call, wgpu invokes the vertex shader entry point once for every possible (v, i) pair, where v is drawn from vertices and i is drawn from instances. These invocations may happen in any order, and will usually run in parallel.

Each vertex buffer has a step mode, established by the step_mode field of its VertexBufferLayout, given when the pipeline was created. Buffers whose step mode is Vertex use v as the index into their contents, whereas buffers whose step mode is Instance use i. The indicated buffer element then contributes zero or more attribute values for the (v, i) vertex shader invocation to use, based on the VertexBufferLayout’s attributes list.

You can visualize the results from all these vertex shader invocations as a matrix with a row for each i from instances, and with a column for each v from vertices. In one sense, v and i are symmetrical: both are used to index vertex buffers and provide attribute values. But the key difference between v and i is that line and triangle primitives are built from the values of each row, along which i is constant and v varies, not the columns.

An indexed draw call works similarly:

render_pass.draw_indexed(indices, base_vertex, instances)

The only difference is that v values are drawn from the contents of the index buffer—specifically, the subrange of the index buffer given by indices—instead of simply being sequential integers, as they are in a draw call.

A non-instanced call, where instances is 0..1, is simply a matrix with only one row.

Corresponds to WebGPU GPUVertexStepMode.

Variants§

§

Vertex = 0

Vertex data is advanced every vertex.

§

Instance = 1

Vertex data is advanced every instance.

Trait Implementations§

source§

impl Clone for VertexStepMode

source§

fn clone(&self) -> VertexStepMode

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 Debug for VertexStepMode

source§

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

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

impl Default for VertexStepMode

source§

fn default() -> VertexStepMode

Returns the “default value” for a type. Read more
source§

impl<'de> Deserialize<'de> for VertexStepMode

source§

fn deserialize<__D>( __deserializer: __D ) -> Result<VertexStepMode, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Hash for VertexStepMode

source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for VertexStepMode

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for VertexStepMode

source§

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Copy for VertexStepMode

source§

impl Eq for VertexStepMode

source§

impl StructuralPartialEq for VertexStepMode

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

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

§

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

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

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

§

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

Compare self to key and return true if they are equal.
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> 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.
§

impl<T> Upcast<T> for T

§

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

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

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

source§

impl<T> WasmNotSendSync for T

source§

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