Struct MaterialDesc 

pub struct MaterialDesc { /* private fields */ }

Implementations

impl MaterialDesc

pub const fn clearcoat_texture(&self) -> Option<TextureHandle>

pub const fn clearcoat_texture_transform(&self) -> Option<TextureTransform>

pub const fn clearcoat_roughness_texture(&self) -> Option<TextureHandle>

pub const fn clearcoat_roughness_texture_transform( &self, ) -> Option<TextureTransform>

pub const fn clearcoat_normal_texture(&self) -> Option<TextureHandle>

pub const fn clearcoat_normal_texture_transform( &self, ) -> Option<TextureTransform>

pub const fn sheen_color_texture(&self) -> Option<TextureHandle>

pub const fn sheen_color_texture_transform(&self) -> Option<TextureTransform>

pub const fn sheen_roughness_texture(&self) -> Option<TextureHandle>

pub const fn sheen_roughness_texture_transform( &self, ) -> Option<TextureTransform>

pub const fn anisotropy_texture(&self) -> Option<TextureHandle>

pub const fn anisotropy_texture_transform(&self) -> Option<TextureTransform>

pub const fn iridescence_texture(&self) -> Option<TextureHandle>

pub const fn iridescence_texture_transform(&self) -> Option<TextureTransform>

pub const fn iridescence_thickness_texture(&self) -> Option<TextureHandle>

pub const fn iridescence_thickness_texture_transform( &self, ) -> Option<TextureTransform>

pub const fn transmission_texture(&self) -> Option<TextureHandle>

pub const fn transmission_texture_transform(&self) -> Option<TextureTransform>

pub const fn thickness_texture(&self) -> Option<TextureHandle>

pub const fn thickness_texture_transform(&self) -> Option<TextureTransform>

pub const fn clearcoat_factor(&self) -> f32

Returns the scalar KHR_materials_clearcoat.clearcoatFactor.

The renderer multiplies this value by the sampled clearcoat texture when one is present.

pub const fn clearcoat_roughness_factor(&self) -> f32

Returns the untextured KHR_materials_clearcoat.clearcoatRoughnessFactor.

pub const fn clearcoat_normal_scale(&self) -> f32

pub const fn sheen_color_factor(&self) -> Color

Returns the scalar KHR_materials_sheen.sheenColorFactor.

pub const fn sheen_roughness_factor(&self) -> f32

Returns the scalar KHR_materials_sheen.sheenRoughnessFactor.

pub const fn anisotropy_strength_factor(&self) -> f32

Returns KHR_materials_anisotropy.anisotropyStrength.

pub const fn anisotropy_rotation_radians(&self) -> f32

Returns KHR_materials_anisotropy.anisotropyRotation in radians.

pub const fn iridescence_factor(&self) -> f32

Returns KHR_materials_iridescence.iridescenceFactor.

pub const fn iridescence_ior(&self) -> f32

Returns KHR_materials_iridescence.iridescenceIor.

pub const fn iridescence_thickness_minimum_nm(&self) -> f32

Returns KHR_materials_iridescence.iridescenceThicknessMinimum, in nanometers.

pub const fn iridescence_thickness_maximum_nm(&self) -> f32

Returns KHR_materials_iridescence.iridescenceThicknessMaximum, in nanometers.

pub const fn dispersion_factor(&self) -> f32

Returns KHR_materials_dispersion.dispersion as 20 / Abbe number.

pub const fn transmission_factor(&self) -> f32

Returns KHR_materials_transmission.transmissionFactor.

pub const fn ior(&self) -> f32

Returns KHR_materials_ior.ior.

pub const fn thickness_factor(&self) -> f32

Returns KHR_materials_volume.thicknessFactor, in scene units.

pub const fn attenuation_distance(&self) -> f32

Returns KHR_materials_volume.attenuationDistance, in scene units.

pub const fn attenuation_color(&self) -> Color

