docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    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.

    In This Article
    Back to top
    Copyright © 2023 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)