Struct ShadowConfig 

pub struct ShadowConfig {
    pub style: ShadowStyle,
    pub offset_x: i8,
    pub offset_y: i8,
    pub color: Color,
    pub surface_color: Option<Color>,
    pub edges: ShadowEdges,
    pub soft_edges: bool,
    pub composite_mode: ShadowCompositeMode,
    pub grade: Option<ShadowGradeConfig>,
}

Configuration for rendering a shadow effect.

Use the builder pattern to construct a configuration:

use tui_vfx_shadow::{ShadowConfig, ShadowStyle, ShadowEdges};
use tui_vfx_types::Color;

let config = ShadowConfig::new(Color::BLACK.with_alpha(128))
    .with_offset(2, 1)
    .with_style(ShadowStyle::HalfBlock)
    .with_edges(ShadowEdges::BOTTOM_RIGHT)
    .with_soft_edges(true);

Fields

style: ShadowStyle

Shadow rendering style.

offset_x: i8

X offset from element (positive = right, negative = left).

offset_y: i8

Y offset from element (positive = down, negative = up).

color: Color

Shadow color.

surface_color: Option<Color>

Background/surface color for half-block blending.

When rendering half-block shadows, this color is used for the “empty” half of edge cells. If None, the shadow will use transparent background.

edges: ShadowEdges

Which edges to render shadow on.

soft_edges: bool

Whether to use soft edges (half-blocks at shadow boundaries).

Only applies to ShadowStyle::HalfBlock. When true, the shadow edge uses half-block characters for a softer transition.

composite_mode: ShadowCompositeMode

Shadow compositing mode.

Controls how rendered shadow data is applied onto destination cells. The default GlyphOverlay preserves backward-compatible glyph-based shadow rendering.

grade: Option<ShadowGradeConfig>

Optional color grading parameters for GradeUnderlying mode.

Ignored when composite_mode is GlyphOverlay. When None with GradeUnderlying, the compositor uses ShadowGradeConfig::default() (zero-strength, effectively no grading).

Implementations

impl ShadowConfig

pub fn new(color: Color) -> Self

Create a new shadow configuration with the specified color.

Uses defaults for other settings:

• Style: HalfBlock
• Offset: (1, 1)
• Edges: BOTTOM_RIGHT
• Soft edges: enabled

pub fn with_offset(self, x: i8, y: i8) -> Self

Set the shadow offset (x, y).

Positive x = shadow to the right, negative = left. Positive y = shadow below, negative = above.

pub fn with_style(self, style: ShadowStyle) -> Self

Set the shadow rendering style.

pub fn with_color(self, color: Color) -> Self

Set the shadow color.

pub fn with_surface_color(self, color: Color) -> Self

Set the surface/background color for half-block blending.

pub fn with_edges(self, edges: ShadowEdges) -> Self

Set which edges should have shadows.

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

Enable or disable soft edges (half-block transitions).

pub fn with_composite_mode(self, mode: ShadowCompositeMode) -> Self

Set the shadow compositing mode.

See ShadowCompositeMode for available modes.

pub fn with_grade(self, grade: ShadowGradeConfig) -> Self

Set custom grade parameters for grade-underlying mode.

This also sets composite_mode to GradeUnderlying.

pub fn with_dramatic_grade(self) -> Self

Enable dramatic grade-underlying mode with the recommended preset.

Convenience builder that sets composite_mode to GradeUnderlying and grade to ShadowGradeConfig::dramatic().

pub fn color_at_progress(&self, progress: f64) -> Color

Calculate the actual shadow color at a given progress value.

This allows shadows to animate in/out by interpolating alpha.

Trait Implementations

impl Clone for ShadowConfig

fn clone(&self) -> ShadowConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShadowConfig

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

Formats the value using the given formatter.

impl Default for ShadowConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ShadowConfig

where ShadowConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ShadowConfig

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ShadowConfig

impl StructuralPartialEq for ShadowConfig