Struct MaterialBuffer

pub struct MaterialBuffer<T> { /* private fields */ }

This is a chunk of memory that will get bound to all shaders at a particular register slot. StereoKit uses this to provide engine values to the shader, and you can also use this to drive graphical shader systems of your own!

For example, if your application has a custom lighting system, fog, wind, or some other system that multiple shaders might need to refer to, this is the perfect tool to use.

The type ‘T’ for this buffer must be a struct that uses the #[repr(C)] attribute for proper copying. It should also match the layout of your equivalent cbuffer in the shader file. Note that shaders often have specific byte alignment requirements! https://stereokit.net/Pages/StereoKit/MaterialBuffer.html

Implementations

impl<T> MaterialBuffer<T>

pub fn new(register_slot: i32) -> MaterialBuffer<T>

Create a new global MaterialBuffer bound to the register slot id. All shaders will have access to the data provided via this instance’s Set. https://stereokit.net/Pages/StereoKit/MaterialBuffer/MaterialBuffer.html

• register_slot - Valid values are 3-16. This is the register id that this data will be bound to. In HLSL, you’ll see the slot id for ‘3’ indicated like this : register(b3)

see also material_buffer_create

pub fn set(&self, in_data: *mut T)

This will upload your data to the GPU for shaders to use. https://stereokit.net/Pages/StereoKit/MaterialBuffer/Set.html

see also material_buffer_set_data

Trait Implementations

impl<T> AsRef<MaterialBuffer<T>> for MaterialBuffer<T>

fn as_ref(&self) -> &MaterialBuffer<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Drop for MaterialBuffer<T>

fn drop(&mut self)

Executes the destructor for this type.