Skip to main content

Filter Layer Configuration

setFilterLayerConfig()

Set all filter properties on a filter layer at once.
id
number
required
Filter layer ID
config
FilterConfig
required
const filterId = comp.addFilterLayer({ name: 'adjustments' });
comp.setFilterLayerConfig(filterId, {
  hueDeg: 30,
  saturation: 0.2,
  brightness: 0.1,
  contrast: 0.15
});
You can also update filter config via updateLayer():
comp.updateLayer(filterId, {
  filterConfig: {
    hueDeg: 45,
    saturation: 0.3
  }
});

Destructive Filters

These methods permanently modify a layer’s pixel data.

invertLayer()

Invert RGB channels.
id
number
required
Layer ID
comp.invertLayer(layerId);

posterizeLayer()

Reduce color levels per channel.
id
number
required
Layer ID
levels
number
required
Number of levels per channel
Alternatively, pass an options object:
options
PosterizeOptions
comp.posterizeLayer(layerId, 4);
// or
comp.posterizeLayer(layerId, { levels: 4 });

thresholdLayer()

Convert to black/white based on luminance threshold.
id
number
required
Layer ID
threshold
number
required
Threshold value (0-1)
Alternatively, pass an options object:
options
ThresholdOptions
comp.thresholdLayer(layerId, 0.5);
// or
comp.thresholdLayer(layerId, { threshold: 0.5 });

levelsLayer()

Apply levels adjustment.
id
number
required
Layer ID
shadows
number
required
Input shadow point (0-1)
midtones
number
required
Gamma correction for midtones
highlights
number
required
Input highlight point (0-1)
Alternatively, pass an options object:
options
LevelsOptions
comp.levelsLayer(layerId, 0, 1, 1);
// or
comp.levelsLayer(layerId, {
  shadows: 0,
  midtones: 1,
  highlights: 1
});

gradientMapLayer()

Map luminance to a gradient.
id
number
required
Layer ID
stops
GradientStop[]
required
Array of gradient stops with position (0-1) and color
Alternatively, pass an options object:
options
{ stops: GradientStop[] }
comp.gradientMapLayer(layerId, [
  { position: 0, color: [0, 0, 0, 255] },
  { position: 1, color: [255, 255, 255, 255] }
]);
// or
comp.gradientMapLayer(layerId, {
  stops: [
    { position: 0, color: [0, 0, 0, 255] },
    { position: 1, color: [255, 255, 255, 255] }
  ]
});

Blur Filters

boxBlurLayer()

Apply box blur.
id
number
required
Layer ID
radius
number
required
Blur radius in pixels
Alternatively, pass an options object:
options
RadiusOptions
comp.boxBlurLayer(layerId, 5);
// or
comp.boxBlurLayer(layerId, { radius: 5 });

gaussianBlurLayer()

Apply Gaussian blur (higher quality than box blur).
id
number
required
Layer ID
radius
number
required
Blur radius in pixels
Alternatively, pass an options object:
options
RadiusOptions
comp.gaussianBlurLayer(layerId, 10);
// or
comp.gaussianBlurLayer(layerId, { radius: 10 });

Convolution Filters

sharpenLayer()

Apply sharpen convolution.
id
number
required
Layer ID
comp.sharpenLayer(layerId);

edgeDetectLayer()

Apply Laplacian edge detection.
id
number
required
Layer ID
comp.edgeDetectLayer(layerId);

embossLayer()

Apply emboss effect.
id
number
required
Layer ID
comp.embossLayer(layerId);

Build docs developers (and LLMs) love