Skip to content

Code-first video & image, rendered natively on WebGPU.

62.4 KB
Raw Blame

framefields effect catalog

Generated by pnpm run sync:effects-catalog from the node schemas (via pnpm run generate:effects) and packages/framefields/src/effects/classes.ts. Do not edit by hand — a stale catalog fails pnpm --filter framefields test.

67 effect classes are available from the package root and the /effects subpath:

import { Blur, Curves, FilmGrain } from "framefields";
import { Blur, Curves, FilmGrain } from "framefields/effects";

Attach one with layer.withEffect(effect), layer.withEffects([...]), comp.apply(effect) for a whole composition, new Media(comp.toVirtualMedia()).apply(effect) inside a media chain, or comp.section({ effects: [...] }) for a spatial or tracked region. Every prop is an EffectProp<T>: a plain value, a reactive signal, or a function hook.

Defaults come from the node's schema, or from the constructor for classes that are still hand-written; a — means the value is computed (often track-dependent) or defaulted downstream. Set FRAMEFIELDS_STRICT_PROPS=1 to make an unknown prop or an out-of-range value throw instead of warn.

Effect op Props
Ascii Ascii cellSize, colorMode, fg, bg, contrast, invert
AudioCompressor AudioCompressor threshold, ratio, attack, release, knee, makeupGain
AudioDelay AudioDelay delayTime, feedback, wet, dry, pingPong
AudioFade AudioFade fadeInDuration, fadeOutDuration, fadeInCurve, fadeOutCurve
AudioNoiseGate AudioNoiseGate threshold, attack, hold, release, range
AudioParametricEq AudioParametricEq type, frequency, gain, q
AudioReverb AudioReverb roomSize, damping, wet, dry, width
Blur Blur blurType, strength, angle, sigmaColor, centerX, centerY, partialBlur, radius, radiusY, shape, track
CameraParallax3D CameraParallax3D motionPreset, panX, panY, dollyZ, fov, parallaxAmount, dofAperture, focusPlane, edgeDilation, depthInvert
ChannelMerger ChannelMerger colorSpace, defaultChannel4
ChannelSplitter ChannelSplitter colorSpace
ColorBalance ColorBalance shadows, midtones, highlights, preserveLuminosity
ColorKey ColorKey keyColor, similarity, smoothness, spillSuppression, colorSpace, spillSuppressionType
Contour Contour levels, lineWidth, lineColor, fill, fillColor, smoothing
CornerPin CornerPin points
CRT CRT scanlines, lineCount, curvature, mask, vignette, noise, flicker, tracking, chroma
Datamosh Datamosh keyframes, strength, bleed, warmup
DisplacementMap DisplacementMap strengthX, strengthY, xChannel, yChannel, wrapMode
Dither Dither mode, levels, scale, monochrome, dark, light
ExtractLUT ExtractLUT strategy, samplePoints
Flip Flip horizontal, vertical, diagonal, mode, symmetry
Gooey Gooey radius, threshold, softness
Iridescence Iridescence strength, scale, shift, mode
Kaleidoscope Kaleidoscope segments, rotation, centerX, centerY, zoom
KenBurns KenBurns keyframes, motionBlurSize, movementStyle, aspectRatio
LayerStyle LayerStyle dropShadow, innerShadow, outerGlow, innerGlow, stroke, bevelEmboss, colorOverlay, dropShadowAngleHandleId, dropShadowDistanceHandleId, dropShadowSpreadHandleId, dropShadowSizeHandleId, dropShadowOpacityHandleId, innerShadowAngleHandleId, innerShadowDistanceHandleId, innerShadowChokeHandleId, innerShadowSizeHandleId, innerShadowOpacityHandleId, outerGlowSizeHandleId, outerGlowSpreadHandleId, outerGlowOpacityHandleId, innerGlowSizeHandleId, innerGlowSpreadHandleId, innerGlowOpacityHandleId, strokeSizeHandleId, strokeOpacityHandleId, bevelEmbossDepthHandleId, bevelEmbossSizeHandleId, bevelEmbossSoftenHandleId, bevelEmbossAngleHandleId, bevelEmbossAltitudeHandleId, bevelEmbossHighlightOpacityHandleId, bevelEmbossShadowOpacityHandleId, colorOverlayOpacityHandleId
Liquify Liquify operations
MaskMath MaskMath operation, radius, threshold, clampMin, clampMax, channelA, channelB, binarize, invertResult, outputFormat
MeshWarp MeshWarp cols, rows, points
NoiseGenerator NoiseGenerator noiseType, outputType, width, height, scale, octaves, persistence, lacunarity, speed, colorStart, colorEnd, durationMs, fps
OpArt OpArt pattern, frequency, angle, warp, source, colorA, colorB
Paint Paint width, height, maintainAspect, aspectRatio, backgroundColor, strokes
Painterly Painterly style, radius, edgeDarkening, paper, saturation
PatchHeal PatchHeal patches, centerX, centerY, offsetX, offsetY, radius, sourceRadius, feather, opacity, mode
Pixelate Pixelate size, shape, gap
Posterize Posterize levels, palette, colors, dither, pixelSize
ProceduralVFX ProceduralVFX effectType, outputType, width, height, density, scale, speed, intensity, seed, colorStart, colorEnd, durationMs, fps
RefineEdge RefineEdge decontaminateAmount, radius, smooth, feather, shiftEdge, matteChannel, outputMode
RefractionCaustics3D RefractionCaustics3D ior, dispersion, refractionScale, causticBrightness, causticScale, fluidRipples, rippleSpeed, roughness, specularIntensity, lightPosX, lightPosY, tintColor, tintStrength, depthInvert, depthScale
ResizerScaler ResizerScaler aspectRatioPreset, resolutionPreset, targetWidth, targetHeight, fitMode, zoom, offsetX, offsetY, backgroundMode, backgroundColor, backgroundColor2, blurRadius, backgroundBrightness, anchorX, anchorY
RGBSplit RGBSplit amount, angle, radial
Rotate Rotate angle, fit, scale
StereoPanning StereoPanning pan
Toon Toon levels, edgeThreshold, edgeWidth, edgeColor, saturation
Trails Trails decay, mode, zoom, rotation, offsetX, offsetY, hueShift, warmup
Vignette Vignette strength, radius, softness, roundness, centerX, centerY
Levels Levels master, red, green, blue
FilmGrain FilmGrain strength, size, monochrome, animated, speed, shadows, midtones, highlights
AudioSignalExtractor AudioSignalExtractor extractionMode, attackMs, releaseMs, sensitivity, noiseFloorDb, dynamicRangeDb, autoRange, smoothing, curve, beatThreshold, beatDecayMs, previewMode, nodeId
Curves Curves curveType, master, red, green, blue, hueVsHue, hueVsSat, lumVsSat, satVsSat
SelectiveColor SelectiveColor method, reds, yellows, greens, cyans, blues, magentas, whites, neutrals, blacks
GradientMap GradientMap stops, smooth, dither, opacity
ShadowsHighlights ShadowsHighlights shadowAmount, shadowTonalWidth, shadowRadius, highlightAmount, highlightTonalWidth, highlightRadius, colorCorrection, midtoneContrast
ApplyLUT ApplyLUT lutUrl, intensity
UnsharpMask UnsharpMask amount, radius, threshold
HighPass HighPass radius, contrastBoost, monochrome
HalftoneScreen HalftoneScreen mode, dotShape, frequency, angle, contrast, dotColor, paperColor, smooth, invert, cyanAngle, magentaAngle, yellowAngle, blackAngle, opacity
TileOffset TileOffset offsetX, offsetY, wrap, edgeMode
MotionBlur MotionBlur shutterAngle, samples, maxVelocity, shutterCurve, depthAware
SSAO SSAO radius, bias, intensity, kernelSamples, blurRadius
PBRGlass PBRGlass ior, roughness, transmission, dispersion, fresnelPower, tintColor
DepthOfField DepthOfField focusDistance, focalLength, aperture, maxBlur, quality
Crop Crop cropType, leftPercentage, topPercentage, widthPercentage, heightPercentage, roundness, pathPoints, mode
Vision Vision enableDetection, enableSegmentation, enablePose, enableMatte, classes, confidence, variant, mode, matteSource, maxMissedFrames, modelsDir, baseUrl, maskThreshold, featherRadius, keyBackground, backgroundKeyThreshold, visionBundle
Relight3D Relight3D lightType, intensity, lightPosX, lightPosY, lightPosZ, lightRadius, spotConeAngle, specularRoughness, specularStrength, metallic, ambientIntensity, volumetricDensity, depthScale, depthInvert, lightColor, ambientColor, normalMap
TemporalDeflicker TemporalDeflicker blendWeight, disocclusionThreshold, maxMotionPixels, scale, windowSize
Modulate Modulate hue, brightness, contrast, exposure, saturation, sepia

