Skip to main content

EffectStep

Enum EffectStep 

Source
pub enum EffectStep {
Show 13 variants GaussianBlur { radius_px: Px, downsample: u32, }, DropShadowV1(DropShadowV1), BackdropWarpV1(BackdropWarpV1), BackdropWarpV2(BackdropWarpV2), NoiseV1(NoiseV1), ColorAdjust { saturation: f32, brightness: f32, contrast: f32, }, ColorMatrix { m: [f32; 20], }, AlphaThreshold { cutoff: f32, soft: f32, }, Pixelate { scale: u32, }, Dither { mode: DitherMode, }, CustomV1 { id: EffectId, params: EffectParamsV1, max_sample_offset_px: Px, }, CustomV2 { id: EffectId, params: EffectParamsV1, max_sample_offset_px: Px, input_image: Option<CustomEffectImageInputV1>, }, CustomV3 { id: EffectId, params: EffectParamsV1, max_sample_offset_px: Px, user0: Option<CustomEffectImageInputV1>, user1: Option<CustomEffectImageInputV1>, sources: CustomEffectSourcesV3, },
}

Variants§

§

GaussianBlur

Fields

§radius_px: Px
§downsample: u32
§

DropShadowV1(DropShadowV1)

§

BackdropWarpV1(BackdropWarpV1)

§

BackdropWarpV2(BackdropWarpV2)

§

NoiseV1(NoiseV1)

§

ColorAdjust

Fields

§saturation: f32
§brightness: f32
§contrast: f32
§

ColorMatrix

Fields

§m: [f32; 20]
§

AlphaThreshold

Fields

§cutoff: f32
§soft: f32
§

Pixelate

Fields

§scale: u32
§

Dither

Fields

§

CustomV1

Fields

§max_sample_offset_px: Px

Maximum sampling offset (in logical px) that the custom effect may use when reading from its source texture.

This is a bounded contract input used by renderers to deterministically allocate enough context (“padding”) for effect chains (e.g. blur -> custom refraction) without introducing edge artifacts near clipped/scissored bounds.

Backends may clamp or degrade behavior under tight budgets.

§

CustomV2

Fields

§max_sample_offset_px: Px

Maximum sampling offset (in logical px) that the custom effect may use when reading from its source texture.

This preserves the deterministic chain padding story from v1.

§input_image: Option<CustomEffectImageInputV1>

Optional user-provided image input (v2 ceiling bump).

§

CustomV3

Fields

§max_sample_offset_px: Px

Maximum sampling offset (in logical px) that the custom effect may use when reading from its source textures.

This preserves the deterministic chain padding story from v1/v2.

§user0: Option<CustomEffectImageInputV1>

Optional user-provided image input 0 (v2-compatible).

§user1: Option<CustomEffectImageInputV1>

Optional user-provided image input 1 (v3 ceiling bump).

§sources: CustomEffectSourcesV3

Renderer-provided sources request (raw + optional pyramid).

Implementations§

Source§

impl EffectStep

Source

pub fn sanitize(self) -> Self

Trait Implementations§

Source§

impl Clone for EffectStep

Source§

fn clone(&self) -> EffectStep

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EffectStep

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for EffectStep

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for EffectStep

Source§

impl StructuralPartialEq for EffectStep

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.