Struct Lightning 

pub struct Lightning { /* private fields */ }

A configurable lightning effect for egui.

Lightning paints a jagged bolt plus a full-area flash — the “room lighting up” — on an egui layer. It maintains its state between frames using egui’s temporary data storage and never disturbs the host layout.

A strike is episodic: it lives for duration_ms and flickers through several sub-flashes. Queue one immediately with strike (the tuned host-triggered path) or let the ambient scheduler fire on its own through ambient_interval_secs.

Implementations

impl Lightning

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

Creates a new lightning effect with a unique ID.

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

Builds a lightning effect from LightningSettings.

Use the same id_source for show and strike so both address one state.

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

Sets the bolt and flash color.

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

Sets how many bolts a strike draws.

pub fn branch_depth(self, branch_depth: u32) -> Self

Sets the branch recursion depth (0 draws the trunk only).

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

Sets the bright core stroke thickness in pixels.

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

Sets the midpoint-displacement jitter as a fraction of segment length.

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

Sets the peak alpha of the full-area flash in 0.0..=1.0.

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

Sets the strike duration in milliseconds.

pub fn ambient_interval_secs(self, secs: f32) -> Self

Sets the ambient interval in seconds (0.0 disables the scheduler).

pub fn on_top(self) -> Self

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

pub fn on_foreground(self) -> Self

Places the lightning on the Foreground layer.

pub fn on_background(self) -> Self

Places the lightning 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 lightning effect to a specific area.

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

pub fn strike(self, ctx: &Context)

Queues a strike immediately and requests a repaint.

This is the host-triggered path; Lightning::from_settings(id, &settings).strike(ctx) is the tuned one. strike uses the same id_source as show, so both must be constructed with the same id for the queued strike to be painted. A degenerate area is a no-op.

pub fn show(self, ctx: &Context)

Updates and renders the lightning effect.

Call this every frame. While a strike animates it requests a repaint; when idle it requests nothing (ambient off) or wakes exactly for the next ambient strike, so an idle effect costs the host no frames.

Trait Implementations

impl Debug for Lightning

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

Formats the value using the given formatter.