Cinematic effects (effects)

The effects bag hosts lightweight screen-space treatments rendered after the bitmap pixels land (still before stroke on bitmap layers).

Shape layers (source as ShapeType) do not execute this effects block — bake glow/grain into textures or duplicate as an underlying bitmap layer.

#Shape of effects

1effects?: {2  vignette?: { intensity: number; size: number };3  lensFlare?: { x: number; y: number; intensity: number };4  chromaticAberration?: { intensity: number };5  filmGrain?: { intensity: number };6};

You may combine keys — each helper operates sequentially inside one save/restore pair.

#vignette

Darkens edges toward transparency while preserving the centre.

#lensFlare

Adds a directional glare originating near x, y relative to the layer box origin (box.x + x, box.y + y).

#chromaticAberration

Splits colour channels slightly for a prism fringe look.

Uses an internal ImageData copy buffer — slightly heavier than vignette alone.

#filmGrain

Adds animated-feeling monochrome grain via ImageData manipulation.

#Example — stacked mood grade

1await painter.createImage(2  {3    source: './scene.jpg',4    x: 0,5    y: 0,6    width: 960,7    height: 540,8    fit: 'cover',9    effects: {10      vignette: { intensity: 0.45, size: 220 },11      chromaticAberration: { intensity: 1.4 },12      filmGrain: { intensity: 0.12 },13      lensFlare: { x: 720, y: 80, intensity: 0.35 },14    },15    stroke: { color: '#ffffff22', width: 2 },16  },17  buffer18);

#Known limitation

When filterOrder: 'pre', distortion, or meshWarp triggers an early return, effects never execute on that bitmap layer.