Skip to main content
CESDK/CE.SDK/Engine/API Reference/Block

Effect Types

Get to know all available effect types and their properties

The following tables document the currently available effects and their properties.

Effects#

effect/adjustments#

MemberTypeDefaultDescription
Member
blacks
Type
float
Default
0.0
Description
Adjustment of only the blacks.
Member
brightness
Type
float
Default
0.0
Description
Adjustment of the brightness.
Member
clarity
Type
float
Default
0.0
Description
Adjustment of the detail.
Member
contrast
Type
float
Default
0.0
Description
Adjustment of the contrast, the difference in color and light between parts.
Member
exposure
Type
float
Default
0.0
Description
Adjustment of the exposure.
Member
gamma
Type
float
Default
0.0
Description
Gamma correction, non-linear.
Member
highlights
Type
float
Default
0.0
Description
Adjustment of only the highlights.
Member
saturation
Type
float
Default
0.0
Description
Adjustment of the saturation.
Member
shadows
Type
float
Default
0.0
Description
Adjustment of only the shadows.
Member
sharpness
Type
float
Default
0.0
Description
Adjustment of the sharpness.
Member
temperature
Type
float
Default
0.0
Description
Adjustment of the color temperature.
Member
whites
Type
float
Default
0.0
Description
Adjustment of only the whites.

effect/black_and_white_color_mixer#

MemberTypeDefaultDescription
Member
perceivedBrightnessAqua
Type
float
Default
0.
Description
Increases or decreases the perceived brightness on the aqua colors.
Member
perceivedBrightnessBlue
Type
float
Default
0.
Description
Increases or decreases the perceived brightness on the blue colors.
Member
perceivedBrightnessGreen
Type
float
Default
0.
Description
Increases or decreases the perceived brightness on the green colors.
Member
perceivedBrightnessMagenta
Type
float
Default
0.
Description
Increases or decreases the perceived brightness on the magenta colors.
Member
perceivedBrightnessOrange
Type
float
Default
0.
Description
Increases or decreases the perceived brightness on the orange colors.
Member
perceivedBrightnessPurple
Type
float
Default
0.
Description
Increases or decreases the perceived brightness on the purple colors.
Member
perceivedBrightnessRed
Type
float
Default
0.
Description
Increases or decreases the perceived brightness on the red colors.
Member
perceivedBrightnessYellow
Type
float
Default
0.
Description
Increases or decreases the perceived brightness on the yellow colors.

effect/cross_cut#

Distorts the image with horizontal slices.

MemberTypeDefaultDescription
Member
offset
Type
float
Default
0.07
Description
Horizontal offset per slice.
Member
slices
Type
float
Default
5.0
Description
Number of horizontal slices.
Member
speedV
Type
float
Default
0.5
Description
Vertical slice position.
Member
time
Type
float
Default
1.0
Description
Randomness input.

effect/dot_pattern#

Displays image using a dot matrix.

MemberTypeDefaultDescription
Member
blur
Type
float
Default
0.3
Description
Global blur.
Member
dots
Type
float
Default
30.
Description
Number of dots.
Member
size
Type
float
Default
0.5
Description
Size of an individual dot.

effect/duotone_filter#

MemberTypeDefaultDescription
Member
darkColor
Type
Color
Default
{}
Description
The darker of the two colors. Negative filter intensities emphasize this color.
Member
intensity
Type
float
Default
0.0
Description
The mixing weight of the two colors in the range [-1, 1].
Member
lightColor
Type
Color
Default
{}
Description
The brighter of the two colors. Positive filter intensities emphasize this color.

effect/extrude_blur#

Applies radial blur.

MemberTypeDefaultDescription
Member
amount
Type
float
Default
0.2
Description
Blur intensity.
Member
time
Type
float
Default
0.5
Description
Continuous randomness input.

effect/glow#

Applies artificial glow.

MemberTypeDefaultDescription
Member
amount
Type
float
Default
0.5
Description
Glow brightness.
Member
darkness
Type
float
Default
0.3
Description
Glow darkness.
Member
size
Type
float
Default
4.0
Description
Intensity.

effect/green_screen#

Replaces a color with transparency.

