Class PostProcessVolume
A post-process volume component holding a post-process profile.
Inherited Members
Namespace: UnityEngine.Rendering.PostProcessing
Syntax
[ExecuteInEditMode]
[AddComponentMenu("Rendering/Post-process Volume", 1001)]
public sealed class PostProcessVolume : MonoBehaviourFields
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)]
[Tooltip("The distance (from the attached Collider) to start blending from. A value of 0 means there will be no blending and the Volume overrides will be applied immediatly upon entry to the attached Collider.")]
public float blendDistanceField Value
| Type | Description |
|---|---|
| Single |
isGlobal
Should this volume be applied to the whole scene?
Declaration
[Tooltip("Check this box to mark this volume as global. This volume's Profile will be applied to the whole Scene.")]
public bool isGlobalField Value
| Type | Description |
|---|---|
| Boolean |
priority
The volume priority in the stack. Higher number means higher priority. Negative values are supported.
Declaration
[Tooltip("The volume priority in the stack. A higher value means higher priority. Negative values are supported.")]
public float priorityField 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 sharedProfileField 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
[Range(0F, 1F)]
[Tooltip("The total weight of this Volume in the Scene. A value of 0 signifies that it will have no effect, 1 signifies full effect.")]
public float weightField 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
Methods
HasInstantiatedProfile()
Checks if the volume has an intantiated profile or is using a shared profile.
Declaration
public bool HasInstantiatedProfile()Returns
| Type | Description |
|---|---|
| Boolean |
|