Prop defaults

Ascii

import { Ascii } from "framefields/effects";

new Ascii({ cellSize: 10, colorMode: "mono", fg: "#e8e8e8" });
Prop Type Default Notes
cellSize EffectProp<number> 10 Range 4 to 64. Character cell size, px.
colorMode "mono" | "source" | "green" "mono" Glyph color: fg, the layer's own colors, or green phosphor.
fg string "#e8e8e8" Glyph color (mono).
bg string "#0b0b0b" Background color.
contrast EffectProp<number> 1.2 Range 0.5 to 3. Brightness contrast before picking glyphs.
invert boolean false Dark areas get dense glyphs.

AudioCompressor

import { AudioCompressor } from "framefields/effects";

new AudioCompressor({ threshold: -24, ratio: 4, attack: 0.003 });
Prop Type Default Notes
threshold EffectProp<number> -24 Range -60 to 0. Level (dBFS) above which gain reduction begins (-60 to 0 dB). Can be modulated by a static number or dynamic signal.
ratio EffectProp<number> 4 Range 1 to 100. Input-to-output ratio above threshold (1 to 100). Can be modulated by a static number or dynamic signal.
attack EffectProp<number> 0.003 Range 0.0001 to 1. Seconds to reach full gain reduction (0.0001 to 1.0s). Can be modulated by a static number or dynamic signal.
release EffectProp<number> 0.25 Range 0.01 to 5. Seconds to recover gain after signal drops (0.01 to 5.0s). Can be modulated by a static number or dynamic signal.
knee EffectProp<number> 6 Range 0 to 24. dB range for soft-knee transition around threshold (0 to 24 dB). Can be modulated by a static number or dynamic signal.
makeupGain EffectProp<number> 0 Range 0 to 24. dBFS of gain applied after compression (0 to 24 dB). Can be modulated by a static number or dynamic signal.

AudioDelay

import { AudioDelay } from "framefields/effects";

new AudioDelay({ delayTime: 0.25, feedback: 0.4, wet: 0.3 });
Prop Type Default Notes
delayTime EffectProp<number> 0.25 Range 0.001 to 5. Delay time in seconds (0.001 to 5.0s). Can be modulated by a static number or dynamic signal.
feedback EffectProp<number> 0.4 Range 0 to 0.95. Amount of delayed signal fed back into delay line (0.0 to 0.95). Can be modulated by a static number or dynamic signal.
wet EffectProp<number> 0.3 Range 0 to 1. Mix level of the wet delayed signal (0.0 to 1.0). Can be modulated by a static number or dynamic signal.
dry EffectProp<number> 1 Range 0 to 1. Mix level of the original dry signal (0.0 to 1.0). Can be modulated by a static number or dynamic signal.
pingPong boolean false Alternates echo reflections between left and right channels

AudioFade

import { AudioFade } from "framefields/effects";

new AudioFade({ fadeInDuration: 0, fadeOutDuration: 0, fadeInCurve: "linear" });
Prop Type Default Notes
fadeInDuration EffectProp<number> 0 Range 0 to 60. Duration in seconds of fade in from silence (0 to 60s). Can be modulated by a static number or dynamic signal.
fadeOutDuration EffectProp<number> 0 Range 0 to 60. Duration in seconds of fade out to silence (0 to 60s). Can be modulated by a static number or dynamic signal.
fadeInCurve "linear" | "exponential" | "scurve" "linear" Envelope shape for fade in
fadeOutCurve "linear" | "exponential" | "scurve" "linear" Envelope shape for fade out

AudioNoiseGate

import { AudioNoiseGate } from "framefields/effects";

new AudioNoiseGate({ threshold: -40, attack: 0.005, hold: 0.05 });
Prop Type Default Notes
threshold EffectProp<number> -40 Range -120 to 0. dBFS level below which the gate closes (-120 to 0 dB). Can be modulated by a static number or dynamic signal.
attack EffectProp<number> 0.005 Range 0.0001 to 1. Seconds to open (fade in) when signal exceeds threshold (0.0001 to 1.0s). Can be modulated by a static number or dynamic signal.
hold EffectProp<number> 0.05 Range 0.001 to 5. Seconds to stay open after signal drops below threshold (0.001 to 5.0s). Can be modulated by a static number or dynamic signal.
release EffectProp<number> 0.1 Range 0.01 to 5. Seconds to close (fade out) after hold expires (0.01 to 5.0s). Can be modulated by a static number or dynamic signal.
range EffectProp<number> -80 Range -120 to 0. dBFS floor when gate is closed (-120 to 0 dB). Can be modulated by a static number or dynamic signal.

AudioParametricEq

import { AudioParametricEq } from "framefields/effects";

new AudioParametricEq({ type: "peak", frequency: 1000, gain: 0 });
Prop Type Default Notes
type "lowShelf" | "highShelf" | "peak" | "lowPass" | "highPass" | "notch" "peak" Type of biquad filter
frequency EffectProp<number> 1000 Range 20 to 20000. Cutoff or center frequency in Hz (20 to 20000 Hz). Can be modulated by a static number or dynamic signal.
gain EffectProp<number> 0 Range -24 to 24. Gain boost or cut in dB (-24 to 24 dB). Can be modulated by a static number or dynamic signal.
q EffectProp<number> 1 Range 0.01 to 10. Filter bandwidth / Q factor (0.01 to 10.0). Can be modulated by a static number or dynamic signal.

AudioReverb

import { AudioReverb } from "framefields/effects";

new AudioReverb({ roomSize: 0.5, damping: 0.5, wet: 0.3 });
Prop Type Default Notes
roomSize EffectProp<number> 0.5 Range 0 to 0.98. Room decay, size of simulated space (0 to 0.98). Can be modulated by a static number or dynamic signal.
damping EffectProp<number> 0.5 Range 0 to 1. High-frequency absorption (0 to 1.0). Can be modulated by a static number or dynamic signal.
wet EffectProp<number> 0.3 Range 0 to 1. Mix level of the wet reverberated signal (0 to 1.0). Can be modulated by a static number or dynamic signal.
dry EffectProp<number> 1 Range 0 to 1. Mix level of the original dry signal (0 to 1.0). Can be modulated by a static number or dynamic signal.
width EffectProp<number> 1 Range 0 to 1. Stereo spread of the reverb tail (0 to 1.0). Can be modulated by a static number or dynamic signal.

