Class HDRPDefaultVolumeProfileSettings

Graphics Settings container for the default UnityEngine.Rendering.VolumeProfile used by the HDRenderPipeline.

Inheritance

object

HDRPDefaultVolumeProfileSettings

Implements

IDefaultVolumeProfileSettings

IRenderPipelineGraphicsSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.Rendering.HighDefinition

Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll

Syntax

[Serializable]
[SupportedOnRenderPipeline(typeof(HDRenderPipelineAsset))]
[CategoryInfo(Name = "Volume", Order = 0)]
[ElementInfo(Order = 0)]
public class HDRPDefaultVolumeProfileSettings : IDefaultVolumeProfileSettings, IRenderPipelineGraphicsSettings

Remarks

To change those settings, go to Editor > Project Settings in the Graphics tab (HDRP). Changing this through API is only allowed in the Editor. In the Player, this raises an error.

Examples

Here is an example of how to get the default volume profile used by HDRP.

using UnityEngine.Rendering;
using UnityEngine.Rendering.HighDefinition;
public static class URPDefaultVolumeProfileHelper
{
public static VolumeProfile volumeProfile
{
get
{
var gs = GraphicsSettings.GetRenderPipelineSettings<URPDefaultVolumeProfileSettings>();
if (gs == null) //not in HDRP
return null;
return gs.volumeProfile;
}
}
}

Properties

version

Current version of this settings container. Used only for upgrading the project.

Declaration

public int version { get; }

Property Value

Type	Description
int

See Also

IRenderPipelineGraphicsSettings

volumeProfile

The default volume profile asset.

Declaration

public VolumeProfile volumeProfile { get; set; }

Property Value

Type	Description
VolumeProfile

See Also

IRenderPipelineGraphicsSettings

Implements

UnityEngine.Rendering.IDefaultVolumeProfileSettings

IRenderPipelineGraphicsSettings

See Also

IRenderPipelineGraphicsSettings