docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class RTHandle

    Provides a utility class for safely managing the lifetime of a RenderTexture.

    Inheritance
    object
    RTHandle
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEditor.TerrainTools
    Assembly: Unity.TerrainTools.Editor.dll
    Syntax
    public class RTHandle

    Properties

    Desc

    The descriptor for the RTHandle and RenderTexture.

    Declaration
    public RenderTextureDescriptor Desc { get; }
    Property Value
    Type Description
    RenderTextureDescriptor

    Name

    The name for the RTHandle and RenderTexture.

    Declaration
    public string Name { get; set; }
    Property Value
    Type Description
    string

    RT

    The RenderTexture for this RTHandle.

    Declaration
    public RenderTexture RT { get; }
    Property Value
    Type Description
    RenderTexture

    Methods

    Scoped()

    Gets a new disposable RTHandle.RTHandleScope instance to use within using blocks.

    Declaration
    public RTHandle.RTHandleScope Scoped()
    Returns
    Type Description
    RTHandle.RTHandleScope

    Returns a new RTHandleScope instance.

    WithName(string)

    Sets the name of the RenderTexture, and returns a reference to this RTHandle.

    Declaration
    public RTHandle WithName(string name)
    Parameters
    Type Name Description
    string name

    The name of the underlying RenderTexture.

    Returns
    Type Description
    RTHandle

    Returns a reference to this RTHandle.

    Operators

    implicit operator RenderTexture(RTHandle)

    Converts the RTHandle to a RenderTexture type.

    Declaration
    public static implicit operator RenderTexture(RTHandle handle)
    Parameters
    Type Name Description
    RTHandle handle

    The RTHandle to convert.

    Returns
    Type Description
    RenderTexture

    Returns a RenderTexture handle.

    implicit operator Texture(RTHandle)

    Converts the RTHandle to a Texture type.

    Declaration
    public static implicit operator Texture(RTHandle handle)
    Parameters
    Type Name Description
    RTHandle handle

    The RTHandle to convert.

    Returns
    Type Description
    Texture

    Returns a RenderTexture handle.

    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)