Struct Buffer 

pub struct Buffer {
    pub label: String,
    pub buffer: Buffer,
}

Create and manage GPU buffers.

Examples

Write once, render many:

use wde_wgpu::{buffer::{Buffer, BufferUsage}, instance::RenderInstanceData};

let vertices: &[f32] = &[0.0, 0.5, 0.0, -0.5, -0.5, 0.0, 0.5, -0.5, 0.0];
let mut vertex_buffer = Buffer::new(
    instance,
    "triangle-vertices",
    vertices.len() * std::mem::size_of::<f32>(),
    BufferUsage::VERTEX | BufferUsage::COPY_DST,
    None,
);
vertex_buffer.write(instance, bytemuck::cast_slice(vertices), 0);

Read back GPU results:

use wde_wgpu::{buffer::{Buffer, BufferUsage}, instance::RenderInstanceData};

let readback = Buffer::new(
    instance,
    "readback",
    1024,
    BufferUsage::MAP_READ | BufferUsage::COPY_DST,
    None,
);
readback.map_read(instance, |view| {
    let floats: &[f32] = bytemuck::cast_slice(&view);
    println!("first value = {}", floats.get(0).unwrap_or(&0.0));
});

Copy between GPU resources:

use wde_wgpu::{buffer::{Buffer, BufferUsage}, instance::RenderInstanceData};

let src = Buffer::new(instance, "src", 256, BufferUsage::COPY_SRC, Some(&[1u8; 256]));
let dst = Buffer::new(instance, "dst", 256, BufferUsage::COPY_DST, None);
dst.copy_from_buffer(instance, &src);

Fields

label: String

buffer: Buffer

Implementations

impl Buffer

pub fn new( instance: &RenderInstanceData<'_>, label: &str, size: usize, usage: BufferUsage, content: Option<&[u8]>, ) -> Self

Create a new buffer.

Arguments

• instance - The render instance.
• label - The label of the buffer.
• size - The size of the buffer.
• usage - The usage of the buffer (vertex, index, uniform, storage).
• content - The content of the buffer.

pub fn copy_from_buffer( &self, instance: &RenderInstanceData<'_>, buffer: &Buffer, )

Copy data to the buffer from another buffer. Note that the buffer must have the COPY_DST usage.

Arguments

• instance - The render instance.
• buffer - The buffer to copy from.

pub fn copy_from_buffer_offset( &self, instance: &RenderInstanceData<'_>, buffer: &Buffer, source_offset: u64, destination_offset: u64, size: u64, )

Copy data to the buffer from another buffer offset by a given offset. Note that the buffer must have the COPY_DST usage.

Arguments

• instance - The render instance.
• buffer - The buffer to copy from.
• source_offset - The offset in the source buffer to start copying from.
• destination_offset - The offset in the destination buffer to start copying to.
• size - The size of the data to copy.

pub fn copy_from_texture( &mut self, instance: &RenderInstanceData<'_>, texture: &Texture, )

Copy data to the buffer from a texture. Note that the buffer must have the COPY_DST usage.

Arguments

• instance - The render instance.
• texture - The texture to copy from.

pub fn write( &self, instance: &RenderInstanceData<'_>, content: &[u8], offset: usize, )

Write data to the buffer. Note that the buffer must have the COPY_DST usage.

Arguments

• instance - The render instance.
• content - The content to write to the buffer.
• offset - The offset to write the content to.

pub fn map_read( &self, instance: &RenderInstanceData<'_>, callback: impl FnOnce(BufferView), )

Map the buffer. The access to the buffer is read-only. This will wait for the buffer to be mapped. Note that the buffer must have the MAP_READ usage.

Arguments

• instance - The render instance.
• callback - A closure that takes a reference to the buffer. The callback takes reference to the buffer.

pub fn map_write( &self, instance: &RenderInstanceData<'_>, callback: impl FnOnce(BufferViewMut), )

Map the buffer as mutable. This allows to write to the buffer. This will wait for the buffer to be mapped. Note that the buffer must have the MAP_WRITE usage.

Arguments

• instance - The render instance.
• callback - A closure that takes a mutable reference to the buffer. The callback takes a mutable reference to the buffer.

Trait Implementations

impl Debug for Buffer

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

Formats the value using the given formatter.