Pre-1.0: signatures are not frozen. Generated from rustdoc JSON of the compiled crate; rustdoc JSON format version 60. Only public items are listed.
Immutable typed effect graphs, prepared outside frame painting. Working colors are premultiplied f32 in the declared processing space.
Structs
structaster_ui::effects::EffectBuilder
pub struct EffectBuilder { /* see fields */ }Dependencies can only point to already admitted nodes: cycles/forward and cross-builder references are unrepresentable or rejected before append.
Methods
fn new(stage_limit: usize) -> Result<Self, EffectError>fn source(&mut self, recording: Arc<Recording>, crop: LogicalRect) -> Result<EffectNode, EffectError>— Explicit source crop, not a layout box. Content outside it is excluded before filtering. The crop may lie partly/wholly outside the final output.fn tint(&mut self, source: EffectNode, color: Srgb8) -> Result<EffectNode, EffectError>— Replace source RGB through its actual alpha, preserving the silhouette.fn gradient(&mut self, source: EffectNode, gradient: Arc<Gradient>) -> Result<EffectNode, EffectError>fn opacity(&mut self, source: EffectNode, amount: f64) -> Result<EffectNode, EffectError>— Applies once after source isolation, not once per child command.fn gaussian(&mut self, source: EffectNode, sigma: f64) -> Result<EffectNode, EffectError>— Separable sampled Gaussian, truncated at ceil(3sigmascale), normalized. Sigma is logical pixels; zero is exact identity. Transparent exterior.fn over(&mut self, front: EffectNode, back: EffectNode) -> Result<EffectNode, EffectError>fn alpha_mask(&mut self, source: EffectNode, mask: EffectNode, mode: AlphaMaskMode) -> Result<EffectNode, EffectError>— Multiply all premultiplied source channels by mask alpha (or its complement). Both inputs share graph logical coordinates. The output conservatively retains source ink bounds; masking never changes layout. Raster alpha masks are not analytic sample-mask intersections.fn finish(self, output: EffectNode) -> Result<EffectGraph, EffectError>
structaster_ui::effects::EffectDrawing
pub struct EffectDrawing { /* see fields */ }Methods
fn id(&self) -> EffectIdfn logical_ink_bounds(&self) -> LogicalRectfn preparation_scale(&self) -> f64fn color_processing(&self) -> ColorProcessingfn storage_bytes(&self) -> usize
Trait implementations: Debug
structaster_ui::effects::EffectError
pub struct EffectError { /* see fields */ }Public fields
| field | type | |
|---|---|---|
node | Option<EffectNode> | |
kind | EffectErrorKind |
Trait implementations: Clone, Copy, Debug, Display, Eq, Error, From<Error>, PartialEq, StructuralPartialEq
structaster_ui::effects::EffectGraph
pub struct EffectGraph { /* see fields */ }Methods
fn prepare(&self, scale: f64, color: ColorProcessing, limits: EffectLimits) -> Result<EffectDrawing, EffectError>— Cold evaluation: no application callback executes during painting. Scale/color are part of this immutable drawing's identity; a different output policy requires reprepare rather than silent quality degradation.
Trait implementations: Debug
structaster_ui::effects::EffectId
pub struct EffectId(..)Trait implementations: Clone, Copy, Debug, Eq, Hash, PartialEq, StructuralPartialEq
structaster_ui::effects::EffectLimits
pub struct EffectLimits { /* see fields */ }Public fields
| field | type | |
|---|---|---|
working_pixels | usize | Sum of all stage planes plus the largest Gaussian transient: its expanded horizontal scratch plus the per-worker f64 row accumulators (two pixels per output column per worker). |
source_pixels | usize | Two RGBA8 source-render planes per source, released between sources. |
output_bytes | usize | Final RGBA8 encode and retained image each fit this byte limit. |
source_commands | usize | |
max_blur_radius | usize | |
vectors | Option<VectorLimits> |
Trait implementations: Clone, Copy, Debug
structaster_ui::effects::EffectNode
pub struct EffectNode { /* see fields */ }Trait implementations: Clone, Copy, Debug, Eq, PartialEq, StructuralPartialEq
structaster_ui::effects::Gradient
pub struct Gradient { /* see fields */ }Methods
fn new(geometry: GradientGeometry, spread: GradientSpread, stops: &[GradientStop]) -> Result<Self, EffectError>— Cold bounded stops, ordered in0..=1. Equal offsets form right-continuous hard edges. Conic geometry requires Repeat and wraps one complete turn.
Trait implementations: Debug
structaster_ui::effects::GradientStop
pub struct GradientStop { /* see fields */ }Public fields
| field | type | |
|---|---|---|
offset | f64 | |
color | Srgb8 |
Trait implementations: Clone, Copy, Debug, PartialEq, StructuralPartialEq
Enums
enumaster_ui::effects::AlphaMaskMode
pub enum AlphaMaskMode { Inside, Outside }Alpha coverage in graph coordinates. Mask RGB is deliberately ignored.
Variants
Inside— Keep source through mask alpha; transparent exterior excludes source.Outside— Keep source through one minus mask alpha; exterior preserves source.
Trait implementations: Clone, Copy, Debug, Eq, PartialEq, StructuralPartialEq
enumaster_ui::effects::EffectErrorKind
pub enum EffectErrorKind { Resource, InvalidDescriptor, ForeignNode }Variants
ResourceInvalidDescriptorForeignNode
Trait implementations: Clone, Copy, Debug, Eq, PartialEq, StructuralPartialEq
enumaster_ui::effects::GradientGeometry
pub enum GradientGeometry { Linear, Radial, Conic }Variants
LinearRadialConic— Zero turns points right; increasing turns rotate clockwise in Y-down space.
Trait implementations: Clone, Copy, Debug, PartialEq, StructuralPartialEq
enumaster_ui::effects::GradientSpread
pub enum GradientSpread { Clamp, Repeat, Reflect }Variants
ClampRepeatReflect
Trait implementations: Clone, Copy, Debug, Eq, PartialEq, StructuralPartialEq