Struct tetra::graphics::mesh::VertexBuffer

pub struct VertexBuffer { /* private fields */ }

Vertex data, stored in GPU memory.

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

Performance

When you create or modify a vertex buffer, you are effectively ‘uploading’ data to the GPU, which can be relatively slow. You should try to minimize how often you do this - for example, if a piece of geometry does not change from frame to frame, reuse the buffer instead of recreating it.

You can clone a vertex buffer cheaply, as it is a reference-counted handle to a GPU resource. However, this does mean that modifying a buffer (e.g. calling set_data) will also affect any clones that exist of it.

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.

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

Converts to this type from the input type.

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: &Rhs) -> bool

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

impl StructuralPartialEq for VertexBuffer