API reference
Every public class, method, and event in @codexo/exojs. Generated from source.
interfaceDisplacementFilterOptions
@codexo/exojs / rendering / stable
Construction-time options for a DisplacementFilter.
3
props
0
methods
0
events
Import
import { DisplacementFilterOptions } from '@codexo/exojs'Construction-time options for a DisplacementFilter.
Properties3
The displacement map. Its red and green channels are read as a direction in [-1, 1] (0.5 grey displaces nothing), stretched across the filtered area and read with the texture's own filtering and wrap mode. The filter samples the map but does not own it - destroying the filter leaves the texture alone.
offset?: readonly [number, number]Where the map is sampled from, in the map's own UV units (u right, v down the image). Animate it to scroll the distortion across the subject without redrawing the map; give the map WrapModes.Repeat for a scroll that never runs off its edge. Default [0, 0].
scale?: number | readonly [number, number]Maximum displacement in LOGICAL units, per axis; one number applies to both. Negative values invert the direction. Default 20.
Source