Class VolumeDebugSettings<T>

The volume settings

Inheritance

object

VolumeDebugSettings<T>

Implements

IVolumeDebugSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.Rendering

Assembly: Unity.RenderPipelines.Core.Runtime.dll

Syntax

public abstract class VolumeDebugSettings<T> : IVolumeDebugSettings where T : MonoBehaviour, IAdditionalData

Type Parameters

Name	Description
T	A MonoBehaviour with IAdditionalData

Fields

m_SelectedCameraIndex

The selected camera index, use the property for better handling

Declaration

protected int m_SelectedCameraIndex

Field Value

Type	Description
int

Properties

additionalCameraDatas

The list of the additional camera datas

Declaration

[Obsolete("Cameras are auto registered/unregistered, use property cameras", false)]
protected static List<T> additionalCameraDatas { get; }

Property Value

Type	Description
List<T>

cameras

Returns the collection of registered cameras.

Declaration

public IEnumerable<Camera> cameras { get; }

Property Value

Type	Description
IEnumerable<Camera>

componentTypes

List of Volume component types.

Declaration

[Obsolete("Please use volumeComponentsPathAndType instead, and get the second element of the tuple", false)]
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

Selected camera index.

Declaration

public int selectedCameraIndex { get; set; }

Property Value

Type	Description
int

selectedCameraLayerMask

Selected camera volume layer mask.

Declaration

public abstract LayerMask selectedCameraLayerMask { get; }

Property Value

Type	Description
LayerMask

selectedCameraPosition

Selected camera volume position.

Declaration

public abstract Vector3 selectedCameraPosition { get; }

Property Value

Type	Description
Vector3

selectedCameraVolumeStack

Selected camera volume stack.

Declaration

public abstract VolumeStack selectedCameraVolumeStack { get; }

Property Value

Type	Description
VolumeStack

selectedComponent

Current volume component to debug.

Declaration

public int selectedComponent { get; set; }

Property Value

Type	Description
int

selectedComponentType

Type of the current component to debug.

Declaration

public Type selectedComponentType { get; set; }

Property Value

Type	Description
Type

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 virtual Type targetRenderPipeline { get; }

Property Value

Type	Description
Type

volumeComponentsPathAndType

List of Volume component types.

Declaration

public List<(string, Type)> volumeComponentsPathAndType { get; }

Property Value

Type	Description
List<(string, Type)>

Methods

ComponentDisplayName(Type)

Returns the name of a component from its VolumeComponentMenuForRenderPipeline.

Declaration

[Obsolete("Please use componentPathAndType instead, and get the first element of the tuple", false)]
public static string ComponentDisplayName(Type component)

Parameters

Type	Name	Description
Type	component	A volume component.

Returns

Type	Description
string	The component display name.

GetVolumeWeight(Volume)

Obtains the volume weight

Declaration

public float GetVolumeWeight(Volume volume)

Parameters

Type	Name	Description
Volume	volume	Volume

Returns

Type	Description
float	The weight of the volume

GetVolumes()

Get an array of volumes on the selectedCameraLayerMask

Declaration

public Volume[] GetVolumes()

Returns

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

RefreshVolumes(Volume[])

Refreshes the volumes, fetches the stored volumes on the panel

Declaration

public bool RefreshVolumes(Volume[] newVolumes)

Parameters

Type	Name	Description
Volume[]	newVolumes	The list of Volume to refresh

Returns

Type	Description
bool	If the volumes have been refreshed

RegisterCamera(T)

Register the camera for the Volume Debug.

Declaration

[Obsolete("Cameras are auto registered/unregistered", false)]
public static void RegisterCamera(T additionalCamera)

Parameters

Type	Name	Description
T	additionalCamera	The AdditionalCameraData of the camera to be registered.

UnRegisterCamera(T)

Unregister the camera for the Volume Debug.

Declaration

[Obsolete("Cameras are auto registered/unregistered", false)]
public static void UnRegisterCamera(T additionalCamera)

Parameters

Type	Name	Description
T	additionalCamera	The AdditionalCameraData of the camera to be registered.

VolumeHasInfluence(Volume)

Return if the Volume has influence

Declaration

public bool VolumeHasInfluence(Volume volume)

Parameters

Type	Name	Description
Volume	volume	Volume to check the influence

Returns

Type	Description
bool	If the volume has influence

Implements

IVolumeDebugSettings

Extension Methods

ReflectionUtils.GetField(object, string)

ReflectionUtils.GetFields(object)

ReflectionUtils.Invoke(object, string, params object[])

ReflectionUtils.SetField(object, string, object)

AnalyticsUtils.ToNestedColumnWithDefault<T>(T, T, bool)

AnalyticsUtils.ToNestedColumn<T>(T, T)