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

    Class RTHandleSystem

    Inheritance
    System.Object
    RTHandleSystem
    Namespace: UnityEngine.Rendering
    Syntax
    public class RTHandleSystem : IDisposable

    Constructors

    RTHandleSystem()

    Declaration
    public RTHandleSystem()

    Properties

    rtHandleProperties

    Declaration
    public RTHandleProperties rtHandleProperties { get; }
    Property Value
    Type Description
    RTHandleProperties

    Methods

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

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

    Alloc(Texture)

    Declaration
    public RTHandle Alloc(Texture texture)
    Parameters
    Type Name Description
    Texture texture
    Returns
    Type Description
    RTHandle

    Alloc(RTHandle)

    Declaration
    public static RTHandle Alloc(RTHandle tex)
    Parameters
    Type Name Description
    RTHandle tex
    Returns
    Type Description
    RTHandle

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

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

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

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

    DemandResize(RTHandle)

    Declaration
    public void DemandResize(RTHandle rth)
    Parameters
    Type Name Description
    RTHandle rth

    Dispose()

    Declaration
    public void Dispose()

    DumpRTInfo()

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

    GetMaxHeight()

    Declaration
    public int GetMaxHeight()
    Returns
    Type Description
    System.Int32

    GetMaxWidth()

    Declaration
    public int GetMaxWidth()
    Returns
    Type Description
    System.Int32

    Initialize(Int32, Int32, Boolean, MSAASamples)

    Declaration
    public 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(RTHandle)

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

    SetHardwareDynamicResolutionState(Boolean)

    Declaration
    public void SetHardwareDynamicResolutionState(bool enableHWDynamicRes)
    Parameters
    Type Name Description
    System.Boolean enableHWDynamicRes

    SetReferenceSize(Int32, Int32, MSAASamples)

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

    SwitchResizeMode(RTHandle, RTHandleSystem.ResizeMode)

    Declaration
    public void SwitchResizeMode(RTHandle rth, RTHandleSystem.ResizeMode mode)
    Parameters
    Type Name Description
    RTHandle rth
    RTHandleSystem.ResizeMode mode
    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