Struct mod3d_base::Vertices

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

A set of vertices using one or more crate::BufferData through BufferAccessors.

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

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)

Implementations

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

ip Vertices

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

Create a new Vertices object with no additional attributes

pub fn add_attr( &mut self, attr: VertexAttr, accessor: &'vertices BufferAccessor<'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) -> &'a BufferAccessor<'vertices, R>

Borrow the indices BufferAccessor

pub fn borrow_position<'a>(&'a self) -> &'a BufferAccessor<'vertices, R>

Borrow the position BufferAccessor

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

Borrow an attribute BufferAccessor if the Vertices has one

pub fn iter_attrs( &self, ) -> Iter<'_, (VertexAttr, &BufferAccessor<'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 + ?Sized> 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.