Class PostProcessManager | Post Processing | 2.3.0
docs.unity3d.com
    Show / Hide Table of Contents

    Class PostProcessManager

    This manager tracks all volumes in the scene and does all the interpolation work. It is automatically created as soon as Post-processing is active in a scene.

    Inheritance
    Object
    PostProcessManager
    Namespace: UnityEngine.Rendering.PostProcessing
    Syntax
    public sealed class PostProcessManager

    Fields

    settingsTypes

    This dictionary maps all PostProcessEffectSettings available to their corresponding PostProcessAttribute. It can be used to list all loaded builtin and custom effects.

    Declaration
    public readonly Dictionary<Type, PostProcessAttribute> settingsTypes
    Field Value
    Type Description
    Dictionary<Type, PostProcessAttribute>

    Properties

    instance

    The current singleton instance of PostProcessManager.

    Declaration
    public static PostProcessManager instance { get; }
    Property Value
    Type Description
    PostProcessManager

    Methods

    GetActiveVolumes(PostProcessLayer, List<PostProcessVolume>, Boolean, Boolean)

    Gets a list of all volumes currently affecting the given layer. Results aren't sorted and the list isn't cleared.

    Declaration
    public void GetActiveVolumes(PostProcessLayer layer, List<PostProcessVolume> results, bool skipDisabled = true, bool skipZeroWeight = true)
    Parameters
    Type Name Description
    PostProcessLayer layer

    The layer to look for

    List<PostProcessVolume> results

    A list to store the volumes found

    Boolean skipDisabled

    Should we skip disabled volumes?

    Boolean skipZeroWeight

    Should we skip 0-weight volumes?

    GetHighestPriorityVolume(LayerMask)

    Gets the highest priority volume affecting PostProcessLayer in a given .

    Declaration
    public PostProcessVolume GetHighestPriorityVolume(LayerMask mask)
    Parameters
    Type Name Description
    LayerMask mask

    The layer mask to look for

    Returns
    Type Description
    PostProcessVolume

    The highest priority volume affecting the layer mask

    See Also
    volumeLayer

    GetHighestPriorityVolume(PostProcessLayer)

    Gets the highest priority volume affecting a given layer.

    Declaration
    public PostProcessVolume GetHighestPriorityVolume(PostProcessLayer layer)
    Parameters
    Type Name Description
    PostProcessLayer layer

    The layer to look for

    Returns
    Type Description
    PostProcessVolume

    The highest priority volume affecting the layer

    QuickVolume(Int32, Single, PostProcessEffectSettings[])

    Helper method to spawn a new volume in the scene.

    Declaration
    public PostProcessVolume QuickVolume(int layer, float priority, params PostProcessEffectSettings[] settings)
    Parameters
    Type Name Description
    Int32 layer

    The unity layer to put the volume in

    Single priority

    The priority to set this volume to

    PostProcessEffectSettings[] settings

    A list of effects to put in this volume

    Returns
    Type Description
    PostProcessVolume
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023