Skip to main content

StandardMaterial

Struct StandardMaterial 

Source
pub struct StandardMaterial {
    pub base_color: LinearRgba,
    pub base_color_texture: Option<AssetUUID>,
    pub metallic: f32,
    pub roughness: f32,
    pub metallic_roughness_texture: Option<AssetUUID>,
    pub normal_map: Option<AssetUUID>,
    pub occlusion_map: Option<AssetUUID>,
    pub emissive: LinearRgba,
    pub emissive_texture: Option<AssetUUID>,
    pub alpha_mode: AlphaMode,
    pub alpha_cutoff: f32,
    pub double_sided: bool,
}
Expand description

A physically-based rendering (PBR) material using the metallic-roughness workflow.

This is the primary material type for realistic 3D objects in Khora. It implements the standard PBR metallic-roughness model, which is widely used in modern game engines and 3D content creation tools (e.g., glTF 2.0 standard).

§PBR Properties

  • Base Color: The surface’s base color (albedo). For metals, this represents the reflectance; for dielectrics, this is the diffuse color.
  • Metallic: Controls whether the surface behaves like a metal (1.0) or a dielectric/non-metal (0.0). Intermediate values create unrealistic results.
  • Roughness: Controls how smooth (0.0) or rough (1.0) the surface appears. This affects specular reflections.

§Texture Maps

Supports all common PBR texture maps:

  • Base color/albedo
  • Metallic-roughness combined (metallic in B channel, roughness in G channel)
  • Normal map for surface detail
  • Ambient occlusion for subtle shadows
  • Emissive for self-illuminating areas

§Examples

use khora_core::asset::StandardMaterial;
use khora_core::math::LinearRgba;

// Create a rough, non-metallic surface (e.g., concrete)
let concrete = StandardMaterial {
    base_color: LinearRgba::new(0.5, 0.5, 0.5, 1.0),
    metallic: 0.0,
    roughness: 0.9,
    ..Default::default()
};

// Create a smooth, metallic surface (e.g., polished gold)
let gold = StandardMaterial {
    base_color: LinearRgba::new(1.0, 0.766, 0.336, 1.0),
    metallic: 1.0,
    roughness: 0.2,
    ..Default::default()
};

Fields§

§base_color: LinearRgba

The base color (albedo) of the material.

For metals, this is the reflectance color at normal incidence. For dielectrics, this is the diffuse color.

§base_color_texture: Option<AssetUUID>

Optional texture for the base color.

If present, this texture’s RGB values are multiplied with base_color. The alpha channel can be used for transparency when combined with appropriate alpha_mode.

§metallic: f32

The metallic factor (0.0 = dielectric, 1.0 = metal).

This value should typically be either 0.0 or 1.0 for physically accurate results. Intermediate values can be used for artistic effects but are not physically based.

§roughness: f32

The roughness factor (0.0 = smooth, 1.0 = rough).

Controls the microsurface detail of the material, affecting specular reflection. Lower values produce sharp, mirror-like reflections; higher values produce more diffuse reflections.

§metallic_roughness_texture: Option<AssetUUID>

Optional texture for metallic and roughness values.

glTF 2.0 convention: Blue channel = metallic, Green channel = roughness. If present, the texture values are multiplied with the metallic and roughness factors.

§normal_map: Option<AssetUUID>

Optional normal map for adding surface detail.

Normal maps perturb the surface normal to create the illusion of fine geometric detail without adding actual geometry. Stored in tangent space.

§occlusion_map: Option<AssetUUID>

Optional ambient occlusion map.

AO maps darken areas that should receive less ambient light, such as crevices and contact points. The red channel is sampled and multiplied into the indirect (ambient/IBL) term only — it never attenuates direct lighting.

§emissive: LinearRgba

The emissive color of the material.

Allows the material to emit light. This color is added to the final shaded result and is not affected by lighting. Useful for self-illuminating objects like screens, neon signs, or magical effects.

