Struct bevy_render::render_resource::UniformBuffer

pub struct UniformBuffer<T: ShaderType> { /* private fields */ }

Stores data to be transferred to the GPU and made accessible to shaders as a uniform buffer.

Uniform buffers are available to shaders on a read-only basis. Uniform buffers are commonly used to make available to shaders parameters that are constant during shader execution, and are best used for data that is relatively small in size as they are only guaranteed to support up to 16kB per binding.

The contained data is stored in system RAM. write_buffer queues copying of the data from system RAM to VRAM. Data in uniform buffers must follow std140 alignment/padding requirements, which is automatically enforced by this structure. Per the WGPU spec, uniform buffers cannot store runtime-sized array (vectors), or structures with fields that are vectors.

Other options for storing GPU-accessible data are:

• StorageBuffer
• DynamicStorageBuffer
• DynamicUniformBuffer
• GpuArrayBuffer
• BufferVec
• Texture

Implementations

impl<T: ShaderType + WriteInto> UniformBuffer<T>

pub fn buffer(&self) -> Option<&Buffer>

pub fn binding(&self) -> Option<BindingResource<'_>>

pub fn set(&mut self, value: T)

Set the data the buffer stores.

pub fn get(&self) -> &T

pub fn get_mut(&mut self) -> &mut T

pub fn set_label(&mut self, label: Option<&str>)

pub fn get_label(&self) -> Option<&str>

pub fn add_usages(&mut self, usage: BufferUsages)

Add more BufferUsages to the buffer.

This method only allows addition of flags to the default usage flags.

The default values for buffer usage are BufferUsages::COPY_DST and BufferUsages::UNIFORM.

pub fn write_buffer(&mut self, device: &RenderDevice, queue: &RenderQueue)

Queues writing of data from system RAM to VRAM using the RenderDevice and the provided RenderQueue, if a GPU-side backing buffer already exists.

If a GPU-side buffer does not already exist for this data, such a buffer is initialized with currently available data.

Trait Implementations

impl<T: ShaderType + Default> Default for UniformBuffer<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ShaderType> From<T> for UniformBuffer<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<'a, T: ShaderType + WriteInto> IntoBinding<'a> for &'a UniformBuffer<T>

fn into_binding(self) -> BindingResource<'a>