Struct Buffer

pub struct Buffer {
    pub buffer: Buffer,
    pub size_bytes: usize,
    /* private fields */
}

A wrapper for wgpu::Buffer. Allows writing of aligned or packed data into it

Fields

buffer: Buffer

size_bytes: usize

Implementations

impl Buffer

pub fn new_empty( device: &Device, usage: BufferUsages, label: Label<'_>, size_bytes: usize, ) -> Self

pub fn is_empty(&self) -> bool

pub fn write_buffer(&mut self, queue: &Queue, offset_bytes: usize, data: &[u8])

pub fn push_cpu_chunk_aligned<T: ShaderType + WriteInto>( &mut self, chunk: &T, ) -> u32

Writes data to the cpu_byte_buffer and adds padding in order to align to 256 bytes. This is useful for adding local data of each mesh into a gpu buffer and having the bind groups with an offset into the buffer. # Panics Will panic if the cpu_byte_buffer is too small to write the current chunk

pub fn push_cpu_chunk_packed<T: ShaderType + WriteInto>(&mut self, chunk: &T)

Writes data to the cpu_byte_buffer but adds no padding. This is useful when adding lots of structures to the buffer and they need to be exposed as a var structs : array<MyStruct,20> to the shader. Useful for adding a vector of lights for example # Panics Will panic if the cpu_byte_buffer is too small to write the current chunk

pub fn upload_from_cpu_chunks(&mut self, queue: &Queue)

Uploads from the cpu_byte_buffer to gpu

pub fn reset_chunks_offset(&mut self)

Sets the offset back to 0 so we can start a new round of upload from the beggining of the buffer

pub fn reset_chunks_offset_if_necessary(&mut self)

Sets the offset back to 0 only if we are approaching the end of the buffer. Usually we don’t want to always reset to 0 since that subpart of the buffer may be used for rendering when we want to write to it, rather we want to use as most of the buffer as possible without

pub fn offset(&self) -> usize