Struct Vertices

pub struct Vertices<'vertices, R: Renderable> { /* private fields */ }

A set of vertices using one or more crate::BufferData through [BufferAccessor]s.

A number of Vertices is used by an Object, its components and their meshes; one is used for each primitive within a mesh for its elements. The actual elements will be sets of triangles (as stripes or whatever) which use these vertices.

A Vertices object includes a lot of options for vertices, and different renderers (or different render stages) may require different subsets of these indices. As such, in OpenGL for example, a Vertices object may end up with more than one VAO. This data is part of the [VerticesClient] struct associated with the Vertices. In WebGPU there may more than one render pipeline for different shader pipelines for the same set of vertices.

When it comes to creating an instance of a mesh, that instance will have specific transformations and materials for each of its primitives; rendering the instance with a shader will require enabling the Vertices client for that shader, setting appropriate render options (uniforms in OpenGL)

FIXME - change to using VertexDesc instead of VeretxAttr? - this requires removing VertexAttr from here and using that in its BufferDataAccessor

Implementations

impl<'vertices, R: Renderable> Vertices<'vertices, R>

ip Vertices

pub fn new( indices: Option<&'vertices BufferIndexAccessor<'vertices, R>>, position: &'vertices BufferDataAccessor<'vertices, R>, ) -> Self

Create a new Vertices object with no additional attributes

pub fn add_attr( &mut self, accessor: &'vertices BufferDataAccessor<'vertices, R>, )

Add a [BufferAccessor] for a particular VertexAttr

On creation the Vertices will have views for indices and positions; this provides a means to add views for things such as normal, tex coords, etc

pub fn borrow_indices<'a>( &'a self, ) -> Option<&'a BufferIndexAccessor<'vertices, R>>

Borrow the indices [BufferAccessor]

pub fn borrow_attr<'a>( &'a self, attr: VertexAttr, ) -> Option<&'a BufferDataAccessor<'vertices, R>>

Borrow an attribute BufferDataAccessor if the Vertices has one

pub fn iter_attrs(&self) -> Iter<'_, &BufferDataAccessor<'vertices, R>>

Iterate through attributes

pub fn create_client(&self, renderer: &mut R)

Create the render buffer required by the BufferAccessor

pub fn borrow_client(&self) -> Ref<'_, R::Vertices>

Borrow the client

Trait Implementations

impl<'vertices, R: Debug + Renderable> Debug for Vertices<'vertices, R>

where R::Vertices: Debug,

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

Formats the value using the given formatter.

impl<'vertices, R> Display for Vertices<'vertices, R>

where R: Renderable,

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

Formats the value using the given formatter.