Struct Snow 

pub struct Snow { /* private fields */ }

A configurable snow effect for egui.

Snow allows you to add a falling snow animation to any egui layer or area. It maintains its state between frames using egui’s temporary data storage.

Ported from egui-snow; the algorithm, defaults and builders match upstream.

Implementations

impl Snow

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

Creates a new snow effect with a unique ID.

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

Builds a snow effect from SnowSettings.

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 color of the snowflakes.

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

Sets the number of snowflakes.

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

Sets the falling speed range (min..=max) in pixels per second.

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

Sets the snowflake size range (min..=max).

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

Sets the wind vector.

pub fn on_top(self) -> Self

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

pub fn on_foreground(self) -> Self

Places the snow on the Foreground layer.

pub fn on_background(self) -> Self

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

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

pub fn show(self, ctx: &Context)

Updates and renders the snow effect.

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

Trait Implementations

impl Debug for Snow

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

Formats the value using the given formatter.