Returns KHR_materials_volume.attenuationColor.

pub const fn with_clearcoat_texture(self, texture: TextureHandle) -> Self

pub const fn with_clearcoat_texture_transform( self, transform: TextureTransform, ) -> Self

pub const fn with_clearcoat_roughness_texture( self, texture: TextureHandle, ) -> Self

pub const fn with_clearcoat_roughness_texture_transform( self, transform: TextureTransform, ) -> Self

pub const fn with_clearcoat_normal_texture(self, texture: TextureHandle) -> Self

pub const fn with_clearcoat_normal_texture_transform( self, transform: TextureTransform, ) -> Self

pub const fn with_clearcoat_normal_scale(self, scale: f32) -> Self

pub const fn with_sheen_color_texture(self, texture: TextureHandle) -> Self

pub const fn with_sheen_color_texture_transform( self, transform: TextureTransform, ) -> Self

pub const fn with_sheen_roughness_texture(self, texture: TextureHandle) -> Self

pub const fn with_sheen_roughness_texture_transform( self, transform: TextureTransform, ) -> Self

pub const fn with_anisotropy_texture(self, texture: TextureHandle) -> Self

pub const fn with_anisotropy_texture_transform( self, transform: TextureTransform, ) -> Self

pub const fn with_iridescence_texture(self, texture: TextureHandle) -> Self

pub const fn with_iridescence_texture_transform( self, transform: TextureTransform, ) -> Self

pub const fn with_iridescence_thickness_texture( self, texture: TextureHandle, ) -> Self

pub const fn with_iridescence_thickness_texture_transform( self, transform: TextureTransform, ) -> Self

pub const fn with_transmission_texture(self, texture: TextureHandle) -> Self

pub const fn with_transmission_texture_transform( self, transform: TextureTransform, ) -> Self

pub const fn with_thickness_texture(self, texture: TextureHandle) -> Self

pub const fn with_thickness_texture_transform( self, transform: TextureTransform, ) -> Self

pub const fn with_clearcoat_factor(self, clearcoat_factor: f32) -> Self

Sets the scalar clearcoat layer strength from KHR_materials_clearcoat.

Values are clamped to [0, 1]; NaN falls back to 0.

pub const fn with_clearcoat_roughness_factor( self, clearcoat_roughness_factor: f32, ) -> Self

Sets the scalar clearcoat roughness from KHR_materials_clearcoat.

Values are clamped to [0, 1]; NaN falls back to 0.

pub const fn with_sheen_color_factor(self, sheen_color_factor: Color) -> Self

Sets the scalar sheen color from KHR_materials_sheen.

pub const fn with_sheen_roughness_factor( self, sheen_roughness_factor: f32, ) -> Self

Sets the scalar sheen roughness from KHR_materials_sheen.

pub const fn with_anisotropy_strength_factor( self, anisotropy_strength_factor: f32, ) -> Self

Sets the scalar anisotropy strength from KHR_materials_anisotropy.

Values are clamped to [0, 1]; NaN falls back to 0.

pub const fn with_anisotropy_rotation_radians( self, anisotropy_rotation_radians: f32, ) -> Self

Sets the anisotropy rotation in tangent space, in radians.

pub const fn with_iridescence_factor(self, iridescence_factor: f32) -> Self

Sets the scalar iridescence strength from KHR_materials_iridescence.

Values are clamped to [0, 1]; NaN falls back to 0.

pub const fn with_iridescence_ior(self, iridescence_ior: f32) -> Self

Sets the thin-film index of refraction from KHR_materials_iridescence.

pub const fn with_iridescence_thickness_range_nm( self, minimum_nm: f32, maximum_nm: f32, ) -> Self

Sets the thin-film thickness range in nanometers.

The glTF extension permits minimum > maximum, so values are sanitized independently rather than reordered.

pub const fn with_dispersion_factor(self, dispersion_factor: f32) -> Self

