Struct ScrinEffect 

pub struct ScrinEffect<'a> { /* private fields */ }

A themeable Scrin/Aisling effect player as a normal Scrin widget.

Implementations

impl<'a> ScrinEffect<'a>

pub fn new(kind: EffectKind, text: impl Into<Cow<'a, str>>) -> Self

Creates an Aisling effect widget powered by Scrin’s EffectPlayer.

pub fn tick(self, tick: u64) -> Self

Sets the animation tick/frame selector.

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

Sets generated effect duration in frames.

pub fn seed(self, seed: u64) -> Self

Sets deterministic effect seed.

pub fn palette(self, palette: AislingPalette) -> Self

Sets the palette used for Scrin/Aisling accent and gradient colors.

pub fn block(self, block: Block<'a>) -> Self

Adds a block around the effect.

pub fn render_with_interaction( &self, frame: &mut Frame<'_>, id: impl Into<WidgetId>, area: Rect, )

Renders into a Scrin frame and registers a single effect hit region.

Trait Implementations

impl<'a> Clone for ScrinEffect<'a>

fn clone(&self) -> ScrinEffect<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ScrinEffect<'a>

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

Formats the value using the given formatter.

impl PartialEq for ScrinEffect<'_>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Widget for ScrinEffect<'_>

fn render(&self, buf: &mut Buffer, area: Rect)