Dither Gradient Modifier Component

The Dither Gradient Modifier component applies an ordered dithering algorithm to a gradient.

Provider

Gradient Signal Gem

Dither Gradient Modifier properties

Dither Gradient Modifier 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
Pattern OffsetShifts the pattern’s lookup indexes.Vector3: -Infinity to InfinityX:0.0, Y:0.0, Z:0.0
Pattern TypeSets the pattern of the dithering effect.4x4 or 8x84x4
Sample Settings - Use System Points Per UnitIf Enabled, Points Per Unit is set automatically to the sector’s density divided by the sector’s size.BooelanEnabled
Sample Settings - Points Per UnitSets the value to scale the input position by before the gradient is sampled.0.001 to Infinity1.0
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

DitherGradientRequestBus

Use the following request functions with the DitherGradientRequestBus EBus interface to communicate with Dither Gradient Modifier components in your game.

Method NameDescriptionParameterReturnScriptable
GetGradientSamplerReturns the gradient sampler object of the dither gradient.NoneGradient SamplerYes
GetPatternOffsetReturns the value of Pattern Offset.NoneOffset: Vector3Yes
GetPatternTypeReturns the value of Pattern Type.NonePattern Type Index: IntegerYes
GetPointsPerUnitReturns the value of Points Per Unit.NonePoints: FloatYes
GetUseSystemPointsPerUnitReturns the value of Use System Points Per Unit.NoneBooleanYes
SetPatternOffsetSets the value of Pattern Offset.Offset: Vector3NoneYes
SetPatternTypeSets the value of Pattern Type.Pattern Type Index: IntegerNoneYes
SetPointsPerUnitSets the value of Points Per Unit.Points: FloatNoneYes
SetUseSystemPointsPerUnitSets the value of Use System Points Per Unit.BooleanNoneYes