Struct DrawIndexedArgs 

pub struct DrawIndexedArgs {
    pub index_count: u32,
    pub instance_count: u32,
    pub first_index: u32,
    pub base_vertex: i32,
    pub first_instance: u32,
}

The five arguments of an indexed draw, as one value.

drawIndexed and drawIndexedOffset take these as five positional arguments today, with no named parameter in between to keep them in order and no way to leave a trailing one at its default. Grouping them makes the call self-documenting and lets a caller vary one of the five without restating the other four.

Fields

index_count: u32

The number of indices to read from the bound index buffer.

instance_count: u32

How many instances of the indexed geometry to draw. 1 draws a single instance.

first_index: u32

The index of the first index to read, for drawing a sub-range of the index buffer.

base_vertex: i32

The value added to every index before it is used to fetch a vertex. Lets several meshes share one vertex buffer.

first_instance: u32

The first instance index, for reading per-instance attributes from an offset.

Implementations

impl DrawIndexedArgs

Named constructors for the draw-argument structs.

pub fn whole_buffer(index_count: u32, instance_count: u32) -> Self

An indexed draw of the whole index buffer.

Arguments

• u32 - The number of indices to read.
• u32 - The number of instances to draw.

Returns

• Self - The assembled draw arguments, starting at index 0 with no base-vertex offset.

impl DrawIndexedArgs

pub fn get_index_count(&self) -> u32

pub fn set_index_count(&mut self, val: u32) -> &mut Self

pub fn get_instance_count(&self) -> u32

pub fn set_instance_count(&mut self, val: u32) -> &mut Self

pub fn get_first_index(&self) -> u32

pub fn set_first_index(&mut self, val: u32) -> &mut Self

pub fn get_base_vertex(&self) -> i32

pub fn set_base_vertex(&mut self, val: i32) -> &mut Self

pub fn get_first_instance(&self) -> u32

pub fn set_first_instance(&mut self, val: u32) -> &mut Self

impl DrawIndexedArgs

pub fn new() -> Self

Trait Implementations

impl Clone for DrawIndexedArgs

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DrawIndexedArgs

impl Debug for DrawIndexedArgs

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

Formats the value using the given formatter.