Blur

import { Blur } from "framefields/effects";

new Blur({ blurType: "Gaussian", strength: 5, angle: 0 });
Prop Type Default Notes
blurType "Gaussian" | "Box" | "Median" | "Motion" | "Bilateral" | "Edge-preserving" | "Radial" | "Zoom" "Gaussian" Blur Type
strength EffectProp<number> 5 Range 0 to 100. The intensity of the blur. 0 = no blur. Can be modulated by a static number or a dynamic signal.
angle EffectProp<number> 0 Range 0 to 360. Direction of a Motion blur, in degrees.
sigmaColor EffectProp<number> 0.1 Range 0.01 to 1. Sigma value for color space in Bilateral / Edge-preserving blurs. Can be modulated by a static number or a dynamic signal.
centerX EffectProp<number> 0.5 Range 0 to 1. The X coordinate of the blur center (0.0 to 1.0). Can be modulated by a static number or a dynamic signal.
centerY EffectProp<number> 0.5 Range 0 to 1. The Y coordinate of the blur center (0.0 to 1.0). Can be modulated by a static number or a dynamic signal.
partialBlur EffectProp<boolean> false Blurs only a specific circular area around center point.
radius EffectProp<number> 0.3 Range 0.01 to 1. Radius of the partial blur region (0.01 to 1.0). Can be modulated by a static number or a dynamic signal.
radiusY EffectProp<number> 0 Range 0 to 1. Vertical radius of the partial blur region (0 to 1.0). 0 reuses the horizontal radius.
shape "ellipse" | "circle" | "rect" "circle" Shape of the partial blur region.
track ObjectTrackSignals — Added by custom/blur.ts.

CameraParallax3D

import { CameraParallax3D } from "framefields/effects";

new CameraParallax3D({ motionPreset: "DollyZoom", panX: 0, panY: 0 });
Prop Type Default Notes
motionPreset "Custom" | "DollyZoom" | "Orbit" | "FlyThrough" | "HandheldShake" | "RackFocus" "DollyZoom" Motion Preset
panX EffectProp<number> 0 Range -1 to 1. Horizontal camera pan angle / position offset (-1.0 to 1.0). Can be modulated by a static number or dynamic signal.
panY EffectProp<number> 0 Range -1 to 1. Vertical camera tilt angle / position offset (-1.0 to 1.0). Can be modulated by a static number or dynamic signal.
dollyZ EffectProp<number> 0 Range -1 to 1. Camera forward/backward zoom position (-1.0 to 1.0). Can be modulated by a static number or dynamic signal.
fov EffectProp<number> 50 Range 15 to 120. Camera Field of View in degrees (15° to 120°). Can be modulated by a static number or dynamic signal.
parallaxAmount EffectProp<number> 0.6 Range 0 to 2. Strength of 3D spatial displacement depth relief. Can be modulated by a static number or dynamic signal.
dofAperture EffectProp<number> 0.3 Range 0 to 1. Lens aperture size / Circle of Confusion bokeh blur radius. Can be modulated by a static number or dynamic signal.
focusPlane EffectProp<number> 0.4 Range 0 to 1. Focal plane depth in scene (0.0=foreground, 1.0=background). Can be modulated by a static number or dynamic signal.
edgeDilation EffectProp<number> 0.5 Range 0 to 1. Inpainting border bleed to eliminate border occlusion tearing.
depthInvert boolean false Invert depth polarity (white = near vs black = near).

ChannelMerger

import { ChannelMerger } from "framefields/effects";

new ChannelMerger({ colorSpace: "RGBA", defaultChannel4: 1 });
Prop Type Default Notes
colorSpace "RGBA" | "HSLA" | "CMYK" | "LAB" "RGBA" Color space used for channel recombination (RGBA, HSLA, CMYK, or LAB).
defaultChannel4 EffectProp<number> 1 Range 0 to 1. Fallback value used when Channel 4 is unconnected (Alpha=1.0, Black=0.0 in CMYK).

ChannelSplitter

import { ChannelSplitter } from "framefields/effects";

new ChannelSplitter({ colorSpace: "RGBA" });
Prop Type Default Notes
colorSpace "RGBA" | "HSLA" | "CMYK" | "LAB" "RGBA" Color space used for channel decomposition (RGBA, HSLA, CMYK, or LAB).

ColorBalance

import { ColorBalance } from "framefields/effects";

new ColorBalance({ preserveLuminosity: true });
Prop Type Default
shadows Partial<TonalShift> {"cyanRed":0,"magentaGreen":0,"yellowBlue":0}
midtones Partial<TonalShift> {"cyanRed":0,"magentaGreen":0,"yellowBlue":0}
highlights Partial<TonalShift> {"cyanRed":0,"magentaGreen":0,"yellowBlue":0}
preserveLuminosity boolean true

ColorKey

import { ColorKey } from "framefields/effects";

new ColorKey({ keyColor: "#00ff00", similarity: 0.4, smoothness: 0.1 });
Prop Type Default Notes
keyColor string "#00ff00" Key Color
similarity EffectProp<number> 0.4 Range 0 to 1. How close the color must be to the Key Color to be removed.
smoothness EffectProp<number> 0.1 Range 0 to 1. The softness of the transparency edge.
spillSuppression EffectProp<number> 0.2 Range 0 to 1. Amount of key color spill to remove from foreground edges.
colorSpace "YUV" | "RGB" "YUV" Color space used to calculate similarity distance.
spillSuppressionType "Desaturate" | "Neutralize" | "None" "Desaturate" How key color spill is suppressed on foreground edges.

Contour

import { Contour } from "framefields/effects";

new Contour({ levels: 14, lineWidth: 1.2, lineColor: "#2b1d0e" });
Prop Type Default Notes
levels EffectProp<number> 14 Range 2 to 64. Contour lines from dark to light.
lineWidth EffectProp<number> 1.2 Range 0.5 to 8. Line width, px.
lineColor string "#2b1d0e" Line color.
fill "source" | "flat" | "none" "source" Under the lines: the layer, fillColor, or transparent.
fillColor string "#f3ead8" Paper color (flat fill).
smoothing EffectProp<number> 2 Range 0 to 8. Blur before tracing, px (smoother lines).

CornerPin

import { CornerPin } from "framefields/effects";

new CornerPin({ /* props */ });
Prop Type Default
points CornerPinPointsItem[] —

CRT

import { CRT } from "framefields/effects";

new CRT({ scanlines: 0.45, lineCount: 540, curvature: 0.12 });
Prop Type Default Notes
scanlines EffectProp<number> 0.45 Range 0 to 1. Scanline darkness.
lineCount EffectProp<number> 540 Range 100 to 2160. Scanlines over the height.
curvature EffectProp<number> 0.12 Range 0 to 1. Barrel distortion of the tube.
mask EffectProp<number> 0.25 Range 0 to 1. RGB aperture-grille strength.
vignette EffectProp<number> 0.35 Range 0 to 1. Darkening toward the edges.
noise EffectProp<number> 0.08 Range 0 to 1. Animated static.
flicker EffectProp<number> 0.03 Range 0 to 1. Brightness flicker.
tracking EffectProp<number> 0 Range 0 to 1. VHS tracking error: line jitter and a rolling band.
chroma EffectProp<number> 0 Range 0 to 20. VHS color bleed, px.

