Struct VertexAttribute

pub struct VertexAttribute {
    pub usage: VertexAttributeUsage,
    pub data_type: VertexAttributeDataType,
    pub size: u8,
    pub divisor: u8,
    pub offset: u8,
    pub shader_location: u8,
    pub normalized: bool,
}

Vertex attribute is a simple “bridge” between raw data and its interpretation. In other words it defines how to treat raw data in vertex shader.

Fields

usage: VertexAttributeUsage

Claimed usage of the attribute. It could be Position, Normal, etc.

data_type: VertexAttributeDataType

Data type of every component of the attribute. It could be F32, U32, U16, etc.

size: u8

Size of attribute expressed in components. For example, for Position it could be 3 - which means there are 3 components in attribute of data_type.

divisor: u8

Sets a “fetch rate” for vertex shader at which it will read vertex attribute: 0 - per vertex (default) 1 - per instance 2 - per 2 instances and so on.

offset: u8

Offset in bytes from beginning of the vertex.

shader_location: u8

Defines location of the attribute in a shader (layout(location = x) attrib;)

normalized: bool

Whether the attribute values should be normalized into 0.0..1.0 range or not. If this field is set to false, then the numbers will appear “as-is” when fetching them in a shader. On the other hand, if it is true, then any numeric value will be normalized by applying normalized = num / T::max() equation. This way all numbers will always stay in 0.0..1.0 range.

For example, normalization could be useful for RGB colors that expressed as three bytes (u8). In this case normalization will turn the color into 0.0..1.0 range.

Implementations

impl VertexAttribute

pub const USAGE: &'static str = "usage"

pub const DATA_TYPE: &'static str = "data_type"

pub const SIZE: &'static str = "size"

pub const DIVISOR: &'static str = "divisor"

pub const OFFSET: &'static str = "offset"

pub const SHADER_LOCATION: &'static str = "shader_location"

pub const NORMALIZED: &'static str = "normalized"

Trait Implementations

impl Clone for VertexAttribute

fn clone(&self) -> VertexAttribute

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VertexAttribute

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

Formats the value using the given formatter.

impl Default for VertexAttribute

fn default() -> VertexAttribute

Returns the “default value” for a type.

impl Hash for VertexAttribute

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Reflect for VertexAttribute

where Self: 'static, VertexAttributeUsage: Reflect, VertexAttributeDataType: Reflect, u8: Reflect, bool: Reflect,

fn source_path() -> &'static str

fn type_name(&self) -> &'static str

fn doc(&self) -> &'static str

fn assembly_name(&self) -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

fn into_any(self: Box<Self>) -> Box<dyn Any>

fn set( &mut self, value: Box<dyn Reflect>, ) -> Result<Box<dyn Reflect>, Box<dyn Reflect>>

fn as_any(&self, func: &mut dyn FnMut(&dyn Any))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut dyn Any))

fn as_reflect(&self, func: &mut dyn FnMut(&dyn Reflect))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut dyn Reflect))

fn fields(&self, func: &mut dyn FnMut(&[&dyn Reflect]))

fn fields_mut(&mut self, func: &mut dyn FnMut(&mut [&mut dyn Reflect]))

fn field(&self, name: &str, func: &mut dyn FnMut(Option<&dyn Reflect>))

fn field_mut( &mut self, name: &str, func: &mut dyn FnMut(Option<&mut dyn Reflect>), )

fn set_field( &mut self, field: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, Box<dyn Reflect>>), )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>), )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>), )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>), )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>), )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>), )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>), )

impl Visit for VertexAttribute

where VertexAttributeUsage: Visit, VertexAttributeDataType: Visit, u8: Visit, bool: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult

Read or write this value, depending on whether Visitor::is_reading() is true or false.

impl Copy for VertexAttribute