ClampDisplayFilter

Overview

The ClampDisplayFilter clamps the rgb values of an input image buffer between min and max.

Attribute Reference

Advanced attributes

invert_mask

Bool
default: False

Invert the value of the mask

mix

Float
default: 1.0

Blend [0,1] between input and output

General attributes

input

RenderOutput
default: None

RenderOutput to clamp

mask

RenderOutput
default: None

RenderOutput used to mask the output, revealing input1

max

Rgb
default: [ 1, 1, 1 ]

Maximum color value

max = Rgb(1.0 --> 0.0, 1.0, 1.0)

min

Rgb
default: [ 0, 0, 0 ]

Minimum color value

min = Rgb(0.0 --> 1.0, 0.0, 0.0)

Examples

local beauty = RenderOutput("/output/beauty") {
    ["file_name"] = "result_tmp.exr",
    ["result"] = "beauty",
}

local clamp = ClampDisplayFilter("/display/clamp") {
    ["input"] = beauty,
    ["min"] = Rgb(0.4, 0.4, 0.4),
    ["max"] = Rgb(0.6, 0.6, 0.6),
}

RenderOutput("/output/clamp") {
    ["file_name"] = "result0.exr",
    ["result"] = "display filter",
    ["display_filter"] = clamp,
    ["channel_name"] = "clamp"
}