Datamosh

import { Datamosh } from "framefields/effects";

new Datamosh({ strength: 1, bleed: 0, warmup: 48 });
Prop Type Default Notes
keyframes number[] [] Layer frames that show the clean picture again (I-frames). The first frame always does.
strength EffectProp<number> 1 Range 0 to 10. How far pixels are dragged along the motion.
bleed EffectProp<number> 0 Range 0 to 1. Clean picture mixed back in per frame, 0–1.
warmup number 48 Range 1 to 240. Most frames replayed to rebuild the smear after a jump.

DisplacementMap

import { DisplacementMap } from "framefields/effects";

new DisplacementMap({ strengthX: 50, strengthY: 50, xChannel: "Red" });
Prop Type Default Notes
strengthX EffectProp<number> 50 Range 0 to 500. Horizontal displacement strength in pixels. Can be modulated by a static number or a dynamic signal.
strengthY EffectProp<number> 50 Range 0 to 500. Vertical displacement strength in pixels. Can be modulated by a static number or a dynamic signal.
xChannel "Red" | "Green" | "Blue" | "Alpha" | "Luminance" "Red" X Channel
yChannel "Red" | "Green" | "Blue" | "Alpha" | "Luminance" "Green" Y Channel
wrapMode "Clamp" | "Repeat" | "Mirror" "Clamp" Wrap Mode

Dither

import { Dither } from "framefields/effects";

new Dither({ mode: "bayer", levels: 2, scale: 2 });
Prop Type Default Notes
mode "bayer" | "noise" | "halftone" "bayer" Pattern: Bayer matrix, blue-ish noise or round halftone dots.
levels EffectProp<number> 2 Range 2 to 16. Levels per channel (2 = 1-bit).
scale EffectProp<number> 2 Range 1 to 16. Dither pixel size, px.
monochrome boolean true Map brightness to the dark → light colors instead of dithering each channel.
dark string "#111111" Dark color (monochrome).
light string "#f2efe6" Light color (monochrome).

ExtractLUT

import { ExtractLUT } from "framefields/effects";

new ExtractLUT({ strategy: "deterministic", samplePoints: 150 });
Prop Type Default Notes
strategy "deterministic" | "statistical" "deterministic" Extraction Strategy
samplePoints EffectProp<number> 150 Range 10 to 500. Sample Points

Flip

import { Flip } from "framefields/effects";

new Flip({ horizontal: true, vertical: false, diagonal: false });
Prop Type Default Notes
horizontal boolean true Mirror horizontally along the vertical center axis.
vertical boolean false Mirror vertically along the horizontal center axis.
diagonal boolean false Swap horizontal and vertical axes (diagonal transposition).
mode "horizontal" | "vertical" | "both" | "diagonal" | "antiDiagonal" | "custom" "horizontal" Quick preset mode for flipping or transposition.
symmetry "none" | "leftToRight" | "rightToLeft" | "topToBottom" | "bottomToTop" | "quadrant" "none" Split-mirror reflection and symmetry effects.

Gooey

import { Gooey } from "framefields/effects";

new Gooey({ radius: 12, threshold: 0.5, softness: 0.04 });
Prop Type Default Notes
radius EffectProp<number> 12 Range 1 to 60. Melt distance, px.
threshold EffectProp<number> 0.5 Range 0 to 1. Alpha cut, 0–1 (higher = thinner blobs).
softness EffectProp<number> 0.04 Range 0.001 to 0.5. Edge softness.

Iridescence

import { Iridescence } from "framefields/effects";

new Iridescence({ strength: 0.6, scale: 2, shift: 0 });
Prop Type Default Notes
strength EffectProp<number> 0.6 Range 0 to 1. How much rainbow, 0–1.
scale EffectProp<number> 2 Range 0.1 to 10. Rainbow bands over the range.
shift EffectProp<number> 0 Range -3600 to 3600. Hue shift, degrees (animate it).
mode "luminance" | "relief" "relief" Bands from brightness, or from the slope of the image (foil).

Kaleidoscope

import { Kaleidoscope } from "framefields/effects";

new Kaleidoscope({ segments: 6, rotation: 0, centerX: 0.5 });
Prop Type Default Notes
segments EffectProp<number> 6 Range 2 to 32. Mirror segments.
rotation EffectProp<number> 0 Range -3600 to 3600. Pattern rotation, degrees.
centerX EffectProp<number> 0.5 Range 0 to 1. Center, 0–1 across.
centerY EffectProp<number> 0.5 Range 0 to 1. Center, 0–1 down.
zoom EffectProp<number> 1 Range 0.2 to 4. Scale of the folded image.

KenBurns

import { KenBurns } from "framefields/effects";

new KenBurns({ motionBlurSize: 1.5, movementStyle: "spline", aspectRatio: "input" });
Prop Type Default Notes
keyframes KenBurnsKeyframesItem[] []
motionBlurSize number 1.5 Range 0 to 10.
movementStyle "spline" | "direct" "spline"
aspectRatio "input" | "16:9" | "9:16" | "21:9" | "9:21" | "1:1" | "4:3" | "3:2" | "2:3" | "4:5" | "5:4" "input"

LayerStyle

import { LayerStyle } from "framefields/effects";

new LayerStyle({ /* props */ });
Prop Type Default
dropShadow Partial<LayerStyleDropShadow> {"enabled":false,"color":"#000000","opacity":0.75,"angle":120,"distance":10,"spread":0,"size":10,"blendMode":"multiply"}
innerShadow Partial<LayerStyleInnerShadow> {"enabled":false,"color":"#000000","opacity":0.75,"angle":120,"distance":5,"choke":0,"size":5,"blendMode":"multiply"}
outerGlow Partial<LayerStyleOuterGlow> {"enabled":false,"color":"#ffffff","opacity":0.75,"size":15,"spread":0,"blendMode":"screen"}
innerGlow Partial<LayerStyleInnerGlow> {"enabled":false,"color":"#ffffff","opacity":0.75,"size":15,"spread":0,"blendMode":"screen"}
stroke Partial<LayerStyleStroke> {"enabled":false,"size":2,"position":"outside","color":"#ffffff","opacity":1,"blendMode":"normal"}
bevelEmboss Partial<LayerStyleBevelEmboss> {"enabled":false,"style":"InnerBevel","technique":"Smooth","depth":100,"direction":"Up","size":5,"soften":0,"angle":120,"altitude":30,"highlightColor":"#ffffff","highlightOpacity":0.75,"shadowColor":"#000000","shadowOpacity":0.75}
colorOverlay Partial<LayerStyleColorOverlay> {"enabled":false,"color":"#ff0000","opacity":1,"blendMode":"normal"}
dropShadowAngleHandleId string | null —
dropShadowDistanceHandleId string | null —
dropShadowSpreadHandleId string | null —
dropShadowSizeHandleId string | null —
dropShadowOpacityHandleId string | null —
innerShadowAngleHandleId string | null —
innerShadowDistanceHandleId string | null —
innerShadowChokeHandleId string | null —
innerShadowSizeHandleId string | null —
innerShadowOpacityHandleId string | null —
outerGlowSizeHandleId string | null —
outerGlowSpreadHandleId string | null —
outerGlowOpacityHandleId string | null —
innerGlowSizeHandleId string | null —
innerGlowSpreadHandleId string | null —
innerGlowOpacityHandleId string | null —
strokeSizeHandleId string | null —
strokeOpacityHandleId string | null —
bevelEmbossDepthHandleId string | null —
bevelEmbossSizeHandleId string | null —
bevelEmbossSoftenHandleId string | null —
bevelEmbossAngleHandleId string | null —
bevelEmbossAltitudeHandleId string | null —
bevelEmbossHighlightOpacityHandleId string | null —
bevelEmbossShadowOpacityHandleId string | null —
colorOverlayOpacityHandleId string | null —

