docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Struct RenderTargetHandle

    Class for render target handles in URP. Deprecated in favor of RTHandle.

    Namespace: UnityEngine.Rendering.Universal
    Assembly: solution.dll
    Syntax
    public struct RenderTargetHandle

    Constructors

    RenderTargetHandle(RTHandle)

    Constructor for a render target handle.

    Declaration
    public RenderTargetHandle(RTHandle rtHandle)
    Parameters
    Type Name Description
    RTHandle rtHandle

    The rt handle for the new handle.

    RenderTargetHandle(RenderTargetIdentifier)

    Constructor for a render target handle.

    Declaration
    public RenderTargetHandle(RenderTargetIdentifier renderTargetIdentifier)
    Parameters
    Type Name Description
    RenderTargetIdentifier renderTargetIdentifier

    The render target ID for the new handle.

    Fields

    CameraTarget

    The render target handle for the Camera target.

    Declaration
    public static readonly RenderTargetHandle CameraTarget
    Field Value
    Type Description
    RenderTargetHandle

    Properties

    id

    The ID of the handle for the handle.

    Declaration
    public int id { get; set; }
    Property Value
    Type Description
    int

    Methods

    Equals(object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    object obj
    Returns
    Type Description
    bool

    Equals(RenderTargetHandle)

    Equality check with another render target handle.

    Declaration
    public bool Equals(RenderTargetHandle other)
    Parameters
    Type Name Description
    RenderTargetHandle other

    Other render target handle to compare with.

    Returns
    Type Description
    bool

    True if the handles have the same ID, otherwise false.

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int

    HasInternalRenderTargetId()

    Does this handle have internal render target ID?

    Declaration
    public bool HasInternalRenderTargetId()
    Returns
    Type Description
    bool

    True if it has internal render target ID.

    Identifier()

    The render target ID for this render target handle.

    Declaration
    public RenderTargetIdentifier Identifier()
    Returns
    Type Description
    RenderTargetIdentifier

    The render target ID for this render target handle.

    Init(string)

    Initializes the ID for the handle.

    Declaration
    public void Init(string shaderProperty)
    Parameters
    Type Name Description
    string shaderProperty

    The shader property to initialize with.

    Init(RenderTargetIdentifier)

    Initializes the render target ID for the handle.

    Declaration
    public void Init(RenderTargetIdentifier renderTargetIdentifier)
    Parameters
    Type Name Description
    RenderTargetIdentifier renderTargetIdentifier

    The render target ID to initialize with.

    Operators

    operator ==(RenderTargetHandle, RenderTargetHandle)

    Equality check between two render target handles.

    Declaration
    public static bool operator ==(RenderTargetHandle c1, RenderTargetHandle c2)
    Parameters
    Type Name Description
    RenderTargetHandle c1

    First handle for the check.

    RenderTargetHandle c2

    Second handle for the check.

    Returns
    Type Description
    bool

    True if the handles have the same ID, otherwise false.

    operator !=(RenderTargetHandle, RenderTargetHandle)

    Equality check between two render target handles.

    Declaration
    public static bool operator !=(RenderTargetHandle c1, RenderTargetHandle c2)
    Parameters
    Type Name Description
    RenderTargetHandle c1

    First handle for the check.

    RenderTargetHandle c2

    Second handle for the check.

    Returns
    Type Description
    bool

    True if the handles do not have the same ID, otherwise false.

    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)