Skip to main content

CatalogEffect

Enum CatalogEffect 

Source
pub enum CatalogEffect {
    Colorblind,
    Crt,
    Scanlines,
    Bloom,
    GlowOnBell,
    Snow,
    Aurora,
    Grain,
}
Expand description

The catalog registry. ALL is emitted by the derive — adding a variant mechanically grows the registry and breaks every exhaustive match below until the effect is fully wired.

Variants§

§

Colorblind

§

Crt

§

Scanlines

§

Bloom

§

GlowOnBell

§

Snow

§

Aurora

§

Grain

Implementations§

Source§

impl CatalogEffect

Source

pub const ALL: &'static [Self]

Source

pub const fn all() -> &'static [Self]

Source§

impl CatalogEffect

Source

pub const fn name(self) -> &'static str

Operator-facing effect name (matches the (defeffect …) form name and the YAML toggle key).

Source

pub const fn priority(self) -> u16

Render-order priority — all catalog effects live in engawa’s post range (200..=799).

Source

pub const fn params_resource(self) -> &'static str

Resource id of the effect’s params uniform buffer.

Source

pub const fn params_size(self) -> usize

size_of the effect’s Params struct — must equal the (params-size N) declared in the effect’s .tlisp form (enforced by the matrix test).

Source

pub const fn tlisp_path(self) -> &'static str

Repo-relative path of the effect’s (defeffect …) form.

Source

pub fn default_params_bytes(self) -> Vec<u8>

Default params, bytemuck-encoded — ready to seed a uniform buffer or a crate::FrameUniforms entry. Going through bytemuck::bytes_of is also the matrix test’s Pod proof: a non-Pod Params would not compile here.

Source

pub fn effect(self) -> Effect

The operator-facing toggle unit (engawa Effect). For multi-node effects (bloom) this carries the material that lands on the output; CatalogEffect::lower is the canonical node surface either way.

Source

pub fn lower(self, input: &ResourceId, output: &ResourceId) -> Vec<Node>

Canonical Effect → Node lowering: read input, write output, plus the effect’s internal ping-pong nodes (bloom emits 4 nodes; everything else 1).

Source

pub fn aux_resources(self) -> Vec<(&'static str, ResourceKind)>

Intermediate (node-produced) resources the lowering introduces beyond input/output — the consumer leases these from a crate::TexturePool and the graph declares them.

Source

pub fn graph(self) -> RenderGraph

The canonical single-effect graph: SCENE (input) → effect nodes → OUT, with the sampler + params uniform declared as graph inputs. graph().compile() succeeding is the matrix test’s wiring proof.

Trait Implementations§

Source§

impl Clone for CatalogEffect

Source§

fn clone(&self) -> CatalogEffect

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for CatalogEffect

Source§

impl Debug for CatalogEffect

Source§

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

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

impl Eq for CatalogEffect

Source§

impl Hash for CatalogEffect

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for CatalogEffect

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 StructuralPartialEq for CatalogEffect

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,