MemberTypeDefaultDescription
Member
colorMatch
Type
float
Default
0.4
Description
Threshold between the source color and the from color. Below this threshold, the pixel is made transparent. [0, 1]
Member
fromColor
Type
Color
Default
createRGBColor(0., 1., 0., 1.)
Description
The color to be replaced. The alpha channel will be ignored.
Member
smoothness
Type
float
Default
0.08
Description
Controls the rate at which the color transition increases when similarity threshold is exceeded. [0, 1]
Member
spill
Type
float
Default
0.0
Description
Controls the desaturation of the source color. This turns the green spill on the subject to gray, making it less jarring. [0, 1]

effect/half_tone#

Overlays halftone pattern.

MemberTypeDefaultDescription
Member
angle
Type
float
Default
0.0
Description
Angle of pattern.
Member
scale
Type
float
Default
0.5
Description
Scale of pattern.

effect/hsp_selective_adjustments#

MemberTypeDefaultDescription
Member
hueAqua
Type
float
Default
0.0
Description
Selective hue adjustment applied on the aqua colors.
Member
hueBlue
Type
float
Default
0.0
Description
Selective hue adjustment applied on the blue colors.
Member
hueGreen
Type
float
Default
0.0
Description
Selective hue adjustment applied on the green colors.
Member
hueMagenta
Type
float
Default
0.0
Description
Selective hue adjustment applied on the magenta colors.
Member
hueOrange
Type
float
Default
0.0
Description
Selective hue adjustment applied on the orange colors.
Member
huePurple
Type
float
Default
0.0
Description
Selective hue adjustment applied on the purple colors.
Member
hueRed
Type
float
Default
0.0
Description
Selective hue adjustment applied on the red colors.
Member
hueYellow
Type
float
Default
0.0
Description
Selective hue adjustment applied on the yellow colors.
Member
perceivedBrightnessAqua
Type
float
Default
0.0
Description
Selective perceived brightness adjustment applied on the aqua colors.
Member
perceivedBrightnessBlue
Type
float
Default
0.0
Description
Selective perceived brightness adjustment applied on the blue colors.
Member
perceivedBrightnessGreen
Type
float
Default
0.0
Description
Selective perceived brightness adjustment applied on the green colors.
Member
perceivedBrightnessMagenta
Type
float
Default
0.0
Description
Selective perceived brightness adjustment applied on the magenta colors.
Member
perceivedBrightnessOrange
Type
float
Default
0.0
Description
Selective perceived brightness adjustment applied on the yellow colors.
Member
perceivedBrightnessPurple
Type
float
Default
0.0
Description
Selective perceived brightness adjustment applied on the purple colors.
Member
perceivedBrightnessRed
Type
float
Default
0.0
Description
Selective perceived brightness adjustment applied on the red colors.
Member
perceivedBrightnessYellow
Type
float
Default
0.0
Description
Selective perceived brightness adjustment applied on the orange colors.
Member
saturationAqua
Type
float
Default
0.0
Description
Selective saturation adjustment applied on the aqua colors.
Member
saturationBlue
Type
float
Default
0.0
Description
Selective saturation adjustment applied on the blue colors.
Member
saturationGreen
Type
float
Default
0.0
Description
Selective saturation adjustment applied on the green colors.
Member
saturationMagenta
Type
float
Default
0.0
Description
Selective saturation adjustment applied on the magenta colors.
Member
saturationOrange
Type
float
Default
0.0
Description
Selective saturation adjustment applied on the orange colors.
Member
saturationPurple
Type
float
Default
0.0
Description
Selective saturation adjustment applied on the purple colors.
Member
saturationRed
Type
float
Default
0.0
Description
Selective saturation adjustment applied on the red colors.
Member
saturationYellow
Type
float
Default
0.0
Description
Selective saturation adjustment applied on the yellow colors.

effect/linocut#

Overlays linocut pattern.

MemberTypeDefaultDescription
Member
scale
Type
float
Default
0.5
Description
Scale of pattern.

effect/liquid#

Applies a liquefy effect.

MemberTypeDefaultDescription
Member
amount
Type
float
Default
0.06
Description
Severity of the applied effect.
Member
scale
Type
float
Default
0.62
Description
Global scale.
Member
speed
Type
float
Default
0.08
Description
Number of changes per time change.
Member
time
Type
float
Default
0.5
Description
Continuous randomness input.

effect/lut_filter#

