Struct Vertex 

pub struct Vertex { /* private fields */ }

Universal vertex structure containing all possible vertex attributes.

Not all fields are used by all vertex formats - the format and material type determine which fields contain valid data. Fields are stored with various compression techniques in the binary format.

Field Usage by Format

• Static: position, UVs, normal, tangent, bitangent
• Weighted: Static fields + bone_indices (2) + weights (2)
• Cinematic: Static fields + bone_indices (4) + weights (4)
• Collision: position only
• Grass: position, UVs, normal, + grass-specific data
• ClothSim: Similar to Weighted with cloth data

Compression Notes

When reading from file:

• Position is often stored as Vector4 of f16 (half-precision)
• UVs stored as f16
• Normals/tangents/bitangents stored as u8 normalized vectors
• Bone weights stored as u8 percentages

Implementations

impl Vertex

pub fn position(&self) -> &Vector4<f32>

3D position of the vertex (x, y, z, w). Often stored as f16 in file, expanded to f32 in memory.

pub fn texture_coordinate(&self) -> &Vector2<f32>

Primary texture UV coordinates (u, v). Often stored as f16 in file, expanded to f32 in memory.

pub fn texture_coordinate2(&self) -> &Vector2<f32>

Secondary texture UV coordinates (u, v) for multi-texturing. Often stored as f16 in file, expanded to f32 in memory.

pub fn normal(&self) -> &Vector4<f32>

Vertex normal vector for lighting calculations (x, y, z, w). Often stored as u8 normalized in file, expanded to f32 in memory.

pub fn tangent(&self) -> &Vector4<f32>

Tangent vector for normal mapping (x, y, z, w). Often stored as u8 normalized in file, expanded to f32 in memory.

pub fn bitangent(&self) -> &Vector4<f32>

Bitangent vector for normal mapping (x, y, z, w). Often stored as u8 normalized in file, expanded to f32 in memory.

pub fn color(&self) -> &Vector4<f32>

Vertex color (r, g, b, a). Typically unused in modern rendering (textures used instead).

pub fn bone_indices(&self) -> &Vector4<u8>

Bone indices for skeletal animation (up to 4 bones). For Weighted format: only first 2 are used. For Cinematic format: all 4 are used.

pub fn weights(&self) -> &Vector4<f32>

Bone weights for skeletal animation (up to 4 weights, should sum to 1.0). Often stored as u8 percentages in file, expanded to f32 in memory.

pub fn uk_1(&self) -> &Vector4<u8>

Unknown field (version 8+ only, purpose undocumented).

impl Vertex

pub fn position_mut(&mut self) -> &mut Vector4<f32>

3D position of the vertex (x, y, z, w). Often stored as f16 in file, expanded to f32 in memory.

pub fn texture_coordinate_mut(&mut self) -> &mut Vector2<f32>

Primary texture UV coordinates (u, v). Often stored as f16 in file, expanded to f32 in memory.

pub fn texture_coordinate2_mut(&mut self) -> &mut Vector2<f32>

Secondary texture UV coordinates (u, v) for multi-texturing. Often stored as f16 in file, expanded to f32 in memory.

pub fn normal_mut(&mut self) -> &mut Vector4<f32>

Vertex normal vector for lighting calculations (x, y, z, w). Often stored as u8 normalized in file, expanded to f32 in memory.

pub fn tangent_mut(&mut self) -> &mut Vector4<f32>

Tangent vector for normal mapping (x, y, z, w). Often stored as u8 normalized in file, expanded to f32 in memory.

pub fn bitangent_mut(&mut self) -> &mut Vector4<f32>

Bitangent vector for normal mapping (x, y, z, w). Often stored as u8 normalized in file, expanded to f32 in memory.

pub fn color_mut(&mut self) -> &mut Vector4<f32>

Vertex color (r, g, b, a). Typically unused in modern rendering (textures used instead).

pub fn bone_indices_mut(&mut self) -> &mut Vector4<u8>

Bone indices for skeletal animation (up to 4 bones). For Weighted format: only first 2 are used. For Cinematic format: all 4 are used.

pub fn weights_mut(&mut self) -> &mut Vector4<f32>