Sets the scalar dispersion strength from KHR_materials_dispersion.

Values are sanitized to >= 0; NaN falls back to 0.

pub const fn with_transmission_factor(self, transmission_factor: f32) -> Self

Sets the scalar transmission strength from KHR_materials_transmission.

Values are clamped to [0, 1]; NaN falls back to 0.

pub const fn with_ior(self, ior: f32) -> Self

Sets the material index of refraction from KHR_materials_ior.

pub const fn with_thickness_factor(self, thickness_factor: f32) -> Self

Sets KHR_materials_volume.thicknessFactor, in scene units.

pub const fn with_attenuation_distance(self, attenuation_distance: f32) -> Self

Sets KHR_materials_volume.attenuationDistance, in scene units.

pub const fn with_attenuation_color(self, attenuation_color: Color) -> Self

Sets KHR_materials_volume.attenuationColor.

impl MaterialDesc

pub const PRESET_NAMES: &'static [&'static str]

pub fn from_preset_name(name: &str, base_color: Option<Color>) -> Option<Self>

pub const fn matte(base_color: Color) -> Self

Matte dielectric material preset: high roughness, non-metallic.

Examples

use scena::{Color, MaterialDesc};

let material = MaterialDesc::matte(Color::BLUE);
assert_eq!(material.metallic_factor(), 0.0);
assert!(material.roughness_factor() > 0.9);

pub const fn plastic(base_color: Color) -> Self

Smooth dielectric plastic preset.

Examples

use scena::{Color, MaterialDesc};

let material = MaterialDesc::plastic(Color::ORANGE);
assert_eq!(material.metallic_factor(), 0.0);
assert!(material.roughness_factor() < MaterialDesc::matte(Color::ORANGE).roughness_factor());

pub const fn metal(base_color: Color) -> Self

Metallic-roughness metal preset for generic polished-metal behavior.

Use MaterialDesc::chrome for a smoother mirror-like metal shortcut, or MaterialDesc::brushed_steel for a texture-free anisotropic steel shortcut. This preset stays a conservative, general bare-metal default.

Examples

use scena::{Color, MaterialDesc};

let material = MaterialDesc::metal(Color::LIGHT_GRAY);
assert_eq!(material.metallic_factor(), 1.0);

pub const fn rough_metal(base_color: Color) -> Self

Rough bare-metal preset for less mirror-like product surfaces.

Examples

use scena::{Color, MaterialDesc};

let material = MaterialDesc::rough_metal(Color::LIGHT_GRAY);
assert_eq!(material.metallic_factor(), 1.0);
assert!(material.roughness_factor() > MaterialDesc::metal(Color::LIGHT_GRAY).roughness_factor());

pub const fn chrome() -> Self

Smooth chrome preset backed by metallic roughness, environment reflection, and opt-in screen-space material reflections.

Enable Renderer::set_screen_space_reflections or recipe render.screen_space_reflections for chrome surfaces to sample visible scene colour in screen space. Screen-edge and occluded samples fall back to the environment-lit material; this is not a caustics model.

Examples

use scena::MaterialDesc;

let material = MaterialDesc::chrome();
assert_eq!(material.metallic_factor(), 1.0);
assert!(material.roughness_factor() < 0.1);

pub const fn brushed_steel() -> Self

Brushed steel preset backed by metallic roughness plus scalar anisotropy.

This is a texture-free brushed-metal shortcut. Use anisotropy textures for authored brush direction maps.

Examples

use scena::MaterialDesc;

let material = MaterialDesc::brushed_steel();
assert_eq!(material.metallic_factor(), 1.0);
assert!(material.anisotropy_strength_factor() > 0.5);

pub const fn clearcoat_plastic(base_color: Color) -> Self

Glossy coated plastic preset backed by KHR_materials_clearcoat factors.

Examples

use scena::{Color, MaterialDesc};

