MotionScript

@motion-script/core


@motion-script/core / ColorAdjustmentEffect

Interface: ColorAdjustmentEffect

Defined in: attributes/shape/effects/implementations/color-adjustment.ts:15

Photographic tonal and colour adjustments as a scene effect — the grading panel ImageFilters.colorAdjustment gives an image fill, now available on any node. All fields are optional and default to neutral.

Shares its type name and renderer handler with ColorAdjustmentFilter (the media-fill filter) with one deliberate difference: no vignette field. That knob was never implemented on the filter — a vignette needs each pixel's position, which a colour matrix does not have — so the scene effect leaves it out and Effects.vignette() provides the real thing.

Extends

Properties

brightness?

optional brightness?: number

Defined in: attributes/shape/effects/implementations/color-adjustment.ts:18

−1…1 (0 = unchanged). Shifts overall lightness without clipping the way exposure does.


contrast?

optional contrast?: number

Defined in: attributes/shape/effects/implementations/color-adjustment.ts:20

0…2 (1 = unchanged). Spreads highlights and shadows further apart.


highlights?

optional highlights?: number

Defined in: attributes/shape/effects/implementations/color-adjustment.ts:37

−1…1 (0 = unchanged). Brightens or rolls off the highlight end.


hue?

optional hue?: number

Defined in: attributes/shape/effects/implementations/color-adjustment.ts:31

Hue rotation in degrees (0 = unchanged). Wraps, so a linear tween over 360 cycles the whole wheel and lands back where it started.

The luma-preserving rotation, so shifting hue does not also change how light anything reads — unlike invert({ channel: 'hue' }), which is the fixed 180° case of this and stays for symmetry with the other inversions.


mode?

optional mode?: EffectMode

Defined in: attributes/shape/effects/effect-data.ts:83

Inherited from

ModedEffect.mode


saturation?

optional saturation?: number

Defined in: attributes/shape/effects/implementations/color-adjustment.ts:22

0…3 (1 = unchanged). Scales colour saturation uniformly.


shadows?

optional shadows?: number

Defined in: attributes/shape/effects/implementations/color-adjustment.ts:35

−1…1 (0 = unchanged). Lifts or crushes the shadow end.


temperature?

optional temperature?: number

Defined in: attributes/shape/effects/implementations/color-adjustment.ts:39

−1…1 (0 = unchanged). Negative = cool/blue, positive = warm/orange.


tint?

optional tint?: number

Defined in: attributes/shape/effects/implementations/color-adjustment.ts:41

−1…1 (0 = unchanged). Negative = green, positive = magenta.


type

type: "colorAdjustment"

Defined in: attributes/shape/effects/implementations/color-adjustment.ts:16


vibrance?

optional vibrance?: number

Defined in: attributes/shape/effects/implementations/color-adjustment.ts:33

−1…1 (0 = unchanged). Boosts muted colours more than already-vivid ones.