Class PostProcessVolume

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

Inheritance
System.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
System.Single

isGlobal

Should this volume be applied to the whole scene?

Declaration
public bool isGlobal
Field Value
Type Description
System.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
System.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

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
System.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

Methods

HasInstantiatedProfile()

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

Declaration
public bool HasInstantiatedProfile()
Returns
Type Description
System.Boolean

true if the profile has been intantiated
See Also

See Also