Bone weights for skeletal animation (up to 4 weights, should sum to 1.0). Often stored as u8 percentages in file, expanded to f32 in memory.

pub fn uk_1_mut(&mut self) -> &mut Vector4<u8>

Unknown field (version 8+ only, purpose undocumented).

impl Vertex

pub fn set_position(&mut self, val: Vector4<f32>) -> &mut Self

3D position of the vertex (x, y, z, w). Often stored as f16 in file, expanded to f32 in memory.

pub fn set_texture_coordinate(&mut self, val: Vector2<f32>) -> &mut Self

Primary texture UV coordinates (u, v). Often stored as f16 in file, expanded to f32 in memory.

pub fn set_texture_coordinate2(&mut self, val: Vector2<f32>) -> &mut Self

Secondary texture UV coordinates (u, v) for multi-texturing. Often stored as f16 in file, expanded to f32 in memory.

pub fn set_normal(&mut self, val: Vector4<f32>) -> &mut Self

Vertex normal vector for lighting calculations (x, y, z, w). Often stored as u8 normalized in file, expanded to f32 in memory.

pub fn set_tangent(&mut self, val: Vector4<f32>) -> &mut Self

Tangent vector for normal mapping (x, y, z, w). Often stored as u8 normalized in file, expanded to f32 in memory.

pub fn set_bitangent(&mut self, val: Vector4<f32>) -> &mut Self

Bitangent vector for normal mapping (x, y, z, w). Often stored as u8 normalized in file, expanded to f32 in memory.

pub fn set_color(&mut self, val: Vector4<f32>) -> &mut Self

Vertex color (r, g, b, a). Typically unused in modern rendering (textures used instead).

pub fn set_bone_indices(&mut self, val: Vector4<u8>) -> &mut Self

Bone indices for skeletal animation (up to 4 bones). For Weighted format: only first 2 are used. For Cinematic format: all 4 are used.

pub fn set_weights(&mut self, val: Vector4<f32>) -> &mut Self

Bone weights for skeletal animation (up to 4 weights, should sum to 1.0). Often stored as u8 percentages in file, expanded to f32 in memory.

pub fn set_uk_1(&mut self, val: Vector4<u8>) -> &mut Self

Unknown field (version 8+ only, purpose undocumented).

impl Vertex

pub fn read<R: ReadBytes>( data: &mut R, version: u32, vtype: VertexFormat, mtype: MaterialType, ) -> Result<Self>

Reads a vertex from binary data based on the vertex format and material type.

Different combinations of vertex format and material type have different binary layouts. This function dispatches to the appropriate reading logic based on the format/material combination.

Arguments

• data - Binary data source.
• version - RigidModel version (affects layout for some formats).
• vtype - Vertex format specifying the data layout.
• mtype - Material type (affects layout for static vertices).

Errors

Returns an error if:

• The vertex format is unknown (RLibError::DecodingRigidModelUnknownVertexFormat)
• The vertex format is unsupported for the material type (RLibError::DecodingRigidModelUnsupportedVertexFormatForMaterial)

pub fn write<W: WriteBytes>( &self, data: &mut W, version: u32, vtype: VertexFormat, mtype: MaterialType, ) -> Result<()>

Writes a vertex to binary data based on the vertex format and material type.

Different combinations of vertex format and material type have different binary layouts. This function dispatches to the appropriate writing logic based on the format/material combination.

Arguments

• data - Output buffer.
• version - RigidModel version (affects layout for some formats).
• vtype - Vertex format specifying the data layout.
• mtype - Material type (affects layout for static vertices).

Errors

Returns an error if:

• The vertex format is unknown (RLibError::DecodingRigidModelUnknownVertexFormat)
• The vertex format is unsupported for the material type (RLibError::DecodingRigidModelUnsupportedVertexFormatForMaterial)

Trait Implementations

impl Clone for Vertex

fn clone(&self) -> Vertex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vertex

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

Formats the value using the given formatter.

impl Default for Vertex

fn default() -> Vertex

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Vertex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Vertex

fn eq(&self, other: &Vertex) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Vertex

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Vertex