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: LinearRgbaThe 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: AlphaModeOptional 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: f32The 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
impl<'__de, __Context> BorrowDecode<'__de, __Context> for UnlitMaterial
§fn borrow_decode<__D>(decoder: &mut __D) -> Result<UnlitMaterial, DecodeError>where
__D: BorrowDecoder<'__de, Context = __Context>,
fn borrow_decode<__D>(decoder: &mut __D) -> Result<UnlitMaterial, DecodeError>where
__D: BorrowDecoder<'__de, Context = __Context>,
§impl Clone for UnlitMaterial
impl Clone for UnlitMaterial
§fn clone(&self) -> UnlitMaterial
fn clone(&self) -> UnlitMaterial
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more§impl Debug for UnlitMaterial
impl Debug for UnlitMaterial
§impl<__Context> Decode<__Context> for UnlitMaterial
impl<__Context> Decode<__Context> for UnlitMaterial
§fn decode<__D>(decoder: &mut __D) -> Result<UnlitMaterial, DecodeError>where
__D: Decoder<Context = __Context>,
fn decode<__D>(decoder: &mut __D) -> Result<UnlitMaterial, DecodeError>where
__D: Decoder<Context = __Context>,
§impl Default for UnlitMaterial
impl Default for UnlitMaterial
§fn default() -> UnlitMaterial
fn default() -> UnlitMaterial
§impl<'de> Deserialize<'de> for UnlitMaterial
impl<'de> Deserialize<'de> for UnlitMaterial
§fn deserialize<__D>(
__deserializer: __D,
) -> Result<UnlitMaterial, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<UnlitMaterial, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
§impl Encode for UnlitMaterial
impl Encode for UnlitMaterial
§impl Material for UnlitMaterial
impl Material for UnlitMaterial
§fn base_color(&self) -> LinearRgba
fn base_color(&self) -> LinearRgba
§fn emissive_color(&self) -> LinearRgba
fn emissive_color(&self) -> LinearRgba
§fn specular_power(&self) -> f32
fn specular_power(&self) -> f32
§fn ambient_color(&self) -> LinearRgba
fn ambient_color(&self) -> LinearRgba
§fn metallic(&self) -> f32
fn metallic(&self) -> f32
§fn roughness(&self) -> f32
fn roughness(&self) -> f32
§fn base_color_texture(&self) -> Option<AssetUUID>
fn base_color_texture(&self) -> Option<AssetUUID>
None (untextured).§fn metallic_roughness_texture(&self) -> Option<AssetUUID>
fn metallic_roughness_texture(&self) -> Option<AssetUUID>
None.§fn normal_map(&self) -> Option<AssetUUID>
fn normal_map(&self) -> Option<AssetUUID>
None.§fn emissive_texture(&self) -> Option<AssetUUID>
fn emissive_texture(&self) -> Option<AssetUUID>
None.§fn occlusion_map(&self) -> Option<AssetUUID>
fn occlusion_map(&self) -> Option<AssetUUID>
None.§fn alpha_mode(&self) -> AlphaMode
fn alpha_mode(&self) -> AlphaMode
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
fn double_sided(&self) -> bool
false (the default) culls back faces for correctly-wound meshes.§impl Serialize for UnlitMaterial
impl Serialize for UnlitMaterial
§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
impl Asset for UnlitMaterial
Auto Trait Implementations§
impl Freeze for UnlitMaterial
impl RefUnwindSafe for UnlitMaterial
impl Send for UnlitMaterial
impl Sync for UnlitMaterial
impl Unpin for UnlitMaterial
impl UnsafeUnpin for UnlitMaterial
impl UnwindSafe for UnlitMaterial
Blanket Implementations§
§impl<T> AppLifecycle for Twhere
T: ?Sized,
impl<T> AppLifecycle for Twhere
T: ?Sized,
§fn on_start(&mut self, ctx: &mut dyn AppContext)
fn on_start(&mut self, ctx: &mut dyn AppContext)
update. Apps install their theme / fonts here.Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&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 Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&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
impl<T> DowncastSend for T
§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 Fwhere
T: FromSample<F>,
impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
fn into_sample(self) -> T
§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
Source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian().§impl<F, T, S> SimdInto<T, S> for Fwhere
T: SimdFrom<F, S>,
S: Simd,
impl<F, T, S> SimdInto<T, S> for Fwhere
T: SimdFrom<F, S>,
S: Simd,
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.