Gradient Mixer Component

The Gradient Mixer component generates a new gradient by blending a number of input gradient layers with iayer blending operations.

Provider

Gradient Signal Gem

Gradient Mixer properties

Gradient Mixer component properties

PropertyDescriptionValuesDefault
PreviewDisplays the output gradient of this component after all properties are applied.
Pin Preview to ShapeSets an entity with a compatible Shape component to use as the bounds of the preview if Constrain to Shape is Enabled.EntityIdCurrent Entity
Preview PositionSets the world location of the preview.

This field is available only if there is no entity selected in Pin Preview to Shape.
Vector3: -Infinity to InfinityX:0.0, Y:0.0, Z:0.0
Preview SizeSets the dimensions of the preview.Vector3: 0.0 to InfinityX:1.0, Y:1.0, Z:1.0
Constrain to ShapeIf Enabled, the gradient preview uses the bounds of the entity selected in Pin Preview to Shape.

This field is available only if an entity is selected in Pin Preview to Shape.
BooleanDisabled
LayersAn array of gradients and gradient operations to evaluate. Gradient operations are applied in the same order as this array.
Layers - EnabledToggles the influnce of this gradient layer.BooleanEnabled
Layers - OperationSets the function that is used to mix this gradient layer with the previous result.Initialize, Multiply, Linear Dodge (Add), Subtract, Darken (Min), Lighten (Max), Average, Normal, or Overlay.Initialize
Layers - GradientRefer to Gradient properties below.

Gradient properties

Gradient properties

PropertyDescriptionValuesDefault
Gradient Entity IdSets an entity with an active Gradient component.EntityIdNone
OpacitySets the opacity of the input gradient.Float: 0.0 - 1.01.0
Invert InputInverts the values of the input gradient.BooleanDisabled
Preview (Input)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

MixedGradientRequestBus

Use the following request functions with the MixedGradientRequestBus EBus interface to communicate with Gradient Mixer components in your game.

Method NameDescriptionParameterReturnScriptable
AddLayerAdds a layer to the end of the Layers array.Mixed Gradient LayerNoneYes
GetLayerReturns the mixed gradient layer at the specified index.Layer Index: IntegerMixed Gradient LayerYes
GetNumLayersReturns the number of mixed gradient layers.NoneCount: IntegerYes
RemoveLayerRemoves the mixed gradient layer at the specified index.Layer Index: IntegerNoneYes