Skip to content

Displace


Controls

Parameter / Script Name Type Default Function
Enabled / enabled Boolean On
Displacement Map / uv Image - This effect will read the first 2 channels (i.e: red and green) for the X and Y coordinates respectively
Red / process_red Boolean On Enable the red channel in output. Otherwise if there's a source the content of the main source is returned instead, else 0
Green / process_green Boolean On Enable the green channel in output. Otherwise if there's a source the content of the main source is returned instead, else 0
Blue / process_blue Boolean On Enable the blue channel in output. Otherwise if there's a source the content of the main source is returned instead, else 0
Alpha / process_alpha Boolean On Enable the alpha channel in output. Otherwise if there's a source the content of the main source is returned instead, else 0
Amount / scale Float 2D 10, 10 A scale factor applied to the uv value at each pixel of the uv map
Offset / offset Float 2D 0, 0 An offset subtracted from the u value at each pixel of the uv map. This is applied after scale
Wrap U / u_wrap Choice Black How the source image is accessed when the X coordinate is out of bounds
Wrap V / v_wrap Choice Black How the source image is accessed when the Y coordinate is out of bounds
Supersampling / supersampling Choice x2 The supersampling factor. Higher means more quality and antialiasing but slower to render
Use Map Alpha / multiply_uv_by_source_alpha Boolean On When checked, the displacement map red and green channels are multiplied by the alpha channel of the displacement map. This is useful when the red and green channels may contain non zero values where alpha is zero.
Fitting / uv_fit Choice No Fitting
Bounding Box / rod_mode Choice Composition Format
Mask / mask Image -
Mix / mix_with_source Float 1 Dissolves between the original image at 0 and the image with the effect applied at 1