let material = MaterialDesc::clearcoat_plastic(Color::BLUE);
assert_eq!(material.metallic_factor(), 0.0);
assert!(material.clearcoat_factor() > 0.0);

pub const fn satin(base_color: Color) -> Self

Satin fabric-like preset backed by the sheen material lane.

This is a smooth sheen shortcut, not a procedural weave texture.

Examples

use scena::{Color, MaterialDesc};

let material = MaterialDesc::satin(Color::MAGENTA);
assert_eq!(material.metallic_factor(), 0.0);
assert!(material.sheen_roughness_factor() > 0.0);

pub const fn leather(base_color: Color) -> Self

Smooth leather-like preset backed by rough dielectric shading plus sheen.

This preset does not synthesize leather grain or normal-map detail.

Examples

use scena::{Color, MaterialDesc};

let material = MaterialDesc::leather(Color::ORANGE);
assert_eq!(material.metallic_factor(), 0.0);
assert!(material.sheen_roughness_factor() > 0.0);

pub const fn clear_glass(tint: Color) -> Self

Transparent glass preset backed by blend mode plus transmission, IOR, and volume metadata.

GPU backends sample the opaque scene color with IOR/thickness refraction and roughness-driven blur where supported. This is not a caustics model.

Examples

use scena::{AlphaMode, Color, MaterialDesc};

let material = MaterialDesc::clear_glass(Color::CYAN);
assert_eq!(material.alpha_mode(), AlphaMode::Blend);
assert_eq!(material.transmission_factor(), 1.0);

pub const fn frosted_glass(tint: Color) -> Self

Frosted glass preset backed by blend mode plus rough transmission, IOR, and volume metadata.

GPU backends use the shared scene-color transmission path with roughness-driven blur where supported. This is not a caustics model.

Examples

use scena::{AlphaMode, Color, MaterialDesc};

let material = MaterialDesc::frosted_glass(Color::COOL_WHITE);
assert_eq!(material.alpha_mode(), AlphaMode::Blend);
assert!(material.roughness_factor() > MaterialDesc::clear_glass(Color::COOL_WHITE).roughness_factor());

pub const fn rubber() -> Self

Dark rough rubber preset.

Examples

use scena::{Color, MaterialDesc};

let material = MaterialDesc::rubber();
assert_eq!(material.base_color(), Color::CHARCOAL);
assert_eq!(material.metallic_factor(), 0.0);

impl MaterialDesc

pub const fn unlit(base_color: Color) -> Self

pub const fn pbr_metallic_roughness( base_color: Color, metallic_factor: f32, roughness_factor: f32, ) -> Self

pub const fn line(base_color: Color, width_px: f32) -> Self

Creates a world-space stroke material for line-topology geometry and polylines.

The segment endpoints live in scene/model space; GPU backends expand them in the vertex shader to a screen-constant physical-pixel width. Strokes are depth-tested against scene geometry, clipped at the near plane, and are not pickable in v1.7.

pub const fn wireframe(base_color: Color, width_px: f32) -> Self

Creates a world-space stroke material that renders triangle mesh edges.

GPU backends retain model-space edge endpoints and expand them to screen-constant width during rendering; strokes are depth-tested, near-plane clipped, and ignored by picking in v1.7.

pub const fn edge(base_color: Color, width_px: f32) -> Self

Creates a world-space stroke material for extracted mesh edges.

The default edge threshold is 30 degrees. Use with_edge_angle_threshold_degrees to override it. GPU backends retain model-space edge endpoints and expand them to screen-constant width during rendering; strokes are depth-tested, near-plane clipped, and ignored by picking in v1.7.

pub const fn kind(&self) -> MaterialKind

pub const fn base_color(&self) -> Color

pub const fn with_base_color(self, base_color: Color) -> Self

pub const fn base_color_texture(&self) -> Option<TextureHandle>

pub const fn base_color_texture_transform(&self) -> Option<TextureTransform>

pub const fn normal_texture(&self) -> Option<TextureHandle>