§emissive_texture: Option<AssetUUID>

Optional texture for emissive color.

If present, this texture’s RGB values are multiplied with emissive.

§alpha_mode: AlphaMode

The alpha blending mode for this material.

Determines how transparency is handled. See AlphaMode for details.

§alpha_cutoff: f32

The alpha cutoff threshold when using AlphaMode::Mask.

Fragments with alpha values below this threshold are discarded. Typically set to 0.5. Only used when alpha_mode is AlphaMode::Mask.

§double_sided: bool

Whether the material should be rendered double-sided.

If false, back-facing triangles are culled for better performance. If true, both sides of the geometry are rendered.

Trait Implementations§

Source§

impl<'__de, __Context> BorrowDecode<'__de, __Context> for StandardMaterial

Source§

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.
Source§

impl Clone for StandardMaterial

Source§

fn clone(&self) -> StandardMaterial

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StandardMaterial

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<__Context> Decode<__Context> for StandardMaterial

Source§

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.
Source§

impl Default for StandardMaterial

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for StandardMaterial

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Encode for StandardMaterial

Source§

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.
Source§

impl Material for StandardMaterial

Source§

fn base_color(&self) -> LinearRgba

Returns the base color (albedo or diffuse) of the material. Default implementation is White.
Source§

fn emissive_color(&self) -> LinearRgba

Returns the emissive color of the material. Default implementation is Black.
Source§

fn metallic(&self) -> f32

Returns the metallic factor (0.0 = dielectric, 1.0 = metal). Default implementation is 0.0.
Source§

fn roughness(&self) -> f32

Returns the roughness factor (0.0 = smooth, 1.0 = rough). Default implementation is 1.0.
Source§

fn base_color_texture(&self) -> Option<AssetUUID>

Returns the UUID of the base-color (albedo) texture, if any. Default implementation is None (untextured).
Source§

fn metallic_roughness_texture(&self) -> Option<AssetUUID>

Returns the UUID of the metallic-roughness texture, if any (glTF convention: B=metallic, G=roughness). Default implementation is None.
Source§

fn normal_map(&self) -> Option<AssetUUID>

Returns the UUID of the tangent-space normal map, if any. Default implementation is None.
Source§

fn emissive_texture(&self) -> Option<AssetUUID>

Returns the UUID of the emissive texture, if any. Default implementation is None.
Source§

fn occlusion_map(&self) -> Option<AssetUUID>

Returns the UUID of the ambient-occlusion map, if any (red channel). Attenuates the indirect (ambient/IBL) term only, never direct light. Default implementation is None.
Source§

fn alpha_mode(&self) -> AlphaMode

Returns the material’s alpha (transparency) mode. For AlphaMode::Mask the contained value is the alpha-cutoff threshold: fragments below it are discarded. Default implementation is AlphaMode::Opaque.
Source§

fn double_sided(&self) -> bool

Whether the material is rendered double-sided (back faces not culled). false (the default) culls back faces for correctly-wound meshes.
Source§

fn specular_power(&self) -> f32

Returns the specular power or roughness conversion for the material. Default implementation is 32.0.
Source§

fn ambient_color(&self) -> LinearRgba

Returns the ambient color modifier for the material. Default implementation is (0.1, 0.1, 0.1, 0.0).
Source§

impl Serialize for StandardMaterial

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Asset for StandardMaterial

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AppLifecycle for T
where T: ?Sized,

Source§

fn on_start(&mut self, ctx: &mut dyn AppContext)

Called once after the backend is up but before the first update. Apps install their theme / fonts here.
Source§

fn on_exit(&mut self)

Called once when the window is closing. Persist state here.
Source§

impl<T> AsAny for T
where T: Any,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Returns a reference to the inner value as &dyn Any.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> MaterialClone for T
where T: Material + Clone + 'static,

Source§

fn clone_box(&self) -> Box<dyn Material>

Clones self into a new boxed dyn Material.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,