Class WaterDeformer
Water deformer component.
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
[DisallowMultipleComponent]
[ExecuteInEditMode]
public class WaterDeformer : MonoBehaviour
Fields
amplitude
Specifies the amplitude of the deformer. This parameter is used differently based on the deformer type.
Declaration
public float amplitude
Field Value
Type | Description |
---|---|
float |
bowWaveElevation
Specifies the elevation of outer part of the bow wave.
Declaration
public float bowWaveElevation
Field Value
Type | Description |
---|---|
float |
boxBlend
Specifies the range that is used to blend the box deformer.
Declaration
[Min(0)]
public Vector2 boxBlend
Field Value
Type | Description |
---|---|
Vector2 |
breakingRange
Specifies the range in which the waves break and generate surface foam.
Declaration
public Vector2 breakingRange
Field Value
Type | Description |
---|---|
Vector2 |
cubicBlend
When enabled, the box deformer will have a cubic blend on the edges (instead of procedural).
Declaration
public bool cubicBlend
Field Value
Type | Description |
---|---|
bool |
deepFoamDimmer
Specifies the dimmer for the deep foam generated by the deformer.
Declaration
[Range(0, 1)]
public float deepFoamDimmer
Field Value
Type | Description |
---|---|
float |
deepFoamRange
Specifies the range in which the waves generate deep foam.
Declaration
public Vector2 deepFoamRange
Field Value
Type | Description |
---|---|
Vector2 |
range
Specifies the range of the texture deformer
Declaration
public Vector2 range
Field Value
Type | Description |
---|---|
Vector2 |
regionSize
Specifies the size of the deformer in meters.
Declaration
public Vector2 regionSize
Field Value
Type | Description |
---|---|
Vector2 |
scaleMode
The scaling mode to apply to this Foam Generator.
Declaration
[Tooltip("Specify the scaling mode")]
public DecalScaleMode scaleMode
Field Value
Type | Description |
---|---|
DecalScaleMode |
surfaceFoamDimmer
Specifies the dimmer for the surface foam generated by the deformer.
Declaration
[Range(0, 1)]
public float surfaceFoamDimmer
Field Value
Type | Description |
---|---|
float |
texture
Specifies the texture used for the deformer.
Declaration
public Texture texture
Field Value
Type | Description |
---|---|
Texture |
type
Specifies the type of the deformer. This parameter defines which parameters will be used to render it.
Declaration
public WaterDeformerType type
Field Value
Type | Description |
---|---|
WaterDeformerType |
waveBlend
Specifies the blend size on the length of the deformer's region.
Declaration
public Vector2 waveBlend
Field Value
Type | Description |
---|---|
Vector2 |
waveLength
Specifies the wave length of the individual waves of the shore wave deformer.
Declaration
[Min(1)]
public float waveLength
Field Value
Type | Description |
---|---|
float |
waveOffset
Specifies the offset in the waves' position.
Declaration
public float waveOffset
Field Value
Type | Description |
---|---|
float |
waveRepetition
Specifies the wave repetition of the waves. A higher value implies that additional waves will be skipped.
Declaration
[Min(1)]
public int waveRepetition
Field Value
Type | Description |
---|---|
int |
waveSpeed
Specifies the speed of the waves in kilometers per hour.
Declaration
public float waveSpeed
Field Value
Type | Description |
---|---|
float |