Struct tetra::graphics::mesh::VertexBuffer

pub struct VertexBuffer { /* fields omitted */ }

Vertex data, stored in GPU memory.

This data can be drawn to the screen via a Mesh.

Performance

Creating a VertexBuffer is a relatively expensive operation. If you can, store them in your State struct rather than recreating them each frame.

Cloning a VertexBuffer is a very cheap operation, as the underlying data is shared between the original instance and the clone via reference-counting. This does mean, however, that updating a VertexBuffer will also update any other clones of that VertexBuffer.

Implementations

impl VertexBuffer

pub fn new(ctx: &mut Context, vertices: &[Vertex]) -> Result<VertexBuffer>

Creates a new vertex buffer.

The buffer will be created with the BufferUsage::Dynamic usage hint - this can be overridden via the with_usage constructor.

Errors

• TetraError::PlatformError will be returned if the underlying graphics API encounters an error.

pub fn with_usage(
    ctx: &mut Context,
    vertices: &[Vertex],
    usage: BufferUsage
) -> Result<VertexBuffer>

Creates a new vertex buffer, with the specified usage hint.

The GPU may optionally use the usage hint to optimize data storage and access.

Errors

• TetraError::PlatformError will be returned if the underlying graphics API encounters an error.

pub fn set_data(&self, ctx: &mut Context, vertices: &[Vertex], offset: usize)

Uploads new vertex data to the GPU.

Panics

Panics if the offset is out of bounds.

pub fn into_mesh(self) -> Mesh

Creates a mesh using this buffer.

This is a shortcut for calling Mesh::new.

Trait Implementations

impl Clone for VertexBuffer

fn clone(&self) -> VertexBuffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VertexBuffer

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

Formats the value using the given formatter.

impl From<VertexBuffer> for Mesh

fn from(buffer: VertexBuffer) -> Self

Performs the conversion.

impl PartialEq<VertexBuffer> for VertexBuffer

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

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

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

This method tests for !=.

impl StructuralPartialEq for VertexBuffer