Class HDVolumeDebugSettings

Represents the debug settings for handling volumes in the Rendering Debugger. This class extends UnityEngine.Rendering.VolumeDebugSettings<T> and allows customization of the volume stack, layer mask, and position for the selected camera in the HDRP pipeline. It manages the camera-specific configurations to ensure accurate rendering in the volume system.

Inheritance

object

VolumeDebugSettings<HDAdditionalCameraData>

HDVolumeDebugSettings

VolumeDebugSettings

Implements

IVolumeDebugSettings

Inherited Members

VolumeDebugSettings<HDAdditionalCameraData>.componentTypes

VolumeDebugSettings<HDAdditionalCameraData>.ComponentDisplayName(Type)

VolumeDebugSettings<HDAdditionalCameraData>.additionalCameraDatas

VolumeDebugSettings<HDAdditionalCameraData>.RegisterCamera(HDAdditionalCameraData)

VolumeDebugSettings<HDAdditionalCameraData>.UnRegisterCamera(HDAdditionalCameraData)

VolumeDebugSettings<HDAdditionalCameraData>.selectedComponent

VolumeDebugSettings<HDAdditionalCameraData>.selectedCamera

VolumeDebugSettings<HDAdditionalCameraData>.m_SelectedCameraIndex

VolumeDebugSettings<HDAdditionalCameraData>.selectedCameraIndex

VolumeDebugSettings<HDAdditionalCameraData>.cameras

VolumeDebugSettings<HDAdditionalCameraData>.selectedComponentType

VolumeDebugSettings<HDAdditionalCameraData>.volumeComponentsPathAndType

VolumeDebugSettings<HDAdditionalCameraData>.GetVolumes()

VolumeDebugSettings<HDAdditionalCameraData>.RefreshVolumes(Volume[])

VolumeDebugSettings<HDAdditionalCameraData>.GetVolumeWeight(Volume)

VolumeDebugSettings<HDAdditionalCameraData>.VolumeHasInfluence(Volume)

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

[Obsolete("This is not longer supported Please use DebugDisplaySettingsVolume. #from(6000.2)", false)]
public class HDVolumeDebugSettings : VolumeDebugSettings<HDAdditionalCameraData>, IVolumeDebugSettings

Remarks

This class provides access to debug settings for the volume stack and layer mask in the High Definition Render Pipeline (HDRP). It is useful for visualizing and adjusting volume settings for specific cameras during development.

Properties

selectedCameraLayerMask

Gets the selected camera's volume layer mask. This determines which volumes will affect the selected camera. If the scene view is active, it will use the main camera's volume layer mask.

Declaration

public override LayerMask selectedCameraLayerMask { get; }

Property Value

Type	Description
LayerMask

Overrides

UnityEngine.Rendering.VolumeDebugSettings<UnityEngine.Rendering.HighDefinition.HDAdditionalCameraData>.selectedCameraLayerMask

Remarks

This property manages the layer mask for volumes, which is important for determining which volumes apply to the selected camera. It considers special cases like the scene view camera to provide accurate results in different contexts.

selectedCameraPosition

Gets the selected camera's volume position. If no camera is selected, the position defaults to zero.

Declaration

public override Vector3 selectedCameraPosition { get; }

Property Value

Type	Description
Vector3

Overrides

UnityEngine.Rendering.VolumeDebugSettings<UnityEngine.Rendering.HighDefinition.HDAdditionalCameraData>.selectedCameraPosition

Remarks

This property returns the position of the volume anchor for the selected camera. If the camera's anchor has not been initialized, it will attempt to retrieve or set the anchor manually. This is important for adjusting the position of the camera in relation to the volume system.

selectedCameraVolumeStack

Gets the selected camera's volume stack. If no camera is selected, it defaults to the global volume stack. This stack holds all the volume components affecting the camera.

Declaration

public override VolumeStack selectedCameraVolumeStack { get; }

Property Value

Type	Description
VolumeStack

Overrides

UnityEngine.Rendering.VolumeDebugSettings<UnityEngine.Rendering.HighDefinition.HDAdditionalCameraData>.selectedCameraVolumeStack

Remarks

This property retrieves the volume stack associated with the currently selected camera. If the camera is not found, the global volume stack is used as a fallback. This stack defines how volumes are applied to the camera's view.

targetRenderPipeline

Specifies the render pipeline for this volume settings

Declaration

[Obsolete("This property is obsolete and kept only for not breaking user code. VolumeDebugSettings will use current pipeline when it needs to gather volume component types and paths. #from(23.2)", false)]
public override Type targetRenderPipeline { get; }

Property Value

Type	Description
Type

Overrides

UnityEngine.Rendering.VolumeDebugSettings<UnityEngine.Rendering.HighDefinition.HDAdditionalCameraData>.targetRenderPipeline

Implements

UnityEngine.Rendering.IVolumeDebugSettings