Class VolumeProfile

An Asset which holds a set of settings to use with a Volume.

Inheritance
object
Object
ScriptableObject
VolumeProfile
Inherited Members
ScriptableObject.SetDirty()
ScriptableObject.CreateInstance<T>()
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
[CoreRPHelpURL("Volume-Profile", "com.unity.render-pipelines.high-definition")]
[Icon("Packages/com.unity.render-pipelines.core/Editor/Icons/Processed/VolumeProfile Icon.asset")]
public sealed class VolumeProfile : ScriptableObject

Fields

Name Description
components

A list of every setting that this Volume Profile stores.
isDirty

Note: For Internal Use Only
A dirty check used to redraw the profile inspector when something has changed. This is currently only used in the editor.

Methods

Name Description
Add(Type, bool)

Adds a VolumeComponent to this Volume Profile.
Add<T>(bool)

Adds a VolumeComponent to this Volume Profile.
GetHashCode()

A custom hashing function that Unity uses to compare the state of parameters.
Has(Type)

Checks if this Volume Profile contains the VolumeComponent you pass in.
HasSubclassOf(Type)

Checks if this Volume Profile contains the VolumeComponent, which is a subclass of type, that you pass in.
Has<T>()

Checks if this Volume Profile contains the VolumeComponent you pass in.
Remove(Type)

Removes a VolumeComponent from this Volume Profile.
Remove<T>()

Removes a VolumeComponent from this Volume Profile.
Reset()

Resets the dirty state of the Volume Profile. Unity uses this to force-refresh and redraw the Volume Profile editor when you modify the Asset via script instead of the Inspector.
TryGetAllSubclassOf<T>(Type, List<T>)

Gets all the VolumeComponent that are subclasses of the specified type, if there are any.
TryGetSubclassOf<T>(Type, out T)

Gets the VolumeComponent, which is a subclass of type, if it exists.
TryGet<T>(Type, out T)

Gets the VolumeComponent of the specified type, if it exists.
TryGet<T>(out T)

Gets the VolumeComponent of the specified type, if it exists.

Extension Methods