Skip to main content

UnlitMaterial

Struct UnlitMaterial 

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, AlphaMode};
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§

§

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

§

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

Attempt to decode this type with the given BorrowDecode.
§

impl Clone for UnlitMaterial

§

fn clone(&self) -> UnlitMaterial

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
§

impl Debug for UnlitMaterial

§

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

Formats the value using the given formatter. Read more
§

impl<__Context> Decode<__Context> for UnlitMaterial

§

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

Attempt to decode this type with the given Decode.
§

impl Default for UnlitMaterial

§

fn default() -> UnlitMaterial

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

impl<'de> Deserialize<'de> for UnlitMaterial

§

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

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

impl Encode for UnlitMaterial

§

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

Encode a given type.
§

impl Material for UnlitMaterial

§

fn base_color(&self) -> LinearRgba

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

fn emissive_color(&self) -> LinearRgba

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

fn specular_power(&self) -> f32

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

fn ambient_color(&self) -> LinearRgba

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

fn metallic(&self) -> f32

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

fn roughness(&self) -> f32

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

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

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

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

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

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

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

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

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

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

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

impl Serialize for UnlitMaterial

§

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

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

impl Asset 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
§

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

§

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

fn on_exit(&mut self)

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

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

§

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

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

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

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

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

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

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

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

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

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

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSend for T
where T: Any + Send,

§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

§

fn into_sample(self) -> T

§

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

§

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

Clones self into a new boxed dyn Material.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(value: T, _simd: S) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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
§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

§

fn to_sample_(self) -> U

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

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,