Levels effect

LevelsEffectNode is an effect used to adjust the color ranges of an image. It allows to balance and tone colors and/or graycales values.

Examples

import substance_painter as sp

# Get the currently displayed Stack
stack = sp.textureset.get_active_stack()

# Get top position of the Stack
position_stack_top = sp.layerstack.InsertPosition.from_textureset_stack(stack)

# Insert Fill Layer
my_fill_layer = sp.layerstack.insert_fill(position_stack_top)
my_fill_layer.set_name("My Fill Layer")

# Load noise into Metallic channel
noise_resource = sp.resource.search("s:starterassets "
                                    "u:procedural "
                                    "n:3D Perlin Noise")[0]
my_fill_layer.set_source(sp.layerstack.ChannelType.Metallic, noise_resource.identifier())

# Add a Levels effect in the content stack
inside_content = sp.layerstack.InsertPosition.inside_node(
    my_fill_layer, sp.layerstack.NodeStack.Content)
my_levels_effect = sp.layerstack.insert_levels_effect(inside_content)

# Update the affected channel to Metallic
my_levels_effect.affected_channel = sp.layerstack.ChannelType.Metallic

# Update the Levels effect parameters
parameters = my_levels_effect.get_parameters()
# Note: `parameters` is a LevelsParamsMono because Metallic channel has only a luminance channel
parameters.input_min = 0.25
parameters.input_max = 0.75
my_levels_effect.set_parameters(parameters)

# Select the Levels effect
sp.layerstack.set_selected_nodes([my_levels_effect])

Functions and classes

substance_painter.layerstack.insert_levels_effect(position: InsertPosition) -> LevelsEffectNode substance_painter.layerstack.insert_levels_effect

Insert a levels effect with default parameters.

Parameters:

position (InsertPosition) – The insert position must be either inside
a LayerNode with NodeStack.Content
or NodeStack.Mask
or above/below an EffectNode.

Raises:

ValueError – If insertion failed due to an invalid position.
See InsertPosition.

Returns: The inserted node.

Return type: LevelsEffectNode

class substance_painter.layerstack.LevelsEffectNode(uid) substance_painter.layerstack.LevelsEffectNode

Bases: Node

A node allowing manipulation of a Levels effect.

property affected_channel: ChannelType substance_painter.layerstack.LevelsEffectNode.affected_channel

The channel affected by the current level effect.

Getter: Returns the affected channel.

Setter: Set the affected channel.

Type: ChannelType

get_parameters() -> LevelsParamsMono | LevelsParamsRGB substance_painter.layerstack.LevelsEffectNode.get_parameters

Get the current parameters of this levels effect.

Returns: The current level parameters.

Return type: LevelsParamsMono | LevelsParamsRGB

set_parameters(params: LevelsParamsMono | LevelsParamsRGB) -> None substance_painter.layerstack.LevelsEffectNode.set_parameters

Set new parameters for this levels effect.

Parameters: params (LevelsParamsMono | LevelsParamsRGB) – The new parameters.

Return type: None

Params

class substance_painter.levels.LevelsParamsRGB(input_min: Tuple[float, float, float] = (0.0, 0.0, 0.0), input_max: Tuple[float, float, float] = (1.0, 1.0, 1.0), gamma: Tuple[float, float, float] = (1.0, 1.0, 1.0), output_min: Tuple[float, float, float] = (0.0, 0.0, 0.0), output_max: Tuple[float, float, float] = (1.0, 1.0, 1.0), clamp: bool = False) substance_painter.levels.LevelsParamsRGB

A levels parameters, when in RGB color mode.

Parameters:

class substance_painter.levels.LevelsParamsMono(input_min: float = 0.0, input_max: float = 1.0, gamma: float = 1.0, output_min: float = 0.0, output_max: float = 1.0, clamp: bool = False) substance_painter.levels.LevelsParamsMono

A levels parameters, when in Luminance or only one color mode.

Parameters:

substance_painter.levels.LevelsParams substance_painter.levels.LevelsParams

alias of LevelsParamsMono | LevelsParamsRGB

Levels parameters can be expressed for three channels (RGB) or only one color channel (only one
color or luminance). LevelsParams is used to regroup the two possible parameters flavors.