Struct bevy_render::render_resource::DynamicUniformBuffer

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

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

Dynamic uniform buffers are available to shaders on a read-only basis. Dynamic uniform buffers are commonly used to make available to shaders runtime-sized arrays of parameters that are otherwise constant during shader execution, and are best suited to 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
• UniformBuffer
• DynamicUniformBuffer
• GpuArrayBuffer
• RawBufferVec
• BufferVec
• Texture

Implementations

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

pub fn new_with_alignment(alignment: u64) -> Self

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

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

pub fn is_empty(&self) -> bool

pub fn push(&mut self, value: &T) -> u32

Push data into the DynamicUniformBuffer’s internal vector (residing on system RAM).

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 get_writer<'a>( &'a mut self, max_count: usize, device: &RenderDevice, queue: &'a RenderQueue ) -> Option<DynamicUniformBufferWriter<'a, T>>

Creates a writer that can be used to directly write elements into the target buffer.

This method uses less memory and performs fewer memory copies using over push and write_buffer.

max_count must be greater than or equal to the number of elements that are to be written to the buffer, or the writer will panic while writing. Dropping the writer will schedule the buffer write into the provided RenderQueue.

If there is no GPU-side buffer allocated to hold the data currently stored, or if a GPU-side buffer previously allocated does not have enough capacity to hold max_count elements, a new GPU-side buffer is created.

Returns None if there is no allocated GPU-side buffer, and max_count is 0.

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 there is no GPU-side buffer allocated to hold the data currently stored, or if a GPU-side buffer previously allocated does not have enough capacity, a new GPU-side buffer is created.

pub fn clear(&mut self)

Trait Implementations

impl<T: ShaderType> Default for DynamicUniformBuffer<T>

fn default() -> Self

Returns the “default value” for a type.

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

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