docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class HDAdditionalCameraData

    Additional component that holds HDRP specific parameters for Cameras.

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    HDAdditionalCameraData
    Implements
    IVersionable<HDAdditionalCameraData.Version>
    IDebugData
    IAdditionalData
    Inherited Members
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(string, float)
    MonoBehaviour.InvokeRepeating(string, float, float)
    MonoBehaviour.CancelInvoke(string)
    MonoBehaviour.IsInvoking(string)
    MonoBehaviour.StartCoroutine(string)
    MonoBehaviour.StartCoroutine(string, object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(string)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(object)
    MonoBehaviour.destroyCancellationToken
    MonoBehaviour.useGUILayout
    MonoBehaviour.didStart
    MonoBehaviour.didAwake
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, out Component)
    Component.TryGetComponent<T>(out T)
    Component.GetComponent(string)
    Component.GetComponentInChildren(Type, bool)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(bool)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, bool)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(bool)
    Component.GetComponentsInChildren<T>(bool, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type, bool)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>(bool)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, bool)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(bool)
    Component.GetComponentsInParent<T>(bool, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(string)
    Component.SendMessageUpwards(string, object, SendMessageOptions)
    Component.SendMessageUpwards(string, object)
    Component.SendMessageUpwards(string)
    Component.SendMessageUpwards(string, SendMessageOptions)
    Component.SendMessage(string, object)
    Component.SendMessage(string)
    Component.SendMessage(string, object, SendMessageOptions)
    Component.SendMessage(string, SendMessageOptions)
    Component.BroadcastMessage(string, object, SendMessageOptions)
    Component.BroadcastMessage(string, object)
    Component.BroadcastMessage(string)
    Component.BroadcastMessage(string, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: UnityEngine.Rendering.HighDefinition
    Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
    Syntax
    [AddComponentMenu("")]
    [DisallowMultipleComponent]
    [ExecuteAlways]
    [RequireComponent(typeof(Camera))]
    public class HDAdditionalCameraData : MonoBehaviour, IVersionable<HDAdditionalCameraData.Version>, IDebugData, IAdditionalData

    Fields

    Name Description
    SMAAQuality

    Quality of the anti-aliasing when using SMAA.

    TAAQuality

    Quality of the anti-aliasing when using TAA.

    allowDeepLearningSuperSampling

    Allow NVIDIA Deep Learning Super Sampling (DLSS) on this camera.

    allowDynamicResolution

    Allows dynamic resolution on buffers linked to this camera.

    antialiasing

    Anti-aliasing mode.

    backgroundColorHDR

    HDR color used for clearing the camera background.

    clearColorMode

    Clear mode for the camera background.

    clearDepth

    Clear depth as well as color.

    customRenderingSettings

    Allows you to override the default frame settings for this camera.

    deepLearningSuperSamplingQuality

    Selects a performance quality setting for NVIDIA Deep Learning Super Sampling (DLSS) for this camera of this project.

    deepLearningSuperSamplingSharpening

    Sets the Sharpening value for NVIDIA Deep Learning Super Sampling (DLSS) for this camera.

    deepLearningSuperSamplingUseCustomAttributes

    If set to true, NVIDIA Deep Learning Super Sampling (DLSS) will utilize the Quality setting set on this camera instead of the one specified in the quality asset of this project.

    deepLearningSuperSamplingUseCustomQualitySettings

    If set to true, NVIDIA Deep Learning Super Sampling (DLSS) will utilize the Quality setting set on this camera instead of the one specified in the quality asset.

    deepLearningSuperSamplingUseOptimalSettings

    Sets the sharpness and scale automatically for NVIDIA Deep Learning Super Sampling (DLSS) for this camera, depending on the values of quality settings.

    defaultFrameSettings

    When using default frame settings, specify which type of frame settings to use.

    dithering

    Use dithering to filter out minor banding.

    exposureTarget

    The object used as a target for centering the Exposure's Procedural Mask metering mode when target object option is set (See Exposure Volume Component).

    flipYMode

    Vertical flip mode.

    fsrOverrideSharpness

    If set to true, AMD FidelityFX Super Resolution (FSR) will utilize the sharpness setting set on this camera instead of the one specified in the quality asset.

    fsrSharpness

    Sets this camera's sharpness value for AMD FidelityFX Super Resolution.

    fullscreenPassthrough

    Skips rendering settings to directly render in fullscreen (Useful for video).

    hasPersistentHistory

    Enable to retain history buffers even if the camera is disabled.

    invertFaceCulling

    Invert face culling.

    materialMipBias

    Mip bias used on texture samplers during material rendering

    nonObliqueProjectionGetter

    Specify a custom getter for non oblique projection matrix.

    physicalParameters

    Physical camera parameters.

    probeLayerMask

    Probe layer mask.

    renderingPathCustomFrameSettingsOverrideMask

    Mask specifying which frame settings are overridden when using custom frame settings.

    screenCoordScaleBias

    Transform used when Screen Coordinates Override is active.

    screenSizeOverride

    Screen size used when Screen Coordinates Override is active.

    stopNaNs

    Use a pass to eliminate NaNs contained in the color buffer before post-processing.

    taaAntiFlicker

    Drive the anti-flicker mechanism. With high values flickering might be reduced, but it can lead to more ghosting or disocclusion artifacts.

    taaAntiHistoryRinging

    When enabled, ringing artifacts (dark or strangely saturated edges) caused by history sharpening will be improved. This comes at a potential loss of sharpness upon motion.

    taaBaseBlendFactor

    Determines how much the history buffer is blended together with current frame result. Higher values means more history contribution.

    taaHistorySharpening

    Strength of the sharpening of the history sampled for TAA.

    taaJitterScale

    Scale to apply to the jittering applied when TAA is enabled.

    taaMotionVectorRejection

    Larger is this value, more likely history will be rejected when current and reprojected history motion vector differ by a substantial amount. Larger values can decrease ghosting but will also reintroduce aliasing on the aforementioned cases.

    taaRingingReduction

    How much to reduce the ringing from the TAA post-process sharpening. Note that some ringing might be visually desirable and that any value different than 0 will incur into a small additional cost.

    taaSharpenMode

    How is the sharpening run sharpening.

    taaSharpenStrength

    Strength of the sharpening component of temporal anti-aliasing.

    volumeAnchorOverride

    Optional transform override for the position where volumes are interpolated.

    volumeLayerMask

    Layer mask used to select which volumes will influence this camera.

    xrRendering

    Enable XR rendering.

    Properties

    Name Description
    aovRequests

    Use this property to get the aov requests.

    It is never null.

    hasCustomRender

    True if any Custom Render event is registered for this camera.

    isEditorCameraPreview

    Unity support two type of preview: Camera preview and material preview. This property allow to know that we are an editor camera preview when the type is preview.

    renderingPathCustomFrameSettings

    Custom frame settings.

    Methods

    Name Description
    CopyTo(HDAdditionalCameraData)

    Copy HDAdditionalCameraData.

    GetGraphicsBuffer(BufferAccessType)

    Returns the requested graphics buffer. Users should use the requestGraphicsBuffer event to make sure that the required buffers are requested first. Note that depending on the current frame settings some buffers may not be available.

    GetNonObliqueProjection(Camera)

    Returns the non oblique projection matrix for this camera.

    SetAOVRequests(AOVRequestDataCollection)

    Set AOV requests to use.

    Events

    Name Description
    customRender

    Event used to override HDRP rendering for this particular camera.

    requestGraphicsBuffer

    RequestAccessDelegate used to request access to various buffers of this camera.

    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)