SpotLight

Struct SpotLight 

Source
pub struct SpotLight {
    pub direction: Vec3,
    pub color: LinearRgba,
    pub intensity: f32,
    pub range: f32,
    pub inner_cone_angle: f32,
    pub outer_cone_angle: f32,
}
Expand description

A spot light source that emits light in a cone from a single point.

Spot lights are like point lights but restricted to a cone of influence. They’re useful for flashlights, stage lights, and car headlights.

§Examples

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

// Create a flashlight
let flashlight = SpotLight {
    direction: Vec3::new(0.0, 0.0, -1.0),
    color: LinearRgba::WHITE,
    intensity: 200.0,
    range: 20.0,
    inner_cone_angle: 15.0_f32.to_radians(),
    outer_cone_angle: 30.0_f32.to_radians(),
};

Fields§

§direction: Vec3

The direction the spotlight is pointing (normalized).

§color: LinearRgba

The color of the light in linear RGB space.

§intensity: f32

The intensity of the light in lumens.

§range: f32

The maximum range of the light in world units.

§inner_cone_angle: f32

The angle in radians at which the light begins to fall off.

Within this angle from the center of the cone, the light is at full intensity.

§outer_cone_angle: f32

The angle in radians at which the light is fully attenuated.

Beyond this angle from the center of the cone, there is no light. The region between inner and outer cone angles has smooth falloff.

Trait Implementations§

Source§

impl Clone for SpotLight

Source§

fn clone(&self) -> SpotLight

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 SpotLight

Source§

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

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

impl Default for SpotLight

Source§

fn default() -> Self

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

impl PartialEq for SpotLight

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 Copy for SpotLight

Source§

impl StructuralPartialEq for SpotLight

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.