Liquify

import { Liquify } from "framefields/effects";

new Liquify({ /* props */ });
Prop Type Default Notes
operations LiquifyOperationsItem[] [] List of localized liquify deformation operations.

MaskMath

import { MaskMath } from "framefields/effects";

new MaskMath({ operation: "Union", radius: 0, threshold: 0.5 });
Prop Type Default Notes
operation "Union" | "Intersect" | "Subtract" | "Difference" | "Invert" | "Dilate" | "Erode" | "Choke" | "Feather" "Union" Morphological or Boolean set operation applied to input alpha masks.
radius EffectProp<number> 0 Range 0 to 200. Kernel radius in pixels for Dilate, Erode, Choke, or Feather operations.
threshold EffectProp<number> 0.5 Range 0 to 1. Cutoff threshold level (0.0–1.0) for binarization step or non-linear choke.
clampMin EffectProp<number> 0 Range 0 to 1. Minimum alpha matte cutoff limit (0.0–1.0).
clampMax EffectProp<number> 1 Range 0 to 1. Maximum alpha matte cutoff limit (0.0–1.0).
channelA "Alpha" | "Luminance" | "Red" | "Green" | "Blue" "Alpha" Source channel to extract mask from Mask A (Alpha, Luminance, Red, Green, Blue).
channelB "Alpha" | "Luminance" | "Red" | "Green" | "Blue" "Alpha" Source channel to extract mask from Mask B (Alpha, Luminance, Red, Green, Blue).
binarize boolean false When enabled, outputs crisp 1-bit binary matte based on threshold.
invertResult boolean false Inverts final matte output.
outputFormat "WhiteWithAlpha" | "GrayscaleRGB" | "AlphaOnly" | "PassthroughRGB" "WhiteWithAlpha" WhiteWithAlpha (rgba(1,1,1,a)), GrayscaleRGB (rgba(a,a,a,1)), AlphaOnly (rgba(0,0,0,a)), PassthroughRGB (Mask A RGB with new alpha).

MeshWarp

import { MeshWarp } from "framefields/effects";

new MeshWarp({ cols: 3, rows: 3 });
Prop Type Default Notes
cols number 3 Range 2 to 12.
rows number 3 Range 2 to 12.
points MeshWarpPointsItem[] —

NoiseGenerator

import { NoiseGenerator } from "framefields/effects";

new NoiseGenerator({ noiseType: "Perlin", outputType: "Image", width: 512 });
Prop Type Default Notes
noiseType "Perlin" | "Simplex" | "Voronoi" "Perlin" Noise Type
outputType "Image" | "Video" "Image" Output Type
width number 512 Range 16 to 4096. Width
height number 512 Range 16 to 4096. Height
scale EffectProp<number> 10 Range 0.1 to 100. Scale of the noise pattern. Can be modulated by a static number or a dynamic signal.
octaves EffectProp<number> 4 Range 1 to 8. Fractal detail depth of the noise.
persistence EffectProp<number> 0.5 Range 0 to 1. Roughness multiplier for each fractal octave.
lacunarity EffectProp<number> 2 Range 1 to 4. Frequency spacing multiplier for each fractal octave.
speed EffectProp<number> 1 Range 0 to 10. Speed of time-based noise animation in Video mode.
colorStart string "#000000" Color Start
colorEnd string "#ffffff" Color End
durationMs number 5000 Range 1 to 60000. Duration (ms)
fps number 30 Range 1 to 120. FPS

OpArt

import { OpArt } from "framefields/effects";

new OpArt({ pattern: "stripes", frequency: 48, angle: 0 });
Prop Type Default Notes
pattern "stripes" | "rings" | "checker" | "waves" "stripes" Line pattern.
frequency EffectProp<number> 48 Range 2 to 300. Lines across the height.
angle EffectProp<number> 0 Range -360 to 360. Pattern angle, degrees.
warp EffectProp<number> 0.6 Range 0 to 3. How far brightness bends the lines.
source EffectProp<number> 1 Range 0 to 1. How much darks thicken the lines (0 = even lines).
colorA string "#0a0a0a" Line color.
colorB string "#f5f5f5" Gap color.

Paint

import { Paint } from "framefields/effects";

new Paint({ width: 1080, height: 1080, maintainAspect: true });
Prop Type Default Notes
width number 1080 Range 1 to 16384.
height number 1080 Range 1 to 16384.
maintainAspect boolean true
aspectRatio number —
backgroundColor string "#ffffff"
strokes (PaintStrokesItemOption1 | PaintStrokesItemOption2 | PaintStrokesItemOption3)[] —

Painterly

import { Painterly } from "framefields/effects";

new Painterly({ style: "oil", radius: 5, edgeDarkening: 0.5 });
Prop Type Default Notes
style "oil" | "watercolor" "oil" Oil (dense strokes) or watercolor (wet edges, paper).
radius EffectProp<number> 5 Range 2 to 12. Brush size, px.
edgeDarkening EffectProp<number> 0.5 Range 0 to 1. Watercolor: pigment pooling at patch edges.
paper EffectProp<number> 0.3 Range 0 to 1. Paper / canvas grain.
saturation EffectProp<number> 1.05 Range 0 to 2. Color saturation.

PatchHeal

import { PatchHeal } from "framefields/effects";

new PatchHeal({ centerX: 0.5, centerY: 0.5, offsetX: 50 });
Prop Type Default Notes
patches PatchHealPatchesItem[] — List of patch healing operations applied sequentially.
centerX EffectProp<number> 0.5 Range 0 to 1. Horizontal normalized position of destination patch (0.0 to 1.0).
centerY EffectProp<number> 0.5 Range 0 to 1. Vertical normalized position of destination patch (0.0 to 1.0).
offsetX EffectProp<number> 50 Range -4096 to 4096. Horizontal pixel distance from destination to sample source patch.
offsetY EffectProp<number> 0 Range -4096 to 4096. Vertical pixel distance from destination to sample source patch.
radius EffectProp<number> 25 Range 1 to 500. Radius of the destination circular patch in pixels (used when no explicit Mask input is connected).
sourceRadius EffectProp<number> 25 Range 1 to 500. Radius of the source sample circular patch in pixels.
feather EffectProp<number> 50 Range 0 to 100. Softness edge falloff percentage (0–100%).
opacity EffectProp<number> 1 Range 0 to 1. Blending opacity of the healed patch (0.0–1.0).
mode "Clone" | "SeamlessHeal" | "TextureTransfer" "SeamlessHeal" Healing algorithm: Clone (direct stamp), SeamlessHeal (Poisson color/lighting blend), TextureTransfer (luminance structure matching).

Pixelate

import { Pixelate } from "framefields/effects";

