Enum gfx::IndexBuffer

pub enum IndexBuffer<R: Resources> {
    Auto,
    Index16(Buffer<R, u16>),
    Index32(Buffer<R, u32>),
}

[−] Expand description

Type of index-buffer used in a Slice.

The Auto variant represents a hypothetical index-buffer from 0 to infinity. In other words, all vertices get processed in order. Do note that the Slice’s start and end restrictions still apply for this variant. To render every vertex in the VertexBuffer, you would set start to 0, and end to the VertexBuffer’s length.

The Index* variants represent an actual Buffer with a list of vertex-indices. The numeric suffix specifies the amount of bits to use per index. Each of these also contains a base-vertex. This is the index of the first vertex in the VertexBuffer. This value will be added to every index in the index-buffer, effectively moving the start of the VertexBuffer to this base-vertex.

Construction & Handling

A IndexBuffer can be constructed using the IntoIndexBuffer trait, from either a slice or a Buffer of integers, using a factory.

An IndexBuffer is exclusively used to create Slices.

Variants

Auto

[−] Expand description

Represents a hypothetical index-buffer from 0 to infinity. In other words, all vertices get processed in order.

Index16(Buffer<R, u16>)

[−] Expand description

An index-buffer with unsigned 16 bit indices.

Index32(Buffer<R, u32>)

[−] Expand description

An index-buffer with unsigned 32 bit indices.

Trait Implementations

impl<R: Clone + Resources> Clone for IndexBuffer<R>[+]

[+] Show hidden undocumented items

fn clone(&self) -> IndexBuffer<R>[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<R: Debug + Resources> Debug for IndexBuffer<R>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<R: Resources> Default for IndexBuffer<R>[+]

[+] Show hidden undocumented items

fn default() -> Self[−]

Returns the “default value” for a type.

impl<R: Eq + Resources> Eq for IndexBuffer<R>

impl<R: Hash + Resources> Hash for IndexBuffer<R>[+]

[+] Show hidden undocumented items

fn hash<__H: Hasher>(&self, state: &mut __H)[−]

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, [−]

Feeds a slice of this type into the given Hasher.

impl<R: Resources> IntoIndexBuffer<R> for IndexBuffer<R>[+]

[+] Show hidden undocumented items

fn into_index_buffer<F: Factory<R> + ?Sized>(self, _: &mut F) -> IndexBuffer<R>[−]

Turns self into an IndexBuffer.

impl<R: PartialEq + Resources> PartialEq<IndexBuffer<R>> for IndexBuffer<R>[+]

[+] Show hidden undocumented items

fn eq(&self, other: &IndexBuffer<R>) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &IndexBuffer<R>) -> bool[−]

This method tests for !=.

impl<R: Resources> StructuralEq for IndexBuffer<R>

impl<R: Resources> StructuralPartialEq for IndexBuffer<R>