Class DebugDisplaySettingsVolume
Debug Display Settings Volume
Inherited Members
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
public class DebugDisplaySettingsVolume : IDebugDisplaySettingsData, IDebugDisplaySettingsQueryConstructors
DebugDisplaySettingsVolume()
Constructor with the settings
Declaration
public DebugDisplaySettingsVolume()DebugDisplaySettingsVolume(IVolumeDebugSettings)
Constructor with the settings
Declaration
[Obsolete("This constructor has been obsoleted and will be removed in a future version. #from(6000.2)", false)]
public DebugDisplaySettingsVolume(IVolumeDebugSettings volumeDebugSettings)Parameters
| Type | Name | Description |
|---|---|---|
| IVolumeDebugSettings | volumeDebugSettings | The volume debug settings object used for configuration. |
Properties
AreAnySettingsActive
Checks whether ANY of the debug settings are currently active.
Declaration
public bool AreAnySettingsActive { get; }Property Value
| Type | Description |
|---|---|
| bool |
selectedCamera
Current camera to debug.
Declaration
public Camera selectedCamera { get; set; }Property Value
| Type | Description |
|---|---|
| Camera |
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 |
volumeComponentsPathAndType
List of Volume component types.
Declaration
public List<(string, Type)> volumeComponentsPathAndType { get; }Property Value
| Type | Description |
|---|---|
| List<(string, Type)> |
volumeDebugSettings
Current volume debug settings.
Declaration
[Obsolete("This property has been obsoleted and will be removed in a future version. #from(6000.2)", false)]
public IVolumeDebugSettings volumeDebugSettings { get; }Property Value
| Type | Description |
|---|---|
| IVolumeDebugSettings |
Methods
CreatePanel()
Creates the debug UI panel needed for these debug settings.
Declaration
public IDebugDisplaySettingsPanelDisposable CreatePanel()Returns
| Type | Description |
|---|---|
| IDebugDisplaySettingsPanelDisposable | The debug UI panel created. |
GetVolumeWeight(Volume)
Obtains the volume weight
Declaration
public float GetVolumeWeight(Volume volume)Parameters
| Type | Name | Description |
|---|---|---|
| Volume | volume |
Returns
| Type | Description |
|---|---|
| float | The weight of the volume |
GetVolumesList()
Gets the Volumes List for the current camera and selected volume component
Declaration
public ObservableList<Volume> GetVolumesList()Returns
| Type | Description |
|---|---|
| ObservableList<Volume> | The list of influenced volumes |