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#
effect/adjustments#| Member | Type | Default | Description |
|---|---|---|---|
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#
effect/black_and_white_color_mixer#| Member | Type | Default | Description |
|---|---|---|---|
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#
effect/cross_cut#Distorts the image with horizontal slices.
| Member | Type | Default | Description |
|---|---|---|---|
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#
effect/dot_pattern#Displays image using a dot matrix.
| Member | Type | Default | Description |
|---|---|---|---|
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#
effect/duotone_filter#| Member | Type | Default | Description |
|---|---|---|---|
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. |
Member uri | Type string | Default "" | Description The URI to the registered DuoToneAsset. |
effect/extrude_blur#
effect/extrude_blur#Applies radial blur.
| Member | Type | Default | Description |
|---|---|---|---|
Member amount | Type float | Default 0.2 | Description Blur intensity. |
Member time | Type float | Default 0.5 | Description Continuous randomness input. |
effect/glow#
effect/glow#Applies artificial glow.
| Member | Type | Default | Description |
|---|---|---|---|
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/half_tone#
effect/half_tone#Overlays halftone pattern.
| Member | Type | Default | Description |
|---|---|---|---|
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#
effect/hsp_selective_adjustments#| Member | Type | Default | Description |
|---|---|---|---|
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#
effect/linocut#Overlays linocut pattern.
| Member | Type | Default | Description |
|---|---|---|---|
Member scale | Type float | Default 0.5 | Description Scale of pattern. |
effect/liquid#
effect/liquid#Applies a liquefy effect.
| Member | Type | Default | Description |
|---|---|---|---|
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#
effect/lut_filter#| Member | Type | Default | Description |
|---|---|---|---|
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 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#
effect/mask_color#| Member | Type | Default | Description |
|---|---|---|---|
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#
effect/mirror#Mirrors image along center.
| Member | Type | Default | Description |
|---|---|---|---|
Member side | Type int | Default 1 | Description Axis to mirror along. |
effect/outliner#
effect/outliner#Highlights outlines.
| Member | Type | Default | Description |
|---|---|---|---|
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#
effect/pixelize#Reduces the image to individual pixels.
| Member | Type | Default | Description |
|---|---|---|---|
Member horizontalPixelCount | Type int | Default 20 | Description The number of pixels on the x-axis. |
Member verticalPixelCount | Type int | Default 20 | Description The number of pixels on the y-axis. |
effect/posterize#
effect/posterize#Displays image in reduced set of color levels.
| Member | Type | Default | Description |
|---|---|---|---|
Member levels | Type float | Default 3. | Description Number of levels. |
effect/radial_pixel#
effect/radial_pixel#Reduces the image into radial pixel rows.
| Member | Type | Default | Description |
|---|---|---|---|
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/shifter#
effect/shifter#Shifts individual color channels.
| Member | Type | Default | Description |
|---|---|---|---|
Member amount | Type float | Default 0.05 | Description Intensity. |
Member angle | Type float | Default 0.3 | Description Shift direction. |
effect/tilt_shift#
effect/tilt_shift#Applies tilt shift effect.
| Member | Type | Default | Description |
|---|---|---|---|
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#
effect/tv_glitch#Mimics TV banding.
| Member | Type | Default | Description |
|---|---|---|---|
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#
effect/vignette#Adds a vignette.
| Member | Type | Default | Description |
|---|---|---|---|
Member darkness | Type float | Default 1.0 | Description Brightness of vignette. |
Member offset | Type float | Default 1. | Description Radial offset. |