Struct three_d::core::buffer::InstanceBuffer

pub struct InstanceBuffer { /* private fields */ }

A buffer containing per instance data. To send this data to a shader, use the Program::use_instance_attribute method.

Implementations

impl InstanceBuffer

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

Creates a new empty instance buffer.

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

Creates a new instance buffer and fills it with the given data. The data should be in the same format as specified in the shader. As an example, if specified as vec3 in the shader it needs to be specified as an array of Vector3<T> where T is a primitive type that implements BufferDataType, for example can be f16 or f32.

pub fn fill<T: BufferDataType>(&mut self, data: &[T]) -> ThreeDResult<()>

Fills the instance buffer with the given data. The data should be in the same format as specified in the shader. As an example, if specified as vec3 in the shader it needs to be specified as an array of Vector3<T> where T is a primitive type that implements BufferDataType, for example can be f16 or f32.

pub fn count(&self) -> u32

The number of values in the buffer.

pub fn instance_count(&self) -> u32

The number of instance attributes in the buffer.

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

👎 Deprecated:

use new_with_data() and specify the data in the same format as in the shader (for example an array of Vec3 instead of f32)

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

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

👎 Deprecated:

use new_with_data() and specify the data in the same format as in the shader (for example an array of Vec3 instead of f32)

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

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

👎 Deprecated:

use fill() and specify the data in the same format as in the shader (for example an array of Vec3 instead of f32)

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

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

👎 Deprecated:

use fill() and specify the data in the same format as in the shader (for example an array of Vec3 instead of f32)

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