Class WaterDeformer

Water deformer component.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

WaterDeformer

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

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

material

Specifies the material used for the deformer.

Declaration

[Tooltip("Specifies the material used for the deformer.")]
public Material material

Field Value

Type	Description
Material

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

resolution

Specifies the resolution when written inside the atlas.

Declaration

public Vector2Int resolution

Field Value

Type	Description
Vector2Int

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

[Tooltip("Specifies the texture used for the deformer.")]
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

updateMode

Frequency of update of the Material in the atlas.

Declaration

[Tooltip("Frequency of update of the Material in the atlas.")]
public CustomRenderTextureUpdateMode updateMode

Field Value

Type	Description
CustomRenderTextureUpdateMode

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

Methods

HasPropertyBlock()

Returns true if the Deformer has a material property block attached via SetPropertyBlock.

Declaration

public bool HasPropertyBlock()

Returns

Type	Description
bool	Returns true if the Deformer has a material property block attached via SetPropertyBlock.

RequestUpdate()

Triggers a render of the material in the deformer atlas.

Declaration

public void RequestUpdate()

SetPropertyBlock(MaterialPropertyBlock)

Override per-deformer material parameters. This is more memory efficient than having one complete distinct Material per deformer but is recommended when only a few properties of a Material overriden.

Declaration

public void SetPropertyBlock(MaterialPropertyBlock properties)

Parameters

Type	Name	Description
MaterialPropertyBlock	properties	Property block with values you want to override.