Class RTHandle | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class RTHandle

    Inheritance
    System.Object
    RTHandle
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ToString()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: UnityEngine.Experimental.Rendering
    Syntax
    public class RTHandle

    Properties

    maxHeight

    Declaration
    public static int maxHeight { get; }
    Property Value
    Type Description
    System.Int32

    maxWidth

    Declaration
    public static int maxWidth { get; }
    Property Value
    Type Description
    System.Int32

    nameID

    Declaration
    public RenderTargetIdentifier nameID { get; }
    Property Value
    Type Description
    RenderTargetIdentifier

    rt

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

    s_MaxHeight

    Declaration
    public static int s_MaxHeight { get; }
    Property Value
    Type Description
    System.Int32

    s_MaxHeightMSAA

    Declaration
    public static int s_MaxHeightMSAA { get; }
    Property Value
    Type Description
    System.Int32

    s_MaxWidth

    Declaration
    public static int s_MaxWidth { get; }
    Property Value
    Type Description
    System.Int32

    s_MaxWidthMSAAA

    Declaration
    public static int s_MaxWidthMSAAA { get; }
    Property Value
    Type Description
    System.Int32

    useScaling

    Declaration
    public bool useScaling { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    Alloc(Int32, Int32, Int32, DepthBits, RenderTextureFormat, FilterMode, TextureWrapMode, TextureDimension, Boolean, Boolean, Boolean, Boolean, Int32, Single, MSAASamples, Boolean, Boolean, VRTextureUsage, RenderTextureMemoryless, String)

    Declaration
    public static RTHandle Alloc(int width, int height, int slices = 1, DepthBits depthBufferBits = DepthBits.None, RenderTextureFormat colorFormat = null, FilterMode filterMode = null, TextureWrapMode wrapMode = null, TextureDimension dimension = null, bool sRGB = true, bool enableRandomWrite = false, bool useMipMap = false, bool autoGenerateMips = true, int anisoLevel = 1, float mipMapBias = 0F, MSAASamples msaaSamples = MSAASamples.None, bool bindTextureMS = false, bool useDynamicScale = false, VRTextureUsage vrUsage = null, RenderTextureMemoryless memoryless = null, string name = "")
    Parameters
    Type Name Description
    System.Int32 width
    System.Int32 height
    System.Int32 slices
    DepthBits depthBufferBits
    RenderTextureFormat colorFormat
    FilterMode filterMode
    TextureWrapMode wrapMode
    TextureDimension dimension
    System.Boolean sRGB
    System.Boolean enableRandomWrite
    System.Boolean useMipMap
    System.Boolean autoGenerateMips
    System.Int32 anisoLevel
    System.Single mipMapBias
    MSAASamples msaaSamples
    System.Boolean bindTextureMS
    System.Boolean useDynamicScale
    VRTextureUsage vrUsage
    RenderTextureMemoryless memoryless
    System.String name
    Returns
    Type Description
    RTHandle

    Alloc(ScaleFunc, DepthBits, RenderTextureFormat, FilterMode, TextureWrapMode, TextureDimension, Boolean, Boolean, Boolean, Boolean, Int32, Single, Boolean, Boolean, Boolean, VRTextureUsage, RenderTextureMemoryless, String)

    Declaration
    public static RTHandle Alloc(ScaleFunc scaleFunc, DepthBits depthBufferBits = DepthBits.None, RenderTextureFormat colorFormat = null, FilterMode filterMode = null, TextureWrapMode wrapMode = null, TextureDimension dimension = null, bool sRGB = true, bool enableRandomWrite = false, bool useMipMap = false, bool autoGenerateMips = true, int anisoLevel = 1, float mipMapBias = 0F, bool enableMSAA = false, bool bindTextureMS = false, bool useDynamicScale = false, VRTextureUsage vrUsage = null, RenderTextureMemoryless memoryless = null, string name = "")
    Parameters
    Type Name Description
    ScaleFunc scaleFunc
    DepthBits depthBufferBits
    RenderTextureFormat colorFormat
    FilterMode filterMode
    TextureWrapMode wrapMode
    TextureDimension dimension
    System.Boolean sRGB
    System.Boolean enableRandomWrite
    System.Boolean useMipMap
    System.Boolean autoGenerateMips
    System.Int32 anisoLevel
    System.Single mipMapBias
    System.Boolean enableMSAA
    System.Boolean bindTextureMS
    System.Boolean useDynamicScale
    VRTextureUsage vrUsage
    RenderTextureMemoryless memoryless
    System.String name
    Returns
    Type Description
    RTHandle

    Alloc(Vector2, DepthBits, RenderTextureFormat, FilterMode, TextureWrapMode, TextureDimension, Boolean, Boolean, Boolean, Boolean, Int32, Single, Boolean, Boolean, Boolean, VRTextureUsage, RenderTextureMemoryless, String)

    Declaration
    public static RTHandle Alloc(Vector2 scaleFactor, DepthBits depthBufferBits = DepthBits.None, RenderTextureFormat colorFormat = null, FilterMode filterMode = null, TextureWrapMode wrapMode = null, TextureDimension dimension = null, bool sRGB = true, bool enableRandomWrite = false, bool useMipMap = false, bool autoGenerateMips = true, int anisoLevel = 1, float mipMapBias = 0F, bool enableMSAA = false, bool bindTextureMS = false, bool useDynamicScale = false, VRTextureUsage vrUsage = null, RenderTextureMemoryless memoryless = null, string name = "")
    Parameters
    Type Name Description
    Vector2 scaleFactor
    DepthBits depthBufferBits
    RenderTextureFormat colorFormat
    FilterMode filterMode
    TextureWrapMode wrapMode
    TextureDimension dimension
    System.Boolean sRGB
    System.Boolean enableRandomWrite
    System.Boolean useMipMap
    System.Boolean autoGenerateMips
    System.Int32 anisoLevel
    System.Single mipMapBias
    System.Boolean enableMSAA
    System.Boolean bindTextureMS
    System.Boolean useDynamicScale
    VRTextureUsage vrUsage
    RenderTextureMemoryless memoryless
    System.String name
    Returns
    Type Description
    RTHandle

    DumpRTInfo()

    Declaration
    public static string DumpRTInfo()
    Returns
    Type Description
    System.String

    GetScaledSize(Vector2Int)

    Declaration
    public Vector2Int GetScaledSize(Vector2Int refSize)
    Parameters
    Type Name Description
    Vector2Int refSize
    Returns
    Type Description
    Vector2Int

    Initialize(Int32, Int32, Boolean, MSAASamples)

    Declaration
    public static void Initialize(int width, int height, bool scaledRTsupportsMSAA, MSAASamples scaledRTMSAASamples)
    Parameters
    Type Name Description
    System.Int32 width
    System.Int32 height
    System.Boolean scaledRTsupportsMSAA
    MSAASamples scaledRTMSAASamples

    Release()

    Declaration
    public void Release()

    Release(RTHandle)

    Declaration
    public static void Release(RTHandle rth)
    Parameters
    Type Name Description
    RTHandle rth

    ResetReferenceSize(Int32, Int32, Boolean, MSAASamples)

    Declaration
    public static void ResetReferenceSize(int width, int height, bool msaa, MSAASamples msaaSamples)
    Parameters
    Type Name Description
    System.Int32 width
    System.Int32 height
    System.Boolean msaa
    MSAASamples msaaSamples

    SetReferenceSize(Int32, Int32, Boolean, MSAASamples)

    Declaration
    public static void SetReferenceSize(int width, int height, bool msaa, MSAASamples msaaSamples)
    Parameters
    Type Name Description
    System.Int32 width
    System.Int32 height
    System.Boolean msaa
    MSAASamples msaaSamples

    Operators

    Implicit(RTHandle to RenderTargetIdentifier)

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

    Implicit(RTHandle to RenderTexture)

    Declaration
    public static implicit operator RenderTexture(RTHandle handle)
    Parameters
    Type Name Description
    RTHandle handle
    Returns
    Type Description
    RenderTexture
    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