Method GetFoamBuffer
GetFoamBuffer(out Vector2)
Function that returns the foam buffer for the water surface. If the feature is disabled or the resource is not available the function returns null.
Declaration
public Texture GetFoamBuffer(out Vector2 foamArea)
Parameters
Type | Name | Description |
---|---|---|
Vector2 | foamArea | Output parameter that returns the size of the foam region. |
Returns
Type | Description |
---|---|
Texture | An RG texture that holds the surface foam (red channel) and deep foam (green channel) of the water surface. |