Struct three_d::core::buffer::InstanceBuffer

pub struct InstanceBuffer { /* private fields */ }

A buffer containing per instance data. Can send between 1 and 4 values of InstanceBufferDataType to a shader program for each instance. To send this data to a shader, use the Program::use_attribute_instanced, Program::use_attribute_vec2_instanced, etc. functionality.

Implementations

impl InstanceBuffer

pub fn new(context: &Context) -> ThreeDResult<Self>

Creates a new empty instance buffer.

pub fn new_with_static<T: InstanceBufferDataType>(
    context: &Context,
    data: &[T]
) -> ThreeDResult<Self>

Creates a new instance buffer and fills it with the given data. The given data slice must contain between 1 and 4 contiguous values for each instance. Use this method instead of new_with_dynamic when you do not expect the data to change often.

pub fn fill_with_static<T: InstanceBufferDataType>(&mut self, data: &[T])

Fills the instance buffer with the given data. The given data slice must contain between 1 and 4 contiguous values for each instance. Use this method instead of fill_with_dynamic when you do not expect the data to change often.

pub fn new_with_dynamic<T: InstanceBufferDataType>(
    context: &Context,
    data: &[T]
) -> ThreeDResult<Self>

Creates a new instance buffer and fills it with the given data. The given data slice must contain between 1 and 4 contiguous values for each instance. Use this method instead of new_with_static when you expect the data to change often.

pub fn fill_with_dynamic<T: InstanceBufferDataType>(&mut self, data: &[T])

Fills the instance buffer with the given data. The given data slice must contain between 1 and 4 contiguous values for each instance. Use this method instead of fill_with_static when you expect the data to change often.

pub fn count(&self) -> usize

The number of elements in the buffer.

Trait Implementations

impl Drop for InstanceBuffer

fn drop(&mut self)

Executes the destructor for this type.