Struct DecalsBuffer

pub struct DecalsBuffer(/* private fields */);

A render-world resource that holds the buffer of ClusteredDecals ready to upload to the GPU.

Methods from Deref<Target = RawBufferVec<RenderClusteredDecal>>

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

Returns a handle to the buffer, if the data has been uploaded.

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

Returns the binding for the buffer if the data has been uploaded.

pub fn capacity(&self) -> usize

Returns the amount of space that the GPU will use before reallocating.

pub fn len(&self) -> usize

Returns the number of items that have been pushed to this buffer.

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty.

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

Adds a new value and returns its index.

pub fn append(&mut self, other: &mut RawBufferVec<T>)

pub fn get(&self, index: u32) -> Option<&T>

Returns the value at the given index.

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

Sets the value at the given index.

The index must be less than RawBufferVec::len.

pub fn reserve_internal(&mut self, count: usize)

Preallocates space for count elements in the internal CPU-side buffer.

Unlike RawBufferVec::reserve, this doesn’t have any effect on the GPU buffer.

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

Changes the debugging label of the buffer.

The next time the buffer is updated (via reserve), Bevy will inform the driver of the new label.

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

Returns the label

pub fn reserve(&mut self, capacity: usize, device: &RenderDevice)

Creates a Buffer on the RenderDevice with size at least size_of::<T>() * capacity, unless a such a buffer already exists.

If a Buffer exists, but is too small, references to it will be discarded, and a new Buffer will be created. Any previously created Buffers that are no longer referenced will be deleted by the RenderDevice once it is done using them (typically 1-2 frames).

In addition to any BufferUsages provided when the RawBufferVec was created, the buffer on the RenderDevice is marked as BufferUsages::COPY_DST.

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.

Before queuing the write, a reserve operation is executed.

pub fn truncate(&mut self, len: usize)

Reduces the length of the buffer.

pub fn clear(&mut self)

Removes all elements from the buffer.

pub fn pop(&mut self) -> Option<T>

Removes and returns the last element in the buffer.

pub fn values(&self) -> &Vec<T>

pub fn values_mut(&mut self) -> &mut Vec<T>

pub fn grow_set(&mut self, index: u32, value: T)

Trait Implementations

impl Default for DecalsBuffer

fn default() -> Self

Returns the “default value” for a type.

impl Deref for DecalsBuffer

type Target = RawBufferVec<RenderClusteredDecal>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for DecalsBuffer

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Resource for DecalsBuffer

where Self: Send + Sync + 'static,