Class PostProcessProfile

An asset holding a set of post-processing settings to use with a PostProcessVolume.

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

Fields

isDirty

Sets to true if the content of the profile has changed. This is only really used in the editor to handle inspector refreshes.

Declaration
[NonSerialized]
public bool isDirty
Field Value
Type Description
Boolean

settings

A list of all settings stored in this profile.

Declaration
public List<PostProcessEffectSettings> settings
Field Value
Type Description
List<PostProcessEffectSettings>

Methods

AddSettings(Type)

Adds settings for an effect to the profile.

Declaration
public PostProcessEffectSettings AddSettings(Type type)
Parameters
Type Name Description
Type type

A type of PostProcessEffectSettings
Returns
Type Description
PostProcessEffectSettings

The instance created from the given type
See Also

AddSettings(PostProcessEffectSettings)

Adds settings for an effect to the profile.

Declaration
public PostProcessEffectSettings AddSettings(PostProcessEffectSettings effect)
Parameters
Type Name Description
PostProcessEffectSettings effect

An instance of PostProcessEffectSettings
Returns
Type Description
PostProcessEffectSettings

The given effect instance
See Also

AddSettings<T>()

Adds settings for an effect to the profile.

Declaration
public T AddSettings<T>()
    where T : PostProcessEffectSettings
Returns
Type Description
T

The instance created from the given type
Type Parameters
Name Description
T

A type of PostProcessEffectSettings
See Also

GetSetting<T>()

Returns settings for a given effect type.

Declaration
public T GetSetting<T>()
    where T : PostProcessEffectSettings
Returns
Type Description
T

Settings for the given effect type, null otherwise
Type Parameters
Name Description
T

The type to look for

HasSettings(Type)

Checks if an effect has been added to the profile.

Declaration
public bool HasSettings(Type type)
Parameters
Type Name Description
Type type

The type to look for
Returns
Type Description
Boolean

true if the effect exists in the profile, false otherwise

HasSettings<T>()

Checks if an effect has been added to the profile.

Declaration
public bool HasSettings<T>()
    where T : PostProcessEffectSettings
Returns
Type Description
Boolean

true if the effect exists in the profile, false otherwise
Type Parameters
Name Description
T

The type to look for

RemoveSettings(Type)

Removes settings for an effect from the profile.

Declaration
public void RemoveSettings(Type type)
Parameters
Type Name Description
Type type

The type to look for and remove from the profile
Exceptions
Type Condition
InvalidOperationException

Thrown if the effect doesn't exist in the profile

RemoveSettings<T>()

Removes settings for an effect from the profile.

Declaration
public void RemoveSettings<T>()
    where T : PostProcessEffectSettings
Type Parameters
Name Description
T

The type to look for and remove from the profile
Exceptions
Type Condition
InvalidOperationException

Thrown if the effect doesn't exist in the profile

TryGetSettings<T>(out T)

Gets settings for a given effect type.

Declaration
public bool TryGetSettings<T>(out T outSetting)
    where T : PostProcessEffectSettings
Parameters
Type Name Description
T outSetting

When this method returns, contains the value associated with the specified type, if the type is found; otherwise, this parameter will be null. This parameter is passed uninitialized.
Returns
Type Description
Boolean

true if the effect exists in the profile, false otherwise
Type Parameters
Name Description
T

The type to look for

See Also