UnlitMaterial

Struct UnlitMaterial 

Source
pub struct UnlitMaterial {
    pub base_color: LinearRgba,
    pub alpha_mode: AlphaMode,
    pub alpha_cutoff: f32,
}
Expand description

A simple, unlit material.

This material does not react to lighting and simply renders with a solid base color, optionally modulated by a texture. It’s the most basic and performant type of material, ideal for:

  • UI elements and 2D sprites
  • Debug visualization
  • Performance-critical scenarios
  • Stylized games that don’t use lighting
  • Skyboxes and distant geometry

§Performance

UnlitMaterial is the fastest material type in Khora. It requires minimal shader calculations and is suitable for scenes with thousands of objects. The RenderAgent may choose unlit rendering as a fallback strategy when performance budgets are tight.

§Examples

use khora_core::asset::UnlitMaterial;
use khora_core::math::LinearRgba;

// Create a solid red unlit material
let red = UnlitMaterial {
    base_color: LinearRgba::new(1.0, 0.0, 0.0, 1.0),
    ..Default::default()
};

// Create an unlit material with alpha masking (e.g., foliage)
let foliage = UnlitMaterial {
    base_color: LinearRgba::new(0.2, 0.8, 0.2, 1.0),
    alpha_mode: AlphaMode::Mask(0.5),
    ..Default::default()
};

Fields§

§base_color: LinearRgba

The base color of the material.

This color is directly output without any lighting calculations. When a texture is present, the texture color is multiplied with this value.

§alpha_mode: AlphaMode

Optional texture for the base color.

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

Future work: This will be connected to the texture asset system when texture loading is fully implemented. 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.

Trait Implementations§

Source§

impl Clone for UnlitMaterial

Source§

fn clone(&self) -> UnlitMaterial

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UnlitMaterial

Source§

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

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

impl Default for UnlitMaterial

Source§

fn default() -> Self

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

impl Asset for UnlitMaterial

Source§

impl Material for UnlitMaterial

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> 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> 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.