API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfaceFilterPassOptions

@codexo/exojs / rendering / stable

Options for FilterPass.

4
props
0
methods
0
events
Import
import { FilterPassOptions } from '@codexo/exojs'

Options for FilterPass.

Properties4
enabled?: boolean
Initial enabled state. Default true. Toggle later via the RenderPass.enabled field.
label?: string
Optional debug label for the inspector / logging. Default: the constructor name. Display only - not an identity.
resolution?: number
Device pixels per logical unit of the textures this pass runs on, passed to every filter. Filters express their parameters in logical units, so a chain on targets allocated at twice the logical size needs 2 here or every effect comes out half as wide. The default is 1 because the textures are the caller's and nothing about them states a density - the same reason Filter.apply documents 1 as the honest answer for a hand-rolled chain.
target?: RenderTextureAn off-screen render target that can also be sampled as a texture. Combines RenderTarget (framebuffer attachment) with the sampler parameters of a Texture (sca… | null
Off-screen destination. null or omitted writes the active target (the canvas unless a parent redirected it). Caller-owned and stable across frames; never allocated, pooled, resized or destroyed by the pass. May be the source texture, in which case the chain runs through borrowed intermediates and the result is blitted back.
Source
src/rendering/FilterPass.ts