Struct Material 

pub struct Material { /* private fields */ }

Complete material definition with textures, transforms, and shader parameters.

Materials contain all rendering data except geometry. The exact fields present depend on the material type - some types use only a subset of these fields.

Field Organization

• Identification: vertex_format, name
• Unknown fields: uk_1 through uk_6 (only in certain material types)
• Textures: texture_directory, textures list
• Transforms: v_pivot, matrix1/2/3, matrix indices
• Attachments: attachment_points for effects/weapons
• Shader params: params_string, params_f32, params_i32, params_vector4df32
• Cloth physics: uk_7, uk_8, uk_9 (cloth materials only)

Matrix Storage

3x4 matrices are stored in the same format as skeleton bind pose matrices. The implicit fourth row [0, 0, 0, 1] must be added when converting to 4x4.

Implementations

impl Material

pub fn read_alpha_blend<R: ReadBytes>(data: &mut R) -> Result<Self>

pub fn write_alpha_blend<W: WriteBytes>(&self, data: &mut W) -> Result<()>

impl Material

pub fn read_cloth<R: ReadBytes>(data: &mut R) -> Result<Self>

pub fn write_cloth<W: WriteBytes>(&self, buffer: &mut W) -> Result<()>

impl Material

pub fn read_default<R: ReadBytes>(data: &mut R) -> Result<Self>

pub fn write_default<W: WriteBytes>(&self, buffer: &mut W) -> Result<()>

impl Material

pub fn read_rs_terrain<R: ReadBytes>(data: &mut R) -> Result<Self>

pub fn write_rs_terrain<W: WriteBytes>(&self, data: &mut W) -> Result<()>

impl Material

pub fn read_rs_river<R: ReadBytes>(_data: &mut R) -> Result<Self>

pub fn write_rs_river<W: WriteBytes>(&self, _data: &mut W) -> Result<()>

impl Material

pub fn read_projected_decal_v4<R: ReadBytes>(data: &mut R) -> Result<Self>

pub fn write_projected_decal_v4<W: WriteBytes>( &self, data: &mut W, ) -> Result<()>

impl Material

pub fn read_weighted_texture_blend<R: ReadBytes>(data: &mut R) -> Result<Self>

pub fn write_weighted_texture_blend<W: WriteBytes>( &self, data: &mut W, ) -> Result<()>

impl Material

pub fn vertex_format(&self) -> &VertexFormat

Vertex format determining vertex data layout.

pub fn name(&self) -> &String

Material name (human-readable identifier).

pub fn uk_1(&self) -> &u32

Unknown field 1 (only in RsTerrain and projected decal materials).

pub fn uk_2(&self) -> &u32

Unknown field 2 (only in RsTerrain and projected decal materials).

pub fn uk_3(&self) -> &u32

Unknown field 3 (only in RsTerrain and projected decal materials).

pub fn uk_4(&self) -> &u32

Unknown field 4 (only in RsTerrain and projected decal materials).

pub fn uk_5(&self) -> &u32

Unknown field 5 (only in RsTerrain and projected decal materials).

pub fn uk_6(&self) -> &u32

Unknown field 6 (only in RsTerrain and projected decal materials).

pub fn texture_directory(&self) -> &String

Directory path for texture files (relative to game data directory).

pub fn filters(&self) -> &String

Filter settings (NOT part of file format, runtime-only).

pub fn padding_byte0(&self) -> &u8

Padding byte 0 (alignment/reserved).

pub fn padding_byte1(&self) -> &u8

Padding byte 1 (alignment/reserved).

pub fn v_pivot(&self) -> &Vector3<f32>

Pivot point for transformations.

pub fn matrix1(&self) -> &Matrix3x4<f32>

Transform matrix 1 (3x4, implicit 4th row: [0, 0, 0, 1]).

pub fn matrix2(&self) -> &Matrix3x4<f32>

Transform matrix 2 (3x4, implicit 4th row: [0, 0, 0, 1]).

pub fn matrix3(&self) -> &Matrix3x4<f32>

Transform matrix 3 (3x4, implicit 4th row: [0, 0, 0, 1]).

pub fn i_matrix_index(&self) -> &i32

Matrix index in hierarchy.

pub fn i_parent_matrix_index(&self) -> &i32

Parent matrix index for hierarchical transforms.

pub fn sz_padding(&self) -> &Vec<u8>

Additional padding bytes (variable length).

pub fn attachment_points(&self) -> &Vec<AttachmentPointEntry>

Named attachment points for weapons, effects, banners, etc.

pub fn textures(&self) -> &Vec<Texture>