new Pixelate({ size: 12, shape: "square", gap: 0 });
Prop Type Default Notes
size EffectProp<number> 12 Range 1 to 256. Cell size, px.
shape "square" | "circle" | "diamond" "square" Cell shape: square pixels, round LEDs or diamonds.
gap EffectProp<number> 0 Range 0 to 0.9. Space between cells, as a fraction of a cell (0 = touching).

Posterize

import { Posterize } from "framefields/effects";

new Posterize({ levels: 6, palette: "none", dither: 0 });
Prop Type Default Notes
levels EffectProp<number> 6 Range 2 to 64. Steps per channel when no palette is set.
palette "none" | "gameboy" | "teletext" | "cga" | "pico8" | "c64" | "grayscale" | "sepia" | "custom" "none" Snap to a retro palette, or custom to use colors.
colors string[] [] Your palette (up to 16 hex colors), used when palette is custom.
dither EffectProp<number> 0 Range 0 to 1. Ordered (Bayer) dithering between steps, 0–1.
pixelSize EffectProp<number> 1 Range 1 to 64. Pixel size, px: above 1 for pixel art.

ProceduralVFX

import { ProceduralVFX } from "framefields/effects";

new ProceduralVFX({ effectType: "Smoke", outputType: "Video", width: 1080 });
Prop Type Default Notes
effectType "Smoke" | "Fire" | "Rain" | "Sparks" | "Snow" | "Dust" | "Lightning" | "Magic" | "LensFlare" | "Embers" | "EnergyBeam" | "Aurora" "Smoke" Which procedural particle / light effect to synthesize.
outputType "Image" | "Video" "Video" Image renders a static frame; Video animates over time.
width number 1080 Range 16 to 4096. Width
height number 1080 Range 16 to 4096. Height
density EffectProp<number> 0.6 Range 0 to 1. Amount of particles / coverage of the effect. Can be modulated by a static number or dynamic signal.
scale EffectProp<number> 0.01 Range 0.001 to 10. Spatial frequency / particle size of the effect. Can be modulated by a signal.
speed EffectProp<number> 1 Range 0 to 10. Animation speed in Video mode. Can be modulated by a signal.
intensity EffectProp<number> 0.8 Range 0 to 1. Brightness / alpha gain of the effect. Can be modulated by a signal.
seed EffectProp<number> 1234 Range 0 to 1000000. Deterministic shuffle of the random pattern. Can be modulated by a signal.
colorStart string "#ffffff" Color Start
colorEnd string "#ff5500" Color End
durationMs number 5000 Range 100 to 100000. Duration (ms)
fps number 30 Range 1 to 120. FPS

RefineEdge

import { RefineEdge } from "framefields/effects";

new RefineEdge({ decontaminateAmount: 0.7, radius: 2, smooth: 5 });
Prop Type Default Notes
decontaminateAmount EffectProp<number> 0.7 Range 0 to 1. Amount of edge color spill decontamination/defringing (0.0–1.0).
radius EffectProp<number> 2 Range 0.5 to 50. Radius in pixels around alpha transitions to refine and decontaminate.
smooth EffectProp<number> 5 Range 0 to 100. Matte edge smoothing curve intensity (0–100).
feather EffectProp<number> 0.5 Range 0 to 50. Sub-pixel gaussian softness along the matte boundary.
shiftEdge EffectProp<number> 0 Range -100 to 100. Contract (<0) or expand (>0) the edge boundary (-100% to +100%).
matteChannel "Alpha" | "Luminance" | "Red" | "Green" | "Blue" "Alpha" Channel to extract matte from (Alpha, Luminance, Red, Green, Blue).
outputMode "Composite" | "MatteOnly" | "DecontaminatedRGB" "Composite" Composite (decontaminated RGB + refined alpha), MatteOnly (grayscale mask), DecontaminatedRGB (clean RGB with full alpha).

RefractionCaustics3D

import { RefractionCaustics3D } from "framefields/effects";

new RefractionCaustics3D({ ior: 1.52, dispersion: 0.04, refractionScale: 0.5 });
Prop Type Default Notes
ior EffectProp<number> 1.52 Range 1 to 2.5. Index of Refraction (1.0=Air, 1.33=Water, 1.52=Crown Glass, 2.42=Diamond). Controls ray bending according to Snell's Law.
dispersion EffectProp<number> 0.04 Range 0 to 0.2. Chromatic dispersion (RGB wavelength splitting) creating prismatic rainbow fringing.
refractionScale EffectProp<number> 0.5 Range 0 to 2. Depth displacement scale and effective glass thickness factor.
causticBrightness EffectProp<number> 0.6 Range 0 to 2. Brightness multiplier for photometric caustic light rays focusing through curved glass.
causticScale EffectProp<number> 1 Range 0.1 to 5. Spatial frequency scale of photometric caustic patterns.
fluidRipples EffectProp<number> 0 Range 0 to 1. Dynamic liquid wave perturbation strength across the refractive surface.
rippleSpeed EffectProp<number> 1 Range 0 to 5. Speed of dynamic fluid wave animation.
roughness EffectProp<number> 0 Range 0 to 1. Microfacet frosted glass roughness and optical diffusion blur.
specularIntensity EffectProp<number> 0.8 Range 0 to 2. Fresnel specular reflection gleam intensity.
lightPosX EffectProp<number> 0.5 Range 0 to 1. Horizontal normalized coordinate (0.0 to 1.0) of incident light source.
lightPosY EffectProp<number> 0.2 Range 0 to 1. Vertical normalized coordinate (0.0 to 1.0) of incident light source.
tintColor string "#ffffff" Internal glass color tint and absorption.
tintStrength EffectProp<number> 0 Range 0 to 1. Strength of internal glass color tint absorption.
depthInvert boolean false Invert depth polarity (white = near vs black = near).
depthScale EffectProp<number> 1 Range 0.1 to 5. Height-field surface normal extrusion exaggeration.

ResizerScaler

import { ResizerScaler } from "framefields/effects";

new ResizerScaler({ aspectRatioPreset: "16:9", resolutionPreset: "1080p", targetWidth: 1920 });
Prop Type Default Notes
aspectRatioPreset "9:16" | "16:9" | "1:1" | "4:5" | "21:9" | "custom" "16:9"
resolutionPreset "4k" | "1080p" | "720p" | "480p" | "custom" "1080p"
targetWidth number 1920 Range 1 to 8192.
targetHeight number 1080 Range 1 to 8192.
fitMode "cover" | "contain" | "stretch" | "manual" "contain"
zoom number 100 Range 1 to 1000.
offsetX number 0 Range -8192 to 8192.
offsetY number 0 Range -8192 to 8192.
backgroundMode "solid" | "blurred" | "gradient" | "transparent" "solid"
backgroundColor string "#000000FF"
backgroundColor2 string "#000000FF"
blurRadius number 40 Range 0 to 100.
backgroundBrightness number 0.6 Range 0 to 1.
anchorX "left" | "center" | "right" "center"
anchorY "top" | "center" | "bottom" "center"

RGBSplit

import { RGBSplit } from "framefields/effects";

new RGBSplit({ amount: 8, angle: 0, radial: false });
Prop Type Default Notes
amount EffectProp<number> 8 Range 0 to 200. Split distance, px.
angle EffectProp<number> 0 Range -360 to 360. Split direction, degrees (linear mode).
radial boolean false Split outward from the center instead of along angle.

Rotate

import { Rotate } from "framefields/effects";

