Struct VertexBufferLayout

pub struct VertexBufferLayout<'a> {
    pub array_stride: BufferAddress,
    pub step_mode: VertexStepMode,
    pub attributes: &'a [VertexAttribute],
}

Specifies an interpretation of the bytes of a vertex buffer as vertex attributes.

Use this in a RenderPipelineDescriptor to describe the format of the vertex buffers that are passed to RenderPass::set_vertex_buffer().

Corresponds to WebGPU GPUVertexBufferLayout.

Example

The following example defines a struct with three fields, and a VertexBufferLayout that contains VertexAttributes for each field, using the vertex_attr_array! macro to compute attribute offsets:

#[repr(C, packed)]
struct Vertex {
    foo: [f32; 2],
    bar: f32,
    baz: [u16; 4],
}

impl Vertex {
    /// Layout to use with a buffer whose contents are a `[Vertex]`.
    pub const LAYOUT: wgpu::VertexBufferLayout<'static> = wgpu::VertexBufferLayout {
        array_stride: size_of::<Self>() as wgpu::BufferAddress,
        step_mode: wgpu::VertexStepMode::Vertex,
        attributes: &wgpu::vertex_attr_array![
            0 => Float32x2,
            1 => Float32,
            2 => Uint16x4,
        ],
    };
}

Fields

array_stride: BufferAddress

The stride, in bytes, between elements of this buffer (between vertices).

This must be a multiple of VERTEX_STRIDE_ALIGNMENT.

step_mode: VertexStepMode

How often this vertex buffer is “stepped” forward.

attributes: &'a [VertexAttribute]

The list of attributes which comprise a single vertex.

Trait Implementations

impl<'a> Clone for VertexBufferLayout<'a>

fn clone(&self) -> VertexBufferLayout<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for VertexBufferLayout<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for VertexBufferLayout<'a>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for VertexBufferLayout<'a>

fn eq(&self, other: &VertexBufferLayout<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> Eq for VertexBufferLayout<'a>

impl<'a> StructuralPartialEq for VertexBufferLayout<'a>