Struct BufferDescriptor

pub struct BufferDescriptor<'a, R: Renderable> { /* private fields */ }

A descriptor of a subset of a BufferData, used for vertex attributes; hence for use in a vertex attribute pointer.

A BufferDescriptor allows portion of a BufferData to contain an array of structs with multiple fields for, e.g., Vertex, Normal and Color.

A BufferDescriptor is used within a crate::BufferDataAccessor to describe just an individual field element.

Implementations

impl<'a, R: Renderable> BufferDescriptor<'a, R>

pub fn data(&self) -> &BufferData<'a, R>

Get a reference to the underlying BufferData

pub fn byte_offset(&self) -> u32

Get the byte offset within the underlying BufferData for this descriptor

pub fn byte_length(&self) -> u32

Get the byte length within the underlying BufferData for this descriptor

pub fn stride(&self) -> u32

Get the byte stride between different indices for the instances for this descriptor

pub fn element(&self, n: usize) -> &VertexDesc

Get a reference to the n’th element

pub fn elements(&self) -> &[VertexDesc]

Get a reference to the elements

pub fn new( data: &'a BufferData<'a, R>, byte_offset: u32, byte_length: u32, stride: u32, elements: Vec<VertexDesc>, ) -> Self

Create a new view of a BufferData

pub fn add_vertex_desc(&mut self, vertex_desc: VertexDesc) -> u8

Add a VertexDesc to the fields that this BufferDescriptor describes.

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

Create the render buffer required by the BufferDescriptor

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

Borrow the client

Trait Implementations

impl<'a, R> AsRef<[u8]> for BufferDescriptor<'a, R>

where R: Renderable,

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a, R> Debug for BufferDescriptor<'a, R>

where R: Renderable,

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

Formats the value using the given formatter.

impl<'a, R: Renderable> Display for BufferDescriptor<'a, R>

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

Formats the value using the given formatter.

impl<'a, R: Renderable> DefaultIndentedDisplay for BufferDescriptor<'a, R>