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

    Class PostProcessVolume

    A post-process volume component holding a post-process profile.

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

    Fields

    blendDistance

    The outer distance to start blending from. A value of 0 means no blending and the volume overrides will be applied immediatly upon entry.

    Declaration
    [Min(0F)]
    public float blendDistance
    Field Value
    Type Description
    Single

    isGlobal

    Should this volume be applied to the whole scene?

    Declaration
    public bool isGlobal
    Field Value
    Type Description
    Boolean

    priority

    The volume priority in the stack. Higher number means higher priority. Negative values are supported.

    Declaration
    public float priority
    Field Value
    Type Description
    Single

    sharedProfile

    The shared profile of this volume. Modifying sharedProfile will change all volumes using this profile, and change profile settings that are stored in the project too.

    Declaration
    public PostProcessProfile sharedProfile
    Field Value
    Type Description
    PostProcessProfile
    Remarks

    It is not recommended to modify profiles returned by sharedProfile. If you want to modify the profile of a volume use profile instead.

    See Also
    profile

    weight

    The total weight of this volume in the scene. 0 means it won't do anything, 1 means full effect.

    Declaration
    public float weight
    Field Value
    Type Description
    Single

    Properties

    profile

    Returns the first instantiated PostProcessProfile assigned to the volume. Modifying profile will change the profile for this volume only. If the profile is used by any other volume, this will clone the shared profile and start using it from now on.

    Declaration
    public PostProcessProfile profile { get; set; }
    Property Value
    Type Description
    PostProcessProfile
    Remarks

    This property automatically instantiates the profile and make it unique to this volume so you can safely edit it via scripting at runtime without changing the original asset in the project. Note that if you pass in your own profile, it is your responsibility to destroy it once it's not in use anymore.

    See Also
    sharedProfile
    DestroyProfile(PostProcessProfile, Boolean)

    Methods

    HasInstantiatedProfile()

    Checks if the volume has an intantiated profile or is using a shared profile.

    Declaration
    public bool HasInstantiatedProfile()
    Returns
    Type Description
    Boolean

    true if the profile has been intantiated

    See Also
    profile
    sharedProfile

    See Also

    DestroyVolume(PostProcessVolume, Boolean, Boolean)
    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