Skip to main content

DirectionalLight

Struct DirectionalLight 

Source
pub struct DirectionalLight {
    pub direction: Vec3,
    pub color: LinearRgba,
    pub intensity: f32,
    pub shadow_enabled: bool,
    pub shadow_bias: f32,
    pub shadow_normal_bias: f32,
}
Expand description

A directional light source that illuminates from a uniform direction.

Directional lights simulate infinitely distant light sources like the sun. They have no position, only a direction, and cast parallel rays with no falloff.

§Examples

use khora_core::renderer::light::DirectionalLight;
use khora_core::math::{Vec3, LinearRgba};

// Create a warm sunlight
let sun = DirectionalLight {
    direction: Vec3::new(-0.5, -1.0, -0.3).normalize(),
    color: LinearRgba::new(1.0, 0.95, 0.8, 1.0),
    intensity: 1.0,
    shadow_enabled: true,
    shadow_bias: 0.005,
    shadow_normal_bias: 0.02,
};

Fields§

§direction: Vec3

The direction the light is pointing (normalized).

This vector points from the light source towards the scene. For a sun at noon, this would be (0, -1, 0).

§color: LinearRgba

The color of the light in linear RGB space.

§intensity: f32

The intensity multiplier for the light.

A value of 1.0 represents standard intensity. Higher values create brighter lights, useful for HDR rendering.

§shadow_enabled: bool

Whether this light casts shadows.

§shadow_bias: f32

Constant bias to apply to depth values to prevent shadow acne.

§shadow_normal_bias: f32

Normal-based bias to apply to prevent shadow acne on sloped surfaces.

Trait Implementations§

Source§

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

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 DirectionalLight

Source§

fn clone(&self) -> DirectionalLight

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 DirectionalLight

Source§

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

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

impl<__Context> Decode<__Context> for DirectionalLight

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 DirectionalLight

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for DirectionalLight

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 DirectionalLight

Source§

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

Encode a given type.
Source§

impl PartialEq for DirectionalLight

Source§

fn eq(&self, other: &DirectionalLight) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for DirectionalLight

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 Copy for DirectionalLight

Source§

impl StructuralPartialEq for DirectionalLight

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