Interface IVolumeDebugSettings
Volume debug settings.
Namespace: UnityEngine.Rendering
Syntax
public interface IVolumeDebugSettingsProperties
cameras
Returns the collection of registered cameras.
Declaration
IEnumerable<Camera> cameras { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<Camera> |
componentTypes
List of Volume component types and their path
Declaration
List<(string, Type)> componentTypes { get; }Property Value
| Type | Description |
|---|---|
| List<(T1, T2)<String, Type>> |
selectedCamera
Current camera to debug.
Declaration
Camera selectedCamera { get; }Property Value
| Type | Description |
|---|---|
| Camera |
selectedCameraIndex
Selected camera index.
Declaration
int selectedCameraIndex { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
selectedCameraLayerMask
Selected camera volume layer mask.
Declaration
LayerMask selectedCameraLayerMask { get; }Property Value
| Type | Description |
|---|---|
| LayerMask |
selectedCameraPosition
Selected camera volume position.
Declaration
Vector3 selectedCameraPosition { get; }Property Value
| Type | Description |
|---|---|
| Vector3 |
selectedCameraVolumeStack
Selected camera volume stack.
Declaration
VolumeStack selectedCameraVolumeStack { get; }Property Value
| Type | Description |
|---|---|
| VolumeStack |
selectedComponent
Selected component.
Declaration
int selectedComponent { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
selectedComponentType
Type of the current component to debug.
Declaration
Type selectedComponentType { get; set; }Property Value
| Type | Description |
|---|---|
| Type |
targetRenderPipeline
Specifies the render pipelie
Declaration
Type targetRenderPipeline { get; }Property Value
| Type | Description |
|---|---|
| Type |
Methods
GetVolumes()
Obtains the Volumes
Declaration
Volume[] GetVolumes()Returns
| Type | Description |
|---|---|
| Volume[] | The list of Volume |
GetVolumeWeight(Volume)
Obtains the volume weight
Declaration
float GetVolumeWeight(Volume volume)Parameters
| Type | Name | Description |
|---|---|---|
| Volume | volume | Volume |
Returns
| Type | Description |
|---|---|
| Single | The weight of the volume |
RefreshVolumes(Volume[])
Refreshes the volumes, fetches the stored volumes on the panel
Declaration
bool RefreshVolumes(Volume[] newVolumes)Parameters
| Type | Name | Description |
|---|---|---|
| Volume[] | newVolumes | The list of Volume to refresh |
Returns
| Type | Description |
|---|---|
| Boolean | If the volumes have been refreshed |
VolumeHasInfluence(Volume)
Return if the Volume has influence
Declaration
bool VolumeHasInfluence(Volume volume)Parameters
| Type | Name | Description |
|---|---|---|
| Volume | volume | Volume to check the influence |
Returns
| Type | Description |
|---|---|
| Boolean | If the volume has influence |