new Rotate({ angle: 90, fit: "cover", scale: 1 });
Prop Type Default Notes
angle EffectProp<number> 90 Rotation in degrees about the frame center, clockwise. Any value; 90 / 180 / 270 fix footage shot sideways or upside down.
fit "cover" | "contain" | "fill" "cover" How the rotated source sits in the output: cover fills it (cropping the overhang), contain shows all of it (transparent margins), fill keeps the unrotated source stretched to the output and only turns it.
scale EffectProp<number> 1 Range 0.01 to 20. Extra zoom applied after the fit (1 = exactly fitted).

StereoPanning

import { StereoPanning } from "framefields/effects";

new StereoPanning({ pan: 0 });
Prop Type Default Notes
pan EffectProp<number> 0 Range -1 to 1. Stereo panning value: -1 (full left) to 1 (full right), 0 is center. Can be modulated by a static number or dynamic signal.

Toon

import { Toon } from "framefields/effects";

new Toon({ levels: 4, edgeThreshold: 0.2, edgeWidth: 1 });
Prop Type Default Notes
levels EffectProp<number> 4 Range 2 to 12. Brightness bands.
edgeThreshold EffectProp<number> 0.2 Range 0 to 1. How strong an edge must be to get ink, 0–1.
edgeWidth EffectProp<number> 1 Range 0.5 to 4. Ink line width, px.
edgeColor string "#111111" Ink color.
saturation EffectProp<number> 1.15 Range 0 to 2. Color saturation after banding.

Trails

import { Trails } from "framefields/effects";

new Trails({ decay: 0.9, mode: "blend", zoom: 1 });
Prop Type Default Notes
decay EffectProp<number> 0.9 Range 0 to 1. History kept per frame, 0–1: 0.8 short echoes, 0.97 long light trails.
mode "blend" | "over" | "add" | "max" "blend" blend: running average (echoes on full-frame footage); over: the layer over its fading past (cutouts, text); add: glows build up (light painting); max: keeps the brightest.
zoom EffectProp<number> 1 Range 0.5 to 2. History scale per frame; 1.02 pulls the past into a tunnel.
rotation EffectProp<number> 0 Range -45 to 45. History rotation per frame, degrees.
offsetX EffectProp<number> 0 Range -500 to 500. History drift per frame, px.
offsetY EffectProp<number> 0 Range -500 to 500. History drift per frame, px.
hueShift EffectProp<number> 0 Range -180 to 180. History hue rotation per frame, degrees (psychedelic cycling).
warmup number 60 Range 0 to 240. Most frames replayed to rebuild the history after a jump (scrubbing, a single frame render).

Vignette

import { Vignette } from "framefields/effects";

new Vignette({ strength: 50, radius: 1, softness: 0.5 });
Prop Type Default Notes
strength EffectProp<number> 50 Range 0 to 100. The intensity of the vignette darkening effect. 0 = no vignette.
radius EffectProp<number> 1 Range 0.1 to 2. The extent/size of the vignette.
softness EffectProp<number> 0.5 Range 0 to 1. The softness of the vignette transition edge.
roundness EffectProp<number> 0.5 Range 0 to 1. 0.0 matches the image aspect ratio, 1.0 is a perfect circle.
centerX EffectProp<number> 0.5 Range 0 to 1. The X coordinate of the vignette center.
centerY EffectProp<number> 0.5 Range 0 to 1. The Y coordinate of the vignette center.

Levels

import { Levels } from "framefields/effects";

new Levels({ /* props */ });
Prop Type Default
master LevelChannel { ...defaultChannel }
red LevelChannel { ...defaultChannel }
green LevelChannel { ...defaultChannel }
blue LevelChannel { ...defaultChannel }

FilmGrain

import { FilmGrain } from "framefields/effects";

new FilmGrain({ strength: 15, size: 1.5, monochrome: true });
Prop Type Default
strength EffectProp<number> 15
size EffectProp<number> 1.5
monochrome boolean true
animated boolean true
speed EffectProp<number> 50
shadows EffectProp<number> 0.2
midtones EffectProp<number> 1.0
highlights EffectProp<number> 0.2

AudioSignalExtractor

import { AudioSignalExtractor } from "framefields/effects";

new AudioSignalExtractor({ extractionMode: "rms_envelope", attackMs: 10, releaseMs: 120 });
Prop Type Default
extractionMode | "rms_envelope" | "transient_beat" | "sub_bass" | "bass" | "mid" | "high" | "spectral_flux" "rms_envelope"
attackMs number 10
releaseMs number 120
sensitivity number 1.0
noiseFloorDb number -48
dynamicRangeDb number 48
autoRange boolean true
smoothing number 0.15
curve "linear" | "exponential" | "logarithmic" | "square" | "smoothstep" "linear"
beatThreshold number 0.08
beatDecayMs number 80
previewMode "waveform" | "envelope" | "beat_markers" | "spectrum" "envelope"
nodeId string "audio_extractor"

Curves

import { Curves } from "framefields/effects";

new Curves({ curveType: "rgb" });
Prop Type Default
curveType "rgb" | "hue-vs-hue" | "hue-vs-sat" | "lum-vs-sat" | "sat-vs-sat" "rgb"
master CurvesChannelPoint[] —
red CurvesChannelPoint[] —
green CurvesChannelPoint[] —
blue CurvesChannelPoint[] —
hueVsHue CurvesChannelPoint[] —
hueVsSat CurvesChannelPoint[] —
lumVsSat CurvesChannelPoint[] —
satVsSat CurvesChannelPoint[] —

SelectiveColor

import { SelectiveColor } from "framefields/effects";

new SelectiveColor({ method: "Relative" });
Prop Type Default
method "Relative" | "Absolute" "Relative"
reds Partial<SelectiveColorAdjustment> —
yellows Partial<SelectiveColorAdjustment> —
greens Partial<SelectiveColorAdjustment> —
cyans Partial<SelectiveColorAdjustment> —
blues Partial<SelectiveColorAdjustment> —
magentas Partial<SelectiveColorAdjustment> —
whites Partial<SelectiveColorAdjustment> —
neutrals Partial<SelectiveColorAdjustment> —
blacks Partial<SelectiveColorAdjustment> —

GradientMap

import { GradientMap } from "framefields/effects";

new GradientMap({ stops: defaultStops, smooth: true, dither: true });
Prop Type Default
stops GradientMapStop[] defaultStops
smooth boolean true
dither boolean true
opacity EffectProp<number> 1.0

ShadowsHighlights

import { ShadowsHighlights } from "framefields/effects";

new ShadowsHighlights({ shadowAmount: 0, shadowTonalWidth: 50, shadowRadius: 30 });
Prop Type Default
shadowAmount EffectProp<number> 0
shadowTonalWidth EffectProp<number> 50
shadowRadius EffectProp<number> 30
highlightAmount EffectProp<number> 0
highlightTonalWidth EffectProp<number> 50
highlightRadius EffectProp<number> 30
colorCorrection EffectProp<number> 0
midtoneContrast EffectProp<number> 0

ApplyLUT

import { ApplyLUT } from "framefields/effects";

new ApplyLUT({ lutUrl: "", intensity: 1.0 });
Prop Type Default
lutUrl string ""
intensity EffectProp<number> 1.0

UnsharpMask

import { UnsharpMask } from "framefields/effects";

