Struct BufferData

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

A data buffer for use with vertex data. It may be indices or vertex coordinates etc.

A data buffer may contain a lot of data per vertex, such as position, normal, tangent, color etc. a GPU BufferView on the data is then a subset of this data - perhaps picking out just the position, for example, for a set of vertices

The data buffer may, indeed, contain data for more than one object

• and the objects may have different data per vertex.

A data buffer may then be used by many GPU BufferViews. Each BufferView may be used by many primitives for a single model; alternatively, primitives may have their own individual BufferViews.

To allow a Renderable to use the BufferData for multiple views, it supports a ‘client’ field that can be initialized using the ‘init_buffer_data_client’ method of the Renderable, and then borrowed as required during render programming.

Implementations

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

pub fn byte_length(&self) -> u32

Get the byte length of the BufferData

pub fn byte_offset(&self) -> u32

Get the byte offset within the underlying data of the BufferData

pub fn new<B: ByteBuffer + ?Sized>( data: &'a B, byte_offset: u32, byte_length: u32, ) -> Self

Create a new BufferData given a buffer, offset and length; if the length is zero then the whole of the data buffer post offset is used

If offset and length are both zero, then all the data is used

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

Replace the client data with one of this data

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

Borrow the client immutably

Trait Implementations

impl<'a, R> AsRef<[u8]> for BufferData<'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: Renderable> Debug for BufferData<'a, R>

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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