PostFX Gradient Weight Modifier Component

The PostFX Gradient Weight Modifier component modifies the blending weight of post-processing effects (PostFX) by using another entity’s gradient signal as a masking operation.

Provider

Atom Gem

Dependencies

PostFX Layer component

Gradient Sampler properties

PostFX Gradient Weight Modifier base properties

PropertyDescriptionValuesDefault
Gradient Entity IdA reference to a separate entity that provides a gradient.EntityIdNone
OpacitySets the opacity of the input gradient.Float: 0.0 - 1.01.0
Invert InputInverts the values of the input gradient.BooleanDisabled
Preview (Inbound)Displays the gradient provided by the entity set in Gradient Entity Id.
Enable TransformIf Enabled, the translation, scale, and rotation of the input gradient may be modified.BooleanDisabled
TranslateSets the translation of the input gradient.Vector3: -Infinity to InfinityX:0.0, Y:0.0, Z:0.0
ScaleSets the scale of the input gradient.Vector3: 0.0001 to InfinityX:1.0, Y:1.0, Z:1.0
RotateSets the rotation of the input gradient.Vector3: -Infinity to InfinityX:0.0, Y:0.0, Z:0.0
Enable LevelsIf Enabled, the input and output values of the input gradient may be modified.BooleanDisabled
Input MidSets the median value of the input gradient.Float: 0.0 - 1.01.0
Input MinSets a minimum value for the input gradient.Float: 0.0 - 1.00.0
Input MaxSets a maximum value for the input gradient.Float: 0.0 - 1.01.0
Output MinSets a minimum value for the output gradient.Float: 0.0 - 1.00.0
Output MaxSets a maximum value for the output gradient.Float: 0.0 - 1.01.0

Usage

In this example, there are two entities: ShaderBall and GradientSignalProvider. The ShaderBall entity’s PostFX Gradient Weight Modifier component references the GradientSignalProvider entity in its Gradient Entity Id property. The weight of the PostFX depends on the gradient that GradientSignalProvider inputs.

For more information on gradient signal providers, refer to the list of Gradient components and Gradient Signal Gem .

Using PostFX Gradient Weight Modifier example

Using PostFX Gradient Weight Modifier example