Struct Light 

pub struct Light { /* private fields */ }

A configurable radial-glow effect for egui.

Light paints soft, flickering motes — drifting haze or rising embers — on an egui layer. It maintains its state between frames using egui’s temporary data storage and never disturbs the host layout.

All motes are appended into a single triangle mesh per frame, so stacking order is preserved and the effect costs one shape.

Implementations

impl Light

pub fn new(id_source: impl Hash + Debug) -> Self

Creates a new light effect with a unique ID.

pub fn from_settings( id_source: impl Hash + Debug, settings: &LightSettings, ) -> Self

Builds a light effect from LightSettings.

Inverted ranges are normalized (swapped) so a host can never hand the spawner an empty range.

pub fn color(self, color: Color32) -> Self

Sets the mote color.

pub fn density(self, density: usize) -> Self

Sets the number of motes.

pub fn radius(self, range: RangeInclusive<f32>) -> Self

Sets the mote radius range (min..=max) in pixels.

pub fn intensity(self, intensity: f32) -> Self

Sets the global intensity multiplier in 0.0..=1.0.

pub fn motion(self, motion: LightMotion) -> Self

Sets the motion model.

pub fn wind(self, wind: impl Into<Vec2>) -> Self

Sets the wind vector.

pub fn flicker(self, flicker: f32) -> Self

Sets the flicker depth in 0.0..=1.0 (0 disables flicker).

pub fn lifetime(self, range: RangeInclusive<f32>) -> Self

Sets the mote lifetime range (min..=max) in seconds.

pub fn on_top(self) -> Self

Places the light on the Debug layer (on top of everything).

pub fn on_foreground(self) -> Self

Places the light on the Foreground layer.

pub fn on_background(self) -> Self

Places the light on the Background layer.

pub fn layer(self, layer_id: LayerId) -> Self

Provides full control over the rendering layer.

This overrides on_top, on_foreground, and on_background.

pub fn area(self, area: Rect) -> Self

Restricts the light effect to a specific area.

If not set, it defaults to ctx.content_rect().

pub fn show(self, ctx: &Context)

Updates and renders the light effect.

This should be called every frame. It automatically requests a repaint.

Trait Implementations

impl Debug for Light

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

Formats the value using the given formatter.