new UnsharpMask({ amount: 100, radius: 1.5, threshold: 3 });
Prop Type Default
amount EffectProp<number> 100
radius EffectProp<number> 1.5
threshold EffectProp<number> 3

HighPass

import { HighPass } from "framefields/effects";

new HighPass({ radius: 3.0, contrastBoost: 1.0, monochrome: true });
Prop Type Default
radius EffectProp<number> 3.0
contrastBoost EffectProp<number> 1.0
monochrome boolean true

HalftoneScreen

import { HalftoneScreen } from "framefields/effects";

new HalftoneScreen({ mode: "Monochrome", dotShape: "Circle", frequency: 30 });
Prop Type Default
mode HalftoneMode "Monochrome"
dotShape HalftoneDotShape "Circle"
frequency EffectProp<number> 30
angle EffectProp<number> 45
contrast EffectProp<number> 1.0
dotColor string "#000000"
paperColor string "#ffffff"
smooth boolean true
invert boolean false
cyanAngle EffectProp<number> 15
magentaAngle EffectProp<number> 75
yellowAngle EffectProp<number> 0
blackAngle EffectProp<number> 45
opacity EffectProp<number> 1.0

TileOffset

import { TileOffset } from "framefields/effects";

new TileOffset({ offsetX: 0, offsetY: 0, wrap: true });
Prop Type Default
offsetX EffectProp<number> 0
offsetY EffectProp<number> 0
wrap boolean true
edgeMode TileOffsetEdgeMode "wrap"

MotionBlur

import { MotionBlur } from "framefields/effects";

new MotionBlur({ shutterAngle: 180, samples: 16, maxVelocity: 64 });
Prop Type Default
shutterAngle EffectProp<number> 180
samples EffectProp<number> 16
maxVelocity EffectProp<number> 64
shutterCurve "box" | "gaussian" | "triangle" "gaussian"
depthAware boolean true

SSAO

import { SSAO } from "framefields/effects";

new SSAO({ radius: 45, bias: 0.025, intensity: 1.5 });
Prop Type Default
radius EffectProp<number> 45
bias EffectProp<number> 0.025
intensity EffectProp<number> 1.5
kernelSamples EffectProp<number> 16
blurRadius EffectProp<number> 4

PBRGlass

import { PBRGlass } from "framefields/effects";

new PBRGlass({ ior: 1.49, roughness: 0.15, transmission: 0.92 });
Prop Type Default
ior EffectProp<number> 1.49
roughness EffectProp<number> 0.15
transmission EffectProp<number> 0.92
dispersion EffectProp<number> 0.015
fresnelPower EffectProp<number> 5.0
tintColor EffectProp<string> "#ffffff"

DepthOfField

import { DepthOfField } from "framefields/effects";

new DepthOfField({ focusDistance: 500, focalLength: 50, aperture: 2.8 });
Prop Type Default
focusDistance EffectProp<number> 500
focalLength EffectProp<number> 50
aperture EffectProp<number> 2.8
maxBlur EffectProp<number> 16
quality "low" | "medium" | "high" | "ultra" "high"

Crop

import { Crop } from "framefields/effects";

new Crop({ cropType: "rect", leftPercentage: 0, topPercentage: 0 });
Prop Type Default
cropType "rect" | "path" "rect"
leftPercentage EffectProp<number> 0
topPercentage EffectProp<number> 0
widthPercentage EffectProp<number> 100
heightPercentage EffectProp<number> 100
roundness EffectProp<number> 0
pathPoints { x: number; y: number }[] —
mode "cropped" | "rest" —

Vision

import { Vision } from "framefields/effects";

new Vision({ confidence: 0.3, variant: "s", mode: "passthrough" });
Prop Type Default
enableDetection boolean —
enableSegmentation boolean —
enablePose boolean —
enableMatte boolean —
classes readonly string[] —
confidence number 0.3
variant "t" | "s" | "m" "s"
mode | "passthrough" | "mask" | "matte" | "crop" | "skeleton" | "boxes" | "tracking" | "depth" "passthrough"
matteSource "instance" | "selfie" "instance"
maxMissedFrames number —
modelsDir string —
baseUrl string —
maskThreshold number —
featherRadius number —
keyBackground boolean —
backgroundKeyThreshold number —
visionBundle unknown —

Relight3D

import { Relight3D } from "framefields/effects";

new Relight3D({ lightType: "Point", intensity: 1.0, lightPosX: 0.5 });
Prop Type Default
lightType "Point" | "Spot" | "Directional" | "Rim" "Point"
intensity EffectProp<number> 1.0
lightPosX EffectProp<number> 0.5
lightPosY EffectProp<number> 0.5
lightPosZ EffectProp<number> 0.3
lightRadius EffectProp<number> 0.8
spotConeAngle EffectProp<number> 45
specularRoughness EffectProp<number> 0.35
specularStrength EffectProp<number> 0.7
metallic EffectProp<number> 0.0
ambientIntensity EffectProp<number> 0.4
volumetricDensity EffectProp<number> 0.2
depthScale EffectProp<number> 1.0
depthInvert boolean false
lightColor string "#ffffff"
ambientColor string "#ffffff"
normalMap unknown —

TemporalDeflicker

import { TemporalDeflicker } from "framefields/effects";

new TemporalDeflicker({ blendWeight: 0.35, disocclusionThreshold: 0.15, maxMotionPixels: 64.0 });
Prop Type Default
blendWeight EffectProp<number> 0.35
disocclusionThreshold EffectProp<number> 0.15
maxMotionPixels EffectProp<number> 64.0
scale number 0.5
windowSize number 2

Modulate

import { Modulate } from "framefields/effects";

new Modulate({ hue: 0, brightness: 1.0, contrast: 1.0 });
Prop Type Default
hue EffectProp<number> 0
brightness EffectProp<number> 1.0
contrast EffectProp<number> 1.0
exposure EffectProp<number> 0.0
saturation EffectProp<number> 1.0
sepia EffectProp<number> 0.0

Node packages

Beyond these classes, the engine ships node plugins under nodes/ (audio DSP, generators, signal maths, vision). Each is a package named @framefields/node-<name>:

node-apply-lut, node-ascii, node-audio-compressor, node-audio-delay, node-audio-fade, node-audio-noise-gate, node-audio-parametric-eq, node-audio-reverb, node-audio-signal-extractor, node-blur, node-camera-parallax-3d, node-canvas-generator, node-caption-editor, node-caption-generator, node-channel-merger, node-channel-splitter, node-color-balance, node-colorkey, node-compositor, node-contour, node-corner-pin, node-crop, node-crt, node-curves, node-datamosh, node-deflicker, node-displacement-map, node-dither, node-extract-frame, node-extract-lut, node-film-grain, node-flip, node-gooey, node-gradient-map, node-halftone-screen, node-high-pass, node-iridescence, node-kaleidoscope, node-kenburns, node-layer-style, node-levels, node-liquify, node-mask-math, node-mesh-warp, node-modulate, node-noise-generator, node-op-art, node-paint, node-painterly, node-particles, node-patch-heal, node-pixelate, node-posterize, node-procedural-vfx, node-refine-edge, node-refraction-caustics, node-relight-3d, node-resizer-scaler, node-rgb-split, node-rotate, node-selective-color, node-shadows-highlights, node-shape-generator, node-signal-gate, node-signal-math, node-signal, node-stereo-panning, node-text, node-tile-offset, node-toon, node-trails, node-unsharp-mask, node-vignette, node-vision