Struct Material

pub struct Material { /* private fields */ }

A material staged on the GPU.

Internally a Material holds references to:

• its descriptor, MaterialDescriptor, which lives on the GPU
• AtlasTextures that determine how the material presents:
  • albedo color
  • metallic roughness
  • normal mapping
  • ambient occlusion
  • emissive

Note

Clones of Material all point to the same underlying data. Changing a value on one Material will change that value for all clones as well.

Implementations

impl Material

pub fn preprocess_images( material: Material<'_>, images: &mut [AtlasImage], ) -> Result<(), StageGltfError>

pub fn from_gltf( stage: &Stage, material: Material<'_>, entries: &[AtlasTexture], ) -> Result<Material, StageGltfError>

impl Material

pub fn id(&self) -> Id<MaterialDescriptor>

Returns the unique identifier of the material descriptor.

pub fn descriptor(&self) -> MaterialDescriptor

Returns a copy of the underlying descriptor.

pub fn set_emissive_factor(&self, param: Vec3) -> &Self

Sets the emissive factor of the material.

Arguments

• param - The emissive factor as a Vec3.

pub fn with_emissive_factor(self, param: Vec3) -> Self

Sets the emissive factor.

Arguments

• param - The emissive factor as a Vec3.

pub fn set_emissive_strength_multiplier(&self, param: f32) -> &Self

Sets the emissive strength multiplier of the material.

Arguments

• param - The emissive strength multiplier as a f32.

pub fn with_emissive_strength_multiplier(self, param: f32) -> Self

Sets the emissive strength multiplier.

Arguments

• param - The emissive strength multiplier as a f32.

pub fn set_albedo_factor(&self, param: Vec4) -> &Self

Sets the albedo factor of the material.

Arguments

• param - The albedo factor as a Vec4.

pub fn with_albedo_factor(self, param: Vec4) -> Self

Sets the albedo factor.

Arguments

• param - The albedo factor as a Vec4.

pub fn set_metallic_factor(&self, param: f32) -> &Self

Sets the metallic factor of the material.

Arguments

• param - The metallic factor as a f32.

pub fn with_metallic_factor(self, param: f32) -> Self

Sets the metallic factor.

Arguments

• param - The metallic factor as a f32.

pub fn set_roughness_factor(&self, param: f32) -> &Self

Sets the roughness factor of the material.

Arguments

• param - The roughness factor as a f32.

pub fn with_roughness_factor(self, param: f32) -> Self

Sets the roughness factor.

Arguments

• param - The roughness factor as a f32.

pub fn set_albedo_tex_coord(&self, param: u32) -> &Self

Sets the albedo texture coordinate of the material.

Arguments

• param - The texture coordinate as a u32.

pub fn with_albedo_tex_coord(self, param: u32) -> Self

Sets the albedo texture coordinate.

Arguments

• param - The texture coordinate as a u32.

pub fn set_metallic_roughness_tex_coord(&self, param: u32) -> &Self

Sets the metallic roughness texture coordinate of the material.

Arguments

• param - The texture coordinate as a u32.

pub fn with_metallic_roughness_tex_coord(self, param: u32) -> Self

Sets the metallic roughness texture coordinate.

Arguments

• param - The texture coordinate as a u32.

pub fn set_normal_tex_coord(&self, param: u32) -> &Self

Sets the normal texture coordinate of the material.

Arguments

• param - The texture coordinate as a u32.

pub fn with_normal_tex_coord(self, param: u32) -> Self

Sets the normal texture coordinate.

Arguments

• param - The texture coordinate as a u32.

pub fn set_ambient_occlusion_tex_coord(&self, param: u32) -> &Self

Sets the ambient occlusion texture coordinate of the material.

Arguments

• param - The texture coordinate as a u32.

pub fn with_ambient_occlusion_tex_coord(self, param: u32) -> Self

Sets the ambient occlusion texture coordinate.

Arguments

• param - The texture coordinate as a u32.

pub fn set_emissive_tex_coord(&self, param: u32) -> &Self

Sets the emissive texture coordinate of the material.

Arguments

• param - The texture coordinate as a u32.

pub fn with_emissive_tex_coord(self, param: u32) -> Self

Sets the emissive texture coordinate.

Arguments

• param - The texture coordinate as a u32.

pub fn set_has_lighting(&self, param: bool) -> &Self

Sets whether the material has lighting.

Arguments

• param - A boolean indicating if the material has lighting.

pub fn with_has_lighting(self, param: bool) -> Self

Sets whether the material has lighting.

Arguments

• param - A boolean indicating if the material has lighting.

pub fn set_ambient_occlusion_strength(&self, param: f32) -> &Self

Sets the ambient occlusion strength of the material.

Arguments

• param - The ambient occlusion strength as a f32.

pub fn with_ambient_occlusion_strength(self, param: f32) -> Self

Sets the ambient occlusion strength.

Arguments

• param - The ambient occlusion strength as a f32.

pub fn remove_albedo_texture(&self)

Remove the albedo texture.

This causes any [Primitive] that references this material to fall back to using the albedo factor for color.

pub fn set_albedo_texture(&self, texture: &AtlasTexture) -> &Self

Sets the albedo color texture.

pub fn with_albedo_texture(self, texture: &AtlasTexture) -> Self

Replace the albedo texture.

pub fn remove_metallic_roughness_texture(&self)

Remove the metallic roughness texture.

This causes any [Renderlet] that references this material to fall back to using the metallic and roughness factors for appearance.

pub fn set_metallic_roughness_texture(&self, texture: &AtlasTexture) -> &Self

Sets the metallic roughness texture of the material.

Arguments

• texture - A reference to the metallic roughness AtlasTexture.

pub fn with_metallic_roughness_texture(self, texture: &AtlasTexture) -> Self

Sets the metallic roughness texture and returns the material.

Arguments

• texture - A reference to the metallic roughness AtlasTexture.

pub fn remove_normal_texture(&self)

Remove the normal texture.

This causes any [Renderlet] that references this material to fall back to using the default normal mapping.

pub fn set_normal_texture(&self, texture: &AtlasTexture) -> &Self

Sets the normal texture of the material.

Arguments

• texture - A reference to the normal AtlasTexture.

pub fn with_normal_texture(self, texture: &AtlasTexture) -> Self

Sets the normal texture and returns the material.

Arguments

• texture - A reference to the normal AtlasTexture.

pub fn remove_ambient_occlusion_texture(&self)

Remove the ambient occlusion texture.

This causes any [Renderlet] that references this material to fall back to using the default ambient occlusion.

pub fn set_ambient_occlusion_texture(&self, texture: &AtlasTexture) -> &Self

Sets the ambient occlusion texture of the material.

Arguments

• texture - A reference to the ambient occlusion AtlasTexture.

pub fn with_ambient_occlusion_texture(self, texture: &AtlasTexture) -> Self

Sets the ambient occlusion texture and returns the material.

Arguments

• texture - A reference to the ambient occlusion AtlasTexture.

pub fn remove_emissive_texture(&self)

Remove the emissive texture.

This causes any [Renderlet] that references this material to fall back to using the emissive factor for appearance.

pub fn set_emissive_texture(&self, texture: &AtlasTexture) -> &Self

Sets the emissive texture of the material.

Arguments

• texture - A reference to the emissive AtlasTexture.

pub fn with_emissive_texture(self, texture: &AtlasTexture) -> Self

Sets the emissive texture and returns the material.

Arguments

• texture - A reference to the emissive AtlasTexture.

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 From<&Material> for Material

fn from(value: &Material) -> Self

Converts to this type from the input type.