pub const fn normal_texture_transform(&self) -> Option<TextureTransform>

pub const fn metallic_roughness_texture(&self) -> Option<TextureHandle>

pub const fn metallic_roughness_texture_transform( &self, ) -> Option<TextureTransform>

pub const fn occlusion_texture(&self) -> Option<TextureHandle>

pub const fn occlusion_texture_transform(&self) -> Option<TextureTransform>

pub const fn emissive_texture(&self) -> Option<TextureHandle>

pub const fn emissive_texture_transform(&self) -> Option<TextureTransform>

pub const fn alpha_mode(&self) -> AlphaMode

pub const fn emissive(&self) -> Color

pub const fn emissive_strength(&self) -> f32

pub const fn metallic_factor(&self) -> f32

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

pub const fn roughness_factor(&self) -> f32

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

pub const fn double_sided(&self) -> bool

pub const fn stroke_width_px(&self) -> Option<f32>

Returns the screen-constant stroke width in physical pixels for line, wireframe, and edge materials. Returns None for non-stroke materials.

pub const fn edge_angle_threshold_degrees(&self) -> Option<f32>

Returns the edge dihedral-angle threshold in degrees for edge materials.

0.0 means nearly every triangle pair can become an edge; 180.0 means only explicit boundaries remain. Returns None for non-edge materials.

pub const fn with_stroke_width_px(self, width_px: f32) -> Self

Updates the screen-constant stroke width for line, wireframe, and edge materials.

Invalid values fall back to DEFAULT_STROKE_WIDTH_PX. This has no effect on non-stroke materials.

pub const fn with_edge_angle_threshold_degrees( self, angle_threshold_degrees: f32, ) -> Self

Updates the edge dihedral-angle threshold in degrees.

Values clamp to [0.0, 180.0]; non-finite values fall back to DEFAULT_EDGE_ANGLE_THRESHOLD_DEGREES, replacing any previous value. This has no effect on non-edge materials.

pub const fn with_base_color_texture(self, texture: TextureHandle) -> Self

pub const fn with_base_color_texture_transform( self, transform: TextureTransform, ) -> Self

pub const fn with_normal_texture(self, texture: TextureHandle) -> Self

pub const fn with_normal_texture_transform( self, transform: TextureTransform, ) -> Self

pub const fn with_normal_scale(self, scale: f32) -> Self

Sets normalTexture.scale (glTF spec): tangent-space normal X/Y components are multiplied by this factor before TBN reconstruction. Default 1.0.

pub const fn with_occlusion_strength(self, strength: f32) -> Self

Sets occlusionTexture.strength (glTF spec): the AO factor applied is lerp(1.0, occlusion_sample, strength). Default 1.0 applies the full AO; 0.0 disables it.

pub const fn normal_scale(&self) -> f32

pub const fn occlusion_strength(&self) -> f32

pub const fn with_metallic_roughness_texture( self, texture: TextureHandle, ) -> Self

pub const fn with_metallic_roughness_texture_transform( self, transform: TextureTransform, ) -> Self

pub const fn with_occlusion_texture(self, texture: TextureHandle) -> Self

pub const fn with_occlusion_texture_transform( self, transform: TextureTransform, ) -> Self

pub const fn with_emissive_texture(self, texture: TextureHandle) -> Self

pub const fn with_emissive_texture_transform( self, transform: TextureTransform, ) -> Self

pub const fn with_alpha_mode(self, alpha_mode: AlphaMode) -> Self

pub const fn with_emissive(self, emissive: Color) -> Self

pub const fn with_emissive_strength(self, emissive_strength: f32) -> Self

pub const fn with_double_sided(self, double_sided: bool) -> Self

Trait Implementations

impl Clone for MaterialDesc

fn clone(&self) -> MaterialDesc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MaterialDesc

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

Formats the value using the given formatter.

impl Default for MaterialDesc

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for MaterialDesc

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