Struct AislingEffect 

pub struct AislingEffect { /* private fields */ }

A composable post-render effect that can be applied to any Scrin buffer area.

Implementations

impl AislingEffect

pub fn new(tick: u64) -> Self

Creates an animated effect for the given frame or time tick.

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

Sets the frame or time tick used to animate the effect.

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

Sets the palette used by the effect.

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

Sets effect strength on a 0..=10 scale.

pub fn shimmer(self, enabled: bool) -> Self

Enables or disables moving foreground highlights.

pub fn scanlines(self, enabled: bool) -> Self

Enables or disables low-contrast background scanlines.

pub fn glow(self, enabled: bool) -> Self

Enables or disables border/edge pulses.

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

Applies this effect directly to an already-rendered buffer area.

Trait Implementations

impl Clone for AislingEffect

fn clone(&self) -> AislingEffect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AislingEffect

impl Debug for AislingEffect

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

Formats the value using the given formatter.

impl Default for AislingEffect

fn default() -> Self

Returns the “default value” for a type.

impl Eq for AislingEffect

impl PartialEq for AislingEffect

fn eq(&self, other: &AislingEffect) -> 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 StructuralPartialEq for AislingEffect