Struct solstice::buffer::Buffer

pub struct Buffer { /* fields omitted */ }

A memory map between a CPU and GPU buffer.

This implementation, while safe, only operates on bytes to better mirror GPU buffers. It is best used through a Mesh to provide information on how the data is laid out internally and allow the use of more types and structures.

This buffer is not resizable. All operations are sized in bytes.

Implementations

impl Buffer

pub fn new(
    ctx: &mut Context,
    size: usize,
    buffer_type: BufferType,
    usage: Usage
) -> Result<Self, GraphicsError>

Constructs an empty buffer of size bytes.

pub fn with_data(
    ctx: &mut Context,
    data: &[u8],
    buffer_type: BufferType,
    usage: Usage
) -> Result<Self, GraphicsError>

Constructs a buffer of the size and contents of the passed in the Vec.

pub fn handle(&self) -> BufferKey

Returns an identifier that can be used with the graphics context to retrieve the raw GPU buffer handle.

pub fn size(&self) -> usize

The buffer’s capacity/size. Since it’s not resizable these concepts are the same.

pub fn buffer_type(&self) -> BufferType

The buffer’s type.

pub fn usage(&self) -> Usage

The buffer’s usage.

Trait Implementations

impl Clone for Buffer

fn clone(&self) -> Buffer

Returns a copy 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 PartialEq<Buffer> for Buffer

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for Buffer

impl StructuralEq for Buffer

impl StructuralPartialEq for Buffer