MemberTypeDefaultDescription
Member
horizontalTileCount
Type
int
Default
5
Description
The horizontal number of tiles contained in the LUT image.
Member
intensity
Type
float
Default
1.0
Description
A value in the range of [0, 1]. Defaults to 1.0.
Member
lutFileURI
Type
string
Default
""
Description
The URI to a LUT PNG file.
Member
verticalTileCount
Type
int
Default
5
Description
The vertical number of tiles contained in the LUT image.

effect/mask_color#

MemberTypeDefaultDescription
Member
maskColor
Type
Color
Default
createWhite()
Description
All pixel that match this color will be treated as mask pixels.
Member
maskMultiplier
Type
Color
Default
createWhite()
Description
Color multiplier for pixels that match the maskColor.
Member
notMaskMultiplier
Type
Color
Default
createWhite()
Description
Color multiplier for pixels that don't match the maskColor.
Member
replaceInsteadMultiply
Type
vec2
Default
{}
Description
Blend factors between x: (maskColor * maskMultiplier) <-> (maskMultiplier) for pixels matching maskColor y: (pixelColor * notMaskMultiplier) <-> (notMaskMultiplier) for pixels not matching maskColor

effect/mirror#

Mirrors image along center.

MemberTypeDefaultDescription
Member
side
Type
int
Default
1
Description
Axis to mirror along.

effect/outliner#

Highlights outlines.

MemberTypeDefaultDescription
Member
amount
Type
float
Default
0.5
Description
Intensity of edge highlighting.
Member
passthrough
Type
float
Default
0.5
Description
Visibility of input image in non-edge areas.

effect/pixelize#

Reduces the image to individual pixels.

MemberTypeDefaultDescription
Member
horizontalPixelSize
Type
int
Default
20
Description
The number of pixels on the x-axis.
Member
verticalPixelSize
Type
int
Default
20
Description
The number of pixels on the y-axis.

effect/posterize#

Displays image in reduced set of color levels.

MemberTypeDefaultDescription
Member
levels
Type
float
Default
3.
Description
Number of levels.

effect/radial_pixel#

Reduces the image into radial pixel rows.

MemberTypeDefaultDescription
Member
radius
Type
float
Default
0.1
Description
Radius of an individual row of pixels, relative to the image.
Member
segments
Type
float
Default
0.01
Description
Proportional size of a pixel in each row.

effect/recolor#

Replaces a color with another color.

MemberTypeDefaultDescription
Member
brightnessMatch
Type
float
Default
1.0
Description
Affects the weight of the brightness when calculating the similarity between source color and from color. This can be useful when recoloring to reach pixels of the same hue and saturation but that are much brighter or darker. [0, 1]
Member
colorMatch
Type
float
Default
0.4
Description
Threshold between the source color and the from color. Below this threshold, the pixel is recolored. [0, 1]
Member
fromColor
Type
Color
Default
createRGBColor(1., 1., 1., 1.)
Description
The color to be replaced. The alpha channel will be ignored.
Member
smoothness
Type
float
Default
0.08
Description
Controls the rate at which the color transition increases when similarity threshold is exceeded. [0, 1]
Member
toColor
Type
Color
Default
createRGBColor(0., 0., 1., 1.)
Description
The color to replace with.

effect/sharpie#

Cartoon-like effect.

No block-specific properties.

effect/shifter#

Shifts individual color channels.

MemberTypeDefaultDescription
Member
amount
Type
float
Default
0.05
Description
Intensity.
Member
angle
Type
float
Default
0.3
Description
Shift direction.

effect/tilt_shift#

Applies tilt shift effect.

MemberTypeDefaultDescription
Member
amount
Type
float
Default
0.016
Description
Blur intensity.
Member
position
Type
float
Default
0.4
Description
Horizontal position in image.

effect/tv_glitch#

Mimics TV banding.

MemberTypeDefaultDescription
Member
distortion
Type
float
Default
3.0
Description
Rough horizontal distortion.
Member
distortion2
Type
float
Default
1.0
Description
Fine horizontal distortion.
Member
rollSpeed
Type
float
Default
1.0
Description
Vertical offset.
Member
speed
Type
float
Default
2.0
Description
Number of changes per time change.
Member
time
Type
float
Default
0.5
Description
Continuous randomness input.

effect/vignette#

Adds a vignette.

MemberTypeDefaultDescription
Member
darkness
Type
float
Default
1.0
Description
Brightness of vignette.
Member
offset
Type
float
Default
1.
Description
Radial offset.