Class VolumeDebugSettings

Volume debug settings.

Inheritance

Object

VolumeDebugSettings

Namespace: UnityEngine.Rendering.HighDefinition

Syntax

public class VolumeDebugSettings : object

Fields

selectedComponent

Current volume component to debug.

Declaration

public int selectedComponent

Field Value

Type	Description
Int32

Properties

cameras

List of HD Additional Camera data.

Declaration

public static List<HDAdditionalCameraData> cameras { get; }

Property Value

Type	Description
List<HDAdditionalCameraData>

componentTypes

List of Volume component types.

Declaration

public static List<Type> componentTypes { get; }

Property Value

Type	Description
List<Type>

selectedCamera

Current camera to debug.

Declaration

public Camera selectedCamera { get; }

Property Value

Type	Description
Camera

selectedCameraIndex

Current camera index to debug.

Declaration

public int selectedCameraIndex { get; set; }

Property Value

Type	Description
Int32

selectedCameraLayerMask

Selected camera volume layer mask.

Declaration

public LayerMask selectedCameraLayerMask { get; }

Property Value

Type	Description
LayerMask

selectedCameraPosition

Selected camera volume position.

Declaration

public Vector3 selectedCameraPosition { get; }

Property Value

Type	Description
Vector3

selectedCameraVolumeStack

Selected camera volume stack.

Declaration

public VolumeStack selectedCameraVolumeStack { get; }

Property Value

Type	Description
VolumeStack

selectedComponentType

Type of the current component to debug.

Declaration

public Type selectedComponentType { get; set; }

Property Value

Type	Description
Type

Methods

ComponentDisplayName(Type)

Returns the name of a component from its VolumeComponentMenu.

Declaration

public static string ComponentDisplayName(Type component)

Parameters

Type	Name	Description
Type	component	A volume component.

Returns

Type	Description
String	The component display name.

GetParameter(FieldInfo)

Get a VolumeParameter from a VolumeComponent on the selectedCameraVolumeStack

Declaration

public VolumeParameter GetParameter(FieldInfo field)

Parameters

Type	Name	Description
FieldInfo	field	The field info of the parameter.

Returns

Type	Description
VolumeParameter	The volume parameter.

GetParameter(Volume, FieldInfo)

Get a VolumeParameter from a component of a volume

Declaration

public VolumeParameter GetParameter(Volume volume, FieldInfo field)

Parameters

Type	Name	Description
Volume	volume	The volume to get the component from.
FieldInfo	field	The field info of the parameter.

Returns

Type	Description
VolumeParameter	The volume parameter.

GetParameter(VolumeComponent, FieldInfo)

Get a VolumeParameter from a VolumeComponent

Declaration

public VolumeParameter GetParameter(VolumeComponent component, FieldInfo field)

Parameters

Type	Name	Description
VolumeComponent	component	The component to get the parameter from.
FieldInfo	field	The field info of the parameter.

Returns

Type	Description
VolumeParameter	The volume parameter.

GetVolumes()

Get an array of volumes on the selectedCameraLayerMask

Declaration

public Volume[] GetVolumes()

Returns

Type	Description
Volume[]	An array of volumes sorted by influence.

GetVolumeWeight(Volume)

Get the weight of a volume computed from the selectedCameraPosition

Declaration

public float GetVolumeWeight(Volume volume)

Parameters

Type	Name	Description
Volume	volume	The volume to compute weight for.

Returns

Type	Description
Single	The weight of the volume.

RefreshVolumes(Volume[])

Updates the list of volumes and recomputes volume weights

Declaration

public bool RefreshVolumes(Volume[] newVolumes)

Parameters

Type	Name	Description
Volume[]	newVolumes	The new list of volumes.

Returns

Type	Description
Boolean	True if the volume list have been updated.

RegisterCamera(HDAdditionalCameraData)

Register HDAdditionalCameraData for DebugMenu

Declaration

public static void RegisterCamera(HDAdditionalCameraData camera)

Parameters

Type	Name	Description
HDAdditionalCameraData	camera	The camera to register.

UnRegisterCamera(HDAdditionalCameraData)

Unregister HDAdditionalCameraData for DebugMenu

Declaration

public static void UnRegisterCamera(HDAdditionalCameraData camera)

Parameters

Type	Name	Description
HDAdditionalCameraData	camera	The camera to unregister.

VolumeHasInfluence(Volume)

Determines if a volume as an influence on the interpolated value

Declaration

public bool VolumeHasInfluence(Volume volume)

Parameters

Type	Name	Description
Volume	volume	The volume.

Returns

Type	Description
Boolean	True if the given volume as an influence.