Skip to main content

SpotLight

Struct SpotLight 

Source
pub struct SpotLight {
    pub position: [f32; 3],
    pub direction: [f32; 3],
    pub color: [f32; 3],
    pub intensity: f32,
    pub range: f32,
    pub inner_angle: f32,
    pub outer_angle: f32,
    pub cast_shadows: bool,
}
Expand description

A cone-shaped local light: a point light restricted to the cone around direction, with a soft edge between inner_angle and outer_angle.

Distance attenuation matches PointLight; the cone adds an angular falloff that is full brightness inside the inner cone and fades to black at the outer cone. Spot lights share the same per-scene local-light budget as point lights and are culled by the same clustered pass. Secondary effects (volumetric fog, SDF raymarching, and reflection-probe capture) do not consider them.

SpotLight {
    position: [0.0, 4.0, -2.0],
    direction: [0.0, -1.0, 0.0],
    color: [1.0, 0.9, 0.7],
    intensity: 20.0,
    range: 10.0,
    inner_angle: 18.0,
    ..Default::default()
};

Fields§

§position: [f32; 3]

World-space position of the light source.

§direction: [f32; 3]

Direction the cone points, away from the light. Does not need to be normalised; defaults to straight down when degenerate.

§color: [f32; 3]

Linear-space RGB colour of the light.

§intensity: f32

Intensity multiplier applied to the colour.

§range: f32

Maximum reach in world units; attenuation is zero at this distance.

§inner_angle: f32

Half-angle in degrees of the fully lit inner cone. Clamped to outer_angle.

§outer_angle: f32

Half-angle in degrees at which the cone fades to black. Clamped to (0, 89.9].

§cast_shadows: bool

Whether this light casts shadows. Shadowed spots claim one slice of the spot shadow map in declaration order; once the slices are used up the remaining spots still light the scene but cast nothing.

Trait Implementations§

Source§

impl Clone for SpotLight

Source§

fn clone(&self) -> SpotLight

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 Component for SpotLight

Source§

const NAME: &'static str = "SpotLight"

The registry name a world authors this component under.
Source§

fn from_baked(bytes: &[u8]) -> Result<Self, CnResult>

Reconstruct this component from a blob record, whose bytes are the serialized runtime component (cook already ran the asset -> component translation). The default rejects: runtime-only components are never stored in a blob, so only loadable types provide an implementation.
Source§

fn inject_locator(&mut self, _locator: PayloadLocator)

Called after construction to inject the payload locator from the blob def. Only meaningful for components with a compiled payload. The default implementation does nothing (correct for most components).
Source§

fn inject_name(&mut self, _id: AssetId)

Called after construction to inject the asset’s identity from the blob def. Only meaningful for components that look themselves up by id at runtime. The default implementation does nothing.
Source§

impl ComponentSlot for SpotLight

Source§

const DISCRIMINANT: u8

The component type’s stable id, used as its ComponentId.
Source§

fn slot(s: &ComponentStorage) -> &Column<Self>

Borrow this type’s column out of the storage.
Source§

fn slot_mut(s: &mut ComponentStorage) -> &mut Column<Self>

Mutably borrow this type’s column out of the storage.
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<'de> Deserialize<'de> for SpotLight

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 From<SpotLight> for ComponentAsset

Source§

fn from(c: SpotLight) -> Self

Converts to this type from the input type.
Source§

impl RuntimeComponent for SpotLight

Source§

impl Serialize for SpotLight

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 SpotLightGeometry for SpotLight

Source§

fn unit_direction(&self) -> [f32; 3]

Unit-length cone axis, falling back to straight down when the authored direction is degenerate.

Source§

fn cos_inner(&self) -> f32

Cosine of the inner half-angle: the widest angle still at full brightness.

Source§

fn cos_outer(&self) -> f32

Cosine of the outer half-angle: the angle at which the cone reaches black.

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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 = !

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.