docs.unity3d.com
    Show / Hide Table of Contents

    Class VolumeDebugSettings<T>

    Volume debug settings

    Inheritance
    Object
    VolumeDebugSettings<T>
    Namespace: UnityEngine.Rendering
    Syntax
    public abstract class VolumeDebugSettings<T> : IVolumeDebugSettings where T : MonoBehaviour, IAdditionalData
    Type Parameters
    Name Description
    T

    The type of additional camera data

    Fields

    m_SelectedCameraIndex

    Selected camera index.

    Declaration
    protected int m_SelectedCameraIndex
    Field Value
    Type Description
    Int32

    Properties

    additionalCameraDatas

    The additional camera datas list

    Declaration
    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>
    Implements
    IVolumeDebugSettings.cameras

    componentTypes

    List of Volume component types.

    Declaration
    public List<(string, Type)> componentTypes { get; }
    Property Value
    Type Description
    List<(T1, T2)<String, Type>>
    Implements
    IVolumeDebugSettings.componentTypes

    selectedCamera

    Current camera to debug.

    Declaration
    public Camera selectedCamera { get; }
    Property Value
    Type Description
    Camera
    Implements
    IVolumeDebugSettings.selectedCamera

    selectedCameraIndex

    Selected camera index.

    Declaration
    public int selectedCameraIndex { get; set; }
    Property Value
    Type Description
    Int32
    Implements
    IVolumeDebugSettings.selectedCameraIndex

    selectedCameraLayerMask

    Selected camera volume layer mask.

    Declaration
    public abstract LayerMask selectedCameraLayerMask { get; }
    Property Value
    Type Description
    LayerMask
    Implements
    IVolumeDebugSettings.selectedCameraLayerMask

    selectedCameraPosition

    Selected camera volume position.

    Declaration
    public abstract Vector3 selectedCameraPosition { get; }
    Property Value
    Type Description
    Vector3
    Implements
    IVolumeDebugSettings.selectedCameraPosition

    selectedCameraVolumeStack

    Selected camera volume stack.

    Declaration
    public abstract VolumeStack selectedCameraVolumeStack { get; }
    Property Value
    Type Description
    VolumeStack
    Implements
    IVolumeDebugSettings.selectedCameraVolumeStack

    selectedComponent

    Current volume component to debug.

    Declaration
    public int selectedComponent { get; set; }
    Property Value
    Type Description
    Int32
    Implements
    IVolumeDebugSettings.selectedComponent

    selectedComponentType

    Type of the current component to debug.

    Declaration
    public Type selectedComponentType { get; set; }
    Property Value
    Type Description
    Type
    Implements
    IVolumeDebugSettings.selectedComponentType

    targetRenderPipeline

    Specifies the render pipeline for this volume settings

    Declaration
    public abstract Type targetRenderPipeline { get; }
    Property Value
    Type Description
    Type
    Implements
    IVolumeDebugSettings.targetRenderPipeline

    Methods

    GetVolumes()

    Get an array of volumes on the selectedCameraLayerMask

    Declaration
    public Volume[] GetVolumes()
    Returns
    Type Description
    Volume[]

    An array of volumes sorted by influence.

    Implements
    IVolumeDebugSettings.GetVolumes()

    GetVolumeWeight(Volume)

    Obtains the volume weight

    Declaration
    public float GetVolumeWeight(Volume volume)
    Parameters
    Type Name Description
    Volume volume Volume
    Returns
    Type Description
    Single

    The weight of the volume

    Implements
    IVolumeDebugSettings.GetVolumeWeight(Volume)

    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
    Boolean

    If the volumes have been refreshed

    Implements
    IVolumeDebugSettings.RefreshVolumes(Volume[])

    RegisterCamera(T)

    Register the camera for the Volume Debug.

    Declaration
    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
    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
    Boolean

    If the volume has influence

    Implements
    IVolumeDebugSettings.VolumeHasInfluence(Volume)

    Extension Methods

    ReflectionUtils.Invoke(Object, String, Object[])
    ReflectionUtils.SetField(Object, String, Object)
    ReflectionUtils.GetField(Object, String)
    ReflectionUtils.GetFields(Object)
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023