Struct Light2d 

pub struct Light2d {
    pub position: Vec2,
    pub radius: f32,
    pub color: [f32; 3],
    pub energy: f32,
    pub falloff: LightFalloff,
    pub blend: LightBlend,
    pub shadows: bool,
    pub shadow_filter: ShadowFilter,
    pub shadow_softness: f32,
    pub light_mask: u32,
}

A point light (Godot PointLight2D) in world space.

See the module docs for the shading contract. A light with a non-finite position, a non-positive radius/half_extent, an empty/descending stop list, or an all-zero light_mask is dropped by plan_lighting with a typed issue rather than shaded half-way.

Fields

position: Vec2

World-space light centre.

radius: f32

World-unit radius: the ramp’s 1.0, the shadow extrusion’s bound, and the discard radius for LightFalloff::Stops (ignored when the falloff is a texture, whose footprint sets its own extent, but still used for nothing else).

color: [f32; 3]

Peak light colour (linear rgb).

energy: f32

Brightness multiplier applied to the ramped colour.

falloff: LightFalloff

Radial ramp or falloff texture.

blend: LightBlend

How the light combines with the lit result.

shadows: bool

Cast shadows from the occluders whose mask it shares.

shadow_filter: ShadowFilter

Shadow edge filtering.

shadow_softness: f32

Penumbra width in world units for ShadowFilter::Pcf4; ignored when the filter is ShadowFilter::None.

light_mask: u32

Layer bits this light lights and shadows cast against 0 = nothing.

Implementations

impl Light2d

pub fn point(position: Vec2, radius: f32) -> Self

A white additive light with the default ramp.

pub fn falloff_at(&self, t: f32) -> Option<[f32; 4]>

Ramp value at normalized distance t for a stops falloff, or None when the falloff is a texture (nothing to evaluate on the CPU).

pub fn texture_uv(&self, world: Vec2) -> Vec2

Light-local uv of a world point for a texture falloff: (0,0) is the texture’s top-left, (1,1) its bottom-right, outside 0..=1 is off the light. Meaningless (but finite) for a stops falloff.

Trait Implementations

impl Clone for Light2d

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Light2d

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

Formats the value using the given formatter.

impl Default for Light2d

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Light2d

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Light2d