docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class VolumeDebugSettings<T>

    The volume settings

    Inheritance
    object
    VolumeDebugSettings<T>
    Implements
    IVolumeDebugSettings2
    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> : IVolumeDebugSettings2, IVolumeDebugSettings where T : MonoBehaviour, IAdditionalData
    Type Parameters
    Name Description
    T

    A MonoBehaviour with IAdditionalData

    Fields

    Name Description
    m_SelectedCameraIndex

    The selected camera index, use the property for better handling

    Properties

    Name Description
    additionalCameraDatas

    The list of the additional camera datas

    cameras

    Returns the collection of registered cameras.

    componentTypes

    List of Volume component types.

    selectedCamera

    Current camera to debug.

    selectedCameraIndex

    Selected camera index.

    selectedCameraLayerMask

    Selected camera volume layer mask.

    selectedCameraPosition

    Selected camera volume position.

    selectedCameraVolumeStack

    Selected camera volume stack.

    selectedComponent

    Current volume component to debug.

    selectedComponentType

    Type of the current component to debug.

    targetRenderPipeline

    Specifies the render pipeline for this volume settings

    volumeComponentsPathAndType

    List of Volume component types.

    Methods

    Name Description
    ComponentDisplayName(Type)

    Returns the name of a component from its VolumeComponentMenuForRenderPipeline.

    GetVolumeWeight(Volume)

    Obtains the volume weight

    GetVolumes()

    Get an array of volumes on the selectedCameraLayerMask

    RefreshVolumes(Volume[])

    Refreshes the volumes, fetches the stored volumes on the panel

    RegisterCamera(T)

    Register the camera for the Volume Debug.

    UnRegisterCamera(T)

    Unregister the camera for the Volume Debug.

    VolumeHasInfluence(Volume)

    Return if the Volume has influence

    Extension Methods

    AnalyticsUtils.ToNestedColumnWithDefault<T>(T, T, bool)
    In This Article
    Back to top
    Copyright © 2023 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)