Struct LightningSettings 

pub struct LightningSettings {
    pub open: bool,
    pub active: bool,
    pub color: Color32,
    pub bolt_count: usize,
    pub branch_depth: u32,
    pub thickness: f32,
    pub jitter: f32,
    pub flash_intensity: f32,
    pub duration_ms: f32,
    pub ambient_interval_secs: f32,
    pub layer: ParticleLayer,
}

User-facing knobs for Lightning.

The defaults are a cold white-blue bolt with one trunk, a shallow branch, moderate jitter, a moderate full-area flash and a ~420 ms strike. The ambient scheduler is off, so the effect is idle until the host strikes it.

Fields

open: bool

Settings-window visibility. Default false (the example opens it).

active: bool

Whether the effect is drawn at all.

color: Color32

Bolt and flash color.

bolt_count: usize

Number of bolts drawn per strike.

branch_depth: u32

Branch recursion depth (0 draws the trunk only).

thickness: f32

Bright core stroke thickness in pixels.

jitter: f32

Midpoint-displacement jitter as a fraction of segment length.

flash_intensity: f32

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

duration_ms: f32

Strike duration in milliseconds.

ambient_interval_secs: f32

Ambient interval in seconds (0.0 disables the scheduler).

layer: ParticleLayer

Layer the effect is painted on.

Implementations

impl LightningSettings

pub const STRIKE_ID: &'static str = "lightning"

id_source the settings window’s “Strike now” button queues a strike on.

Construct the effect with this id (Lightning::from_settings(LightningSettings::STRIKE_ID, &settings)) so the button drives it instead of a second, invisible state.

pub fn reset(&mut self)

Knobs back to defaults; open is preserved (a reset must not close the window).

pub fn show_window(&mut self, ctx: &Context) -> Option<Response>

Themed floating settings window; returns the window’s outer Response when open.

Window chrome plus a vertical scroll area around Self::body_ui, so a viewport shorter than the controls scrolls instead of clipping them.

pub fn body_ui(&mut self, ui: &mut Ui)

Draw the settings controls into ui — no window chrome.

Render them in your own container (egui::Window, SidePanel, ScrollArea, …) instead of using Self::show_window. If that container can be shorter than the controls, wrap it in an egui::ScrollArea.

Trait Implementations

impl Clone for LightningSettings

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 LightningSettings

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

Formats the value using the given formatter.

impl Default for LightningSettings

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for LightningSettings

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LightningSettings