Skip to main content

RectAreaLight

Struct RectAreaLight 

Source
pub struct RectAreaLight {
    pub centre: [f32; 3],
    pub normal: [f32; 3],
    pub half_size: [f32; 2],
    pub color: [f32; 3],
    pub intensity: f32,
    pub range: f32,
    pub two_sided: bool,
}
Expand description

A rectangular area light: a glowing panel that lights the scene from its whole surface rather than from a single point.

Unlike a PointLight or SpotLight, the softness of the shadow terminator and the shape of the specular highlight follow the panel’s real dimensions, so a wide softbox wraps light around a surface and leaves a stretched rectangular reflection on glossy materials. Use it for windows, ceiling panels, screens, and practical lights.

The panel is positioned by centre, oriented by normal (the direction it emits), and sized by half_size, matching GlassPanel.

RectAreaLight {
    centre: [0.0, 3.0, -4.0],
    normal: [0.0, 0.0, 1.0],
    half_size: [1.5, 1.0],
    color: [1.0, 0.95, 0.85],
    intensity: 12.0,
    range: 18.0,
    ..Default::default()
};

Fields§

§centre: [f32; 3]

World-space position of the panel’s centre.

§normal: [f32; 3]

Direction the panel emits. Normalised on load; defaults to +Z when degenerate.

§half_size: [f32; 2]

Half-width and half-height of the panel, in world units.

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

§two_sided: bool

When true the panel emits from both faces. A one-sided panel lights only the half-space its normal points into.

Trait Implementations§

Source§

impl Clone for RectAreaLight

Source§

fn clone(&self) -> RectAreaLight

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 RectAreaLight

Source§

const NAME: &'static str = "RectAreaLight"

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 RectAreaLight

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 RectAreaLight

Source§

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

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

impl Default for RectAreaLight

Source§

fn default() -> RectAreaLight

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

impl<'de> Deserialize<'de> for RectAreaLight

Source§

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

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

impl From<RectAreaLight> for ComponentAsset

Source§

fn from(c: RectAreaLight) -> Self

Converts to this type from the input type.
Source§

impl RectAreaLightGeometry for RectAreaLight

Source§

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

Unit-length emission direction, falling back to straight down when the authored normal is degenerate (the panel default emits downward).

Source§

impl RuntimeComponent for RectAreaLight

Source§

impl Serialize for RectAreaLight

Source§

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

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.