Class HDCamera | High Definition RP | 6.5.3-preview
docs.unity3d.com
    Show / Hide Table of Contents

    Class HDCamera

    Inheritance
    Object
    HDCamera
    Namespace: UnityEngine.Experimental.Rendering.HDPipeline
    Syntax
    public class HDCamera

    Constructors

    HDCamera(Camera)

    Declaration
    public HDCamera(Camera cam)
    Parameters
    Type Name Description
    Camera cam

    Fields

    camera

    Declaration
    public Camera camera
    Field Value
    Type Description
    Camera

    colorPyramidHistoryIsValid

    Declaration
    public bool colorPyramidHistoryIsValid
    Field Value
    Type Description
    Boolean

    colorPyramidHistoryMipCount

    Declaration
    public int colorPyramidHistoryMipCount
    Field Value
    Type Description
    Int32

    finalViewport

    Declaration
    public Rect finalViewport
    Field Value
    Type Description
    Rect

    frustum

    Declaration
    public Frustum frustum
    Field Value
    Type Description
    Frustum

    frustumPlaneEquations

    Declaration
    public Vector4[] frustumPlaneEquations
    Field Value
    Type Description
    Vector4[]

    nonJitteredProjMatrix

    Declaration
    public Matrix4x4 nonJitteredProjMatrix
    Field Value
    Type Description
    Matrix4x4

    numEyes

    Declaration
    public uint numEyes
    Field Value
    Type Description
    UInt32

    prevViewProjMatrix

    Declaration
    public Matrix4x4 prevViewProjMatrix
    Field Value
    Type Description
    Matrix4x4

    prevViewProjMatrixNoCameraTrans

    Declaration
    public Matrix4x4 prevViewProjMatrixNoCameraTrans
    Field Value
    Type Description
    Matrix4x4

    prevViewProjMatrixStereo

    Declaration
    public Matrix4x4[] prevViewProjMatrixStereo
    Field Value
    Type Description
    Matrix4x4[]

    prevWorldSpaceCameraPos

    Declaration
    public Vector3 prevWorldSpaceCameraPos
    Field Value
    Type Description
    Vector3

    projectionParams

    Declaration
    public Vector4 projectionParams
    Field Value
    Type Description
    Vector4

    projMatrix

    Declaration
    public Matrix4x4 projMatrix
    Field Value
    Type Description
    Matrix4x4

    projMatrixStereo

    Declaration
    public Matrix4x4[] projMatrixStereo
    Field Value
    Type Description
    Matrix4x4[]

    screenParams

    Declaration
    public Vector4 screenParams
    Field Value
    Type Description
    Vector4

    screenSize

    Declaration
    public Vector4 screenSize
    Field Value
    Type Description
    Vector4

    taaFrameIndex

    Declaration
    public int taaFrameIndex
    Field Value
    Type Description
    Int32

    taaFrameRotation

    Declaration
    public Vector2 taaFrameRotation
    Field Value
    Type Description
    Vector2

    taaJitter

    Declaration
    public Vector4 taaJitter
    Field Value
    Type Description
    Vector4

    textureWidthScaling

    Declaration
    public Vector4 textureWidthScaling
    Field Value
    Type Description
    Vector4

    unity_OrthoParams

    Declaration
    public Vector4 unity_OrthoParams
    Field Value
    Type Description
    Vector4

    vBufferParams

    Declaration
    public VolumetricLightingSystem.VBufferParameters[] vBufferParams
    Field Value
    Type Description
    VolumetricLightingSystem.VBufferParameters[]

    viewMatrix

    Declaration
    public Matrix4x4 viewMatrix
    Field Value
    Type Description
    Matrix4x4

    viewMatrixStereo

    Declaration
    public Matrix4x4[] viewMatrixStereo
    Field Value
    Type Description
    Matrix4x4[]

    volumeAnchor

    Declaration
    public Transform volumeAnchor
    Field Value
    Type Description
    Transform

    volumeLayerMask

    Declaration
    public int volumeLayerMask
    Field Value
    Type Description
    Int32

    volumetricHistoryIsValid

    Declaration
    public bool volumetricHistoryIsValid
    Field Value
    Type Description
    Boolean

    worldSpaceCameraPos

    Declaration
    public Vector3 worldSpaceCameraPos
    Field Value
    Type Description
    Vector3

    zBufferParams

    Declaration
    public Vector4 zBufferParams
    Field Value
    Type Description
    Vector4

    Properties

    actualHeight

    Declaration
    public int actualHeight { get; }
    Property Value
    Type Description
    Int32

    actualWidth

    Declaration
    public int actualWidth { get; }
    Property Value
    Type Description
    Int32

    antialiasing

    Declaration
    public HDAdditionalCameraData.AntialiasingMode antialiasing { get; }
    Property Value
    Type Description
    HDAdditionalCameraData.AntialiasingMode

    backgroundColorHDR

    Declaration
    public Color backgroundColorHDR { get; }
    Property Value
    Type Description
    Color

    clearColorMode

    Declaration
    public HDAdditionalCameraData.ClearColorMode clearColorMode { get; }
    Property Value
    Type Description
    HDAdditionalCameraData.ClearColorMode

    clearDepth

    Declaration
    public bool clearDepth { get; }
    Property Value
    Type Description
    Boolean

    dithering

    Declaration
    public bool dithering { get; }
    Property Value
    Type Description
    Boolean

    doubleBufferedViewportScale

    Declaration
    public Vector4 doubleBufferedViewportScale { get; }
    Property Value
    Type Description
    Vector4

    flipYMode

    Declaration
    public HDAdditionalCameraData.FlipYMode flipYMode { get; }
    Property Value
    Type Description
    HDAdditionalCameraData.FlipYMode

    frameSettings

    Declaration
    public FrameSettings frameSettings { get; }
    Property Value
    Type Description
    FrameSettings

    invertFaceCulling

    Declaration
    public bool invertFaceCulling { get; }
    Property Value
    Type Description
    Boolean

    invProjParam

    Declaration
    public Vector4 invProjParam { get; }
    Property Value
    Type Description
    Vector4

    isFirstFrame

    Declaration
    public bool isFirstFrame { get; }
    Property Value
    Type Description
    Boolean

    isMainGameView

    Declaration
    public bool isMainGameView { get; }
    Property Value
    Type Description
    Boolean

    msaaSamples

    Declaration
    public MSAASamples msaaSamples { get; }
    Property Value
    Type Description
    MSAASamples

    nonJitteredViewProjMatrix

    Declaration
    public Matrix4x4 nonJitteredViewProjMatrix { get; }
    Property Value
    Type Description
    Matrix4x4

    nonObliqueProjMatrix

    Declaration
    public Matrix4x4 nonObliqueProjMatrix { get; }
    Property Value
    Type Description
    Matrix4x4

    physicalParameters

    Declaration
    public HDPhysicalCamera physicalParameters { get; }
    Property Value
    Type Description
    HDPhysicalCamera

    probeLayerMask

    Declaration
    public LayerMask probeLayerMask { get; }
    Property Value
    Type Description
    LayerMask

    stopNaNs

    Declaration
    public bool stopNaNs { get; }
    Property Value
    Type Description
    Boolean

    viewportScale

    Declaration
    public Vector2 viewportScale { get; }
    Property Value
    Type Description
    Vector2

    viewportSizePrevFrame

    Declaration
    public Vector2Int viewportSizePrevFrame { get; }
    Property Value
    Type Description
    Vector2Int

    viewProjMatrix

    Declaration
    public Matrix4x4 viewProjMatrix { get; }
    Property Value
    Type Description
    Matrix4x4

    Methods

    AllocHistoryFrameRT(Int32, Func<String, Int32, RTHandleSystem, RTHandleSystem.RTHandle>, Int32)

    Declaration
    public RTHandleSystem.RTHandle AllocHistoryFrameRT(int id, Func<string, int, RTHandleSystem, RTHandleSystem.RTHandle> allocator, int bufferCount)
    Parameters
    Type Name Description
    Int32 id
    Func<String, Int32, RTHandleSystem, RTHandleSystem.RTHandle> allocator
    Int32 bufferCount
    Returns
    Type Description
    RTHandleSystem.RTHandle

    CleanUnused()

    Declaration
    public static void CleanUnused()

    ClearAll()

    Declaration
    public static void ClearAll()

    Create(Camera)

    Declaration
    public static HDCamera Create(Camera camera)
    Parameters
    Type Name Description
    Camera camera
    Returns
    Type Description
    HDCamera

    Get(Camera)

    Declaration
    public static HDCamera Get(Camera camera)
    Parameters
    Type Name Description
    Camera camera
    Returns
    Type Description
    HDCamera

    GetCurrentFrameRT(Int32)

    Declaration
    public RTHandleSystem.RTHandle GetCurrentFrameRT(int id)
    Parameters
    Type Name Description
    Int32 id
    Returns
    Type Description
    RTHandleSystem.RTHandle

    GetPreviousFrameRT(Int32)

    Declaration
    public RTHandleSystem.RTHandle GetPreviousFrameRT(int id)
    Parameters
    Type Name Description
    Int32 id
    Returns
    Type Description
    RTHandleSystem.RTHandle

    GetViewID()

    Declaration
    public long GetViewID()
    Returns
    Type Description
    Int64

    GetViewProjMatrixStereo(UInt32)

    Declaration
    public Matrix4x4 GetViewProjMatrixStereo(uint eyeIndex)
    Parameters
    Type Name Description
    UInt32 eyeIndex
    Returns
    Type Description
    Matrix4x4

    IsTAAEnabled()

    Declaration
    public bool IsTAAEnabled()
    Returns
    Type Description
    Boolean

    Reset()

    Declaration
    public void Reset()

    SetupGlobalParams(CommandBuffer, Single, Single, UInt32)

    Declaration
    public void SetupGlobalParams(CommandBuffer cmd, float time, float lastTime, uint frameCount)
    Parameters
    Type Name Description
    CommandBuffer cmd
    Single time
    Single lastTime
    UInt32 frameCount

    SetupGlobalStereoParams(CommandBuffer)

    Declaration
    public void SetupGlobalStereoParams(CommandBuffer cmd)
    Parameters
    Type Name Description
    CommandBuffer cmd

    Update(FrameSettings, VolumetricLightingSystem, MSAASamples)

    Declaration
    public void Update(FrameSettings currentFrameSettings, VolumetricLightingSystem vlSys, MSAASamples msaaSamples)
    Parameters
    Type Name Description
    FrameSettings currentFrameSettings
    VolumetricLightingSystem vlSys
    MSAASamples msaaSamples

    UpdateStereoDependentState(ref ScriptableCullingParameters)

    Declaration
    public void UpdateStereoDependentState(ref ScriptableCullingParameters cullingParams)
    Parameters
    Type Name Description
    ScriptableCullingParameters cullingParams
    Back to top
    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