Texture list with type and path for each texture.

pub fn params_string(&self) -> &Vec<(i32, String)>

String shader parameters (index, value pairs).

pub fn params_f32(&self) -> &Vec<(i32, f32)>

Float shader parameters (index, value pairs).

pub fn params_i32(&self) -> &Vec<(i32, i32)>

Integer shader parameters (index, value pairs).

pub fn params_vector4df32(&self) -> &Vec<(i32, Vector4<f32>)>

Vector4 shader parameters (index, value pairs).

pub fn uk_7(&self) -> &Vec<Uk7>

Cloth physics data section 1 (cloth materials only, format undocumented).

pub fn uk_8(&self) -> &Vec<Uk8>

Cloth physics data section 2 (cloth materials only, format undocumented).

pub fn uk_9(&self) -> &Vec<Uk9>

Cloth physics data section 3 (cloth materials only, format undocumented).

impl Material

pub fn vertex_format_mut(&mut self) -> &mut VertexFormat

Vertex format determining vertex data layout.

pub fn name_mut(&mut self) -> &mut String

Material name (human-readable identifier).

pub fn uk_1_mut(&mut self) -> &mut u32

Unknown field 1 (only in RsTerrain and projected decal materials).

pub fn uk_2_mut(&mut self) -> &mut u32

Unknown field 2 (only in RsTerrain and projected decal materials).

pub fn uk_3_mut(&mut self) -> &mut u32

Unknown field 3 (only in RsTerrain and projected decal materials).

pub fn uk_4_mut(&mut self) -> &mut u32

Unknown field 4 (only in RsTerrain and projected decal materials).

pub fn uk_5_mut(&mut self) -> &mut u32

Unknown field 5 (only in RsTerrain and projected decal materials).

pub fn uk_6_mut(&mut self) -> &mut u32

Unknown field 6 (only in RsTerrain and projected decal materials).

pub fn texture_directory_mut(&mut self) -> &mut String

Directory path for texture files (relative to game data directory).

pub fn filters_mut(&mut self) -> &mut String

Filter settings (NOT part of file format, runtime-only).

pub fn padding_byte0_mut(&mut self) -> &mut u8

Padding byte 0 (alignment/reserved).

pub fn padding_byte1_mut(&mut self) -> &mut u8

Padding byte 1 (alignment/reserved).

pub fn v_pivot_mut(&mut self) -> &mut Vector3<f32>

Pivot point for transformations.

pub fn matrix1_mut(&mut self) -> &mut Matrix3x4<f32>

Transform matrix 1 (3x4, implicit 4th row: [0, 0, 0, 1]).

pub fn matrix2_mut(&mut self) -> &mut Matrix3x4<f32>

Transform matrix 2 (3x4, implicit 4th row: [0, 0, 0, 1]).

pub fn matrix3_mut(&mut self) -> &mut Matrix3x4<f32>

Transform matrix 3 (3x4, implicit 4th row: [0, 0, 0, 1]).

pub fn i_matrix_index_mut(&mut self) -> &mut i32

Matrix index in hierarchy.

pub fn i_parent_matrix_index_mut(&mut self) -> &mut i32

Parent matrix index for hierarchical transforms.

pub fn sz_padding_mut(&mut self) -> &mut Vec<u8>

Additional padding bytes (variable length).

pub fn attachment_points_mut(&mut self) -> &mut Vec<AttachmentPointEntry>

Named attachment points for weapons, effects, banners, etc.

pub fn textures_mut(&mut self) -> &mut Vec<Texture>

Texture list with type and path for each texture.

pub fn params_string_mut(&mut self) -> &mut Vec<(i32, String)>

String shader parameters (index, value pairs).

pub fn params_f32_mut(&mut self) -> &mut Vec<(i32, f32)>

Float shader parameters (index, value pairs).

pub fn params_i32_mut(&mut self) -> &mut Vec<(i32, i32)>

Integer shader parameters (index, value pairs).

pub fn params_vector4df32_mut(&mut self) -> &mut Vec<(i32, Vector4<f32>)>

Vector4 shader parameters (index, value pairs).

pub fn uk_7_mut(&mut self) -> &mut Vec<Uk7>

Cloth physics data section 1 (cloth materials only, format undocumented).

pub fn uk_8_mut(&mut self) -> &mut Vec<Uk8>

Cloth physics data section 2 (cloth materials only, format undocumented).

pub fn uk_9_mut(&mut self) -> &mut Vec<Uk9>

Cloth physics data section 3 (cloth materials only, format undocumented).

impl Material

pub fn set_vertex_format(&mut self, val: VertexFormat) -> &mut Self

