Struct Buffer

pub struct Buffer { /* private fields */ }

Represents a GPU buffer.

Implementations

impl Buffer

pub fn usage(&self) -> BufferUsage

pub fn size(&self) -> u64

pub fn resize(&mut self, size: u64) -> Result<(), BufferError>

Resizes the buffer to the specified size.

Due to the nature of GPU buffers, this will create a new buffer and copy the existing data into it IF: \

• The old buffer has usage [BufferUsages::COPY_SRC] and [BufferUsages::MAP_READ].

Otherwise, it will simply resize the buffer without copying the data.

pub fn write(&self, src: &Buffer)

Writes the contents of the source buffer to this buffer.

pub fn write_cmd(&self, src: &Buffer, encoder: &mut CommandBuffer)

Writes the contents of the source buffer to this buffer using a command buffer.

This function is useful for when you want to write to the buffer in a command buffer context, such as during a render pass.

CommandBuffer::write_buffer is a more convenient way to write a buffer in a command buffer context.

pub fn write_raw<T: Pod + Zeroable>(&self, data: &[T])

Writes raw data to the buffer.

By default, this will create an intermediate buffer to copy the data into, and then write that buffer to the destination buffer. This function also will automatically pad the data to the required alignment if necessary.

Will panic if the buffer is not writable or if the data is larger than the buffer size.

pub fn write_raw_cmd<T: Pod + Zeroable>( &self, data: &[T], encoder: &mut CommandBuffer, )

Writes raw data to the buffer using a command buffer, useful for writing data during a render pass.

This function is useful for when you want to write to the buffer in a command buffer context, such as during a render pass. This function also will automatically pad the data to the required alignment if necessary.

CommandBuffer::write_buffer_raw is a more convenient way to write raw data to a buffer in a command buffer context.

Will panic if the buffer is not writable or if the data is larger than the buffer size.

pub fn read<T: Pod + Zeroable>(&self) -> Result<Vec<T>, BufferError>

Reads the buffer data into a vector of type T.

Unless if the buffer was created with [BufferUsages::COPY_SRC] or [BufferUsages::MAP_READ], this will create an intermediate buffer to copy the data into, and then read from that buffer.

pub fn map(&mut self, mode: BufferMapMode) -> Result<&mut Vec<u8>, BufferError>

pub fn unmap(&mut self)

Trait Implementations

impl Clone for Buffer

fn clone(&self) -> Buffer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Buffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Buffer

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Buffer

fn eq(&self, other: &Buffer) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Buffer

impl StructuralPartialEq for Buffer