Vertex format determining vertex data layout.

pub fn set_name(&mut self, val: String) -> &mut Self

Material name (human-readable identifier).

pub fn set_uk_1(&mut self, val: u32) -> &mut Self

Unknown field 1 (only in RsTerrain and projected decal materials).

pub fn set_uk_2(&mut self, val: u32) -> &mut Self

Unknown field 2 (only in RsTerrain and projected decal materials).

pub fn set_uk_3(&mut self, val: u32) -> &mut Self

Unknown field 3 (only in RsTerrain and projected decal materials).

pub fn set_uk_4(&mut self, val: u32) -> &mut Self

Unknown field 4 (only in RsTerrain and projected decal materials).

pub fn set_uk_5(&mut self, val: u32) -> &mut Self

Unknown field 5 (only in RsTerrain and projected decal materials).

pub fn set_uk_6(&mut self, val: u32) -> &mut Self

Unknown field 6 (only in RsTerrain and projected decal materials).

pub fn set_texture_directory(&mut self, val: String) -> &mut Self

Directory path for texture files (relative to game data directory).

pub fn set_filters(&mut self, val: String) -> &mut Self

Filter settings (NOT part of file format, runtime-only).

pub fn set_padding_byte0(&mut self, val: u8) -> &mut Self

Padding byte 0 (alignment/reserved).

pub fn set_padding_byte1(&mut self, val: u8) -> &mut Self

Padding byte 1 (alignment/reserved).

pub fn set_v_pivot(&mut self, val: Vector3<f32>) -> &mut Self

Pivot point for transformations.

pub fn set_matrix1(&mut self, val: Matrix3x4<f32>) -> &mut Self

Transform matrix 1 (3x4, implicit 4th row: [0, 0, 0, 1]).

pub fn set_matrix2(&mut self, val: Matrix3x4<f32>) -> &mut Self

Transform matrix 2 (3x4, implicit 4th row: [0, 0, 0, 1]).

pub fn set_matrix3(&mut self, val: Matrix3x4<f32>) -> &mut Self

Transform matrix 3 (3x4, implicit 4th row: [0, 0, 0, 1]).

pub fn set_i_matrix_index(&mut self, val: i32) -> &mut Self

Matrix index in hierarchy.

pub fn set_i_parent_matrix_index(&mut self, val: i32) -> &mut Self

Parent matrix index for hierarchical transforms.

pub fn set_sz_padding(&mut self, val: Vec<u8>) -> &mut Self

Additional padding bytes (variable length).

pub fn set_attachment_points( &mut self, val: Vec<AttachmentPointEntry>, ) -> &mut Self

Named attachment points for weapons, effects, banners, etc.

pub fn set_textures(&mut self, val: Vec<Texture>) -> &mut Self

Texture list with type and path for each texture.

pub fn set_params_string(&mut self, val: Vec<(i32, String)>) -> &mut Self

String shader parameters (index, value pairs).

pub fn set_params_f32(&mut self, val: Vec<(i32, f32)>) -> &mut Self

Float shader parameters (index, value pairs).

pub fn set_params_i32(&mut self, val: Vec<(i32, i32)>) -> &mut Self

Integer shader parameters (index, value pairs).

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

Vector4 shader parameters (index, value pairs).

pub fn set_uk_7(&mut self, val: Vec<Uk7>) -> &mut Self

Cloth physics data section 1 (cloth materials only, format undocumented).

pub fn set_uk_8(&mut self, val: Vec<Uk8>) -> &mut Self

Cloth physics data section 2 (cloth materials only, format undocumented).

pub fn set_uk_9(&mut self, val: Vec<Uk9>) -> &mut Self

Cloth physics data section 3 (cloth materials only, format undocumented).

impl Material

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

Reads a material from binary data based on the material type.

Different material types have different binary layouts. This function dispatches to the appropriate type-specific reader.

Errors

Returns RLibError::DecodingRigidModelUnsupportedMaterialType if the material type is not supported.

pub fn write<W: WriteBytes>( &self, buffer: &mut W, mtype: MaterialType, ) -> Result<()>

Writes a material to binary data based on the material type.

Different material types have different binary layouts. This function dispatches to the appropriate type-specific writer.

Errors

Returns RLibError::DecodingRigidModelUnsupportedMaterialType if the material type is not supported.

Trait Implementations

impl Clone for Material

fn clone(&self) -> Material

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Material

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

Formats the value using the given formatter.

impl Default for Material

fn default() -> Material

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Material

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Material

fn eq(&self, other: &Material) -> 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 Material

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 Material