docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Struct RTHandleAllocInfo

    Information about the allocation of a RTHandle

    Inherited Members
    ValueType.Equals(object)
    ValueType.GetHashCode()
    ValueType.ToString()
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: UnityEngine.Rendering
    Assembly: Unity.RenderPipelines.Core.Runtime.dll
    Syntax
    public struct RTHandleAllocInfo

    Constructors

    RTHandleAllocInfo(string)

    RTHandleAllocInfo constructor.

    Declaration
    public RTHandleAllocInfo(string name = "")
    Parameters
    Type Name Description
    string name

    Name of the RTHandle.

    Properties

    anisoLevel

    Anisotropic filtering level.

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

    autoGenerateMips

    Set to true to automatically generate mipmaps.

    Declaration
    public bool autoGenerateMips { readonly get; set; }
    Property Value
    Type Description
    bool

    bindTextureMS

    Set to true if the texture needs to be bound as a multisampled texture in the shader.

    Declaration
    public bool bindTextureMS { readonly get; set; }
    Property Value
    Type Description
    bool

    dimension

    Texture dimension of the RTHandle.

    Declaration
    public TextureDimension dimension { readonly get; set; }
    Property Value
    Type Description
    TextureDimension

    enableRandomWrite

    Set to true to enable UAV random read writes on the texture.

    Declaration
    public bool enableRandomWrite { readonly get; set; }
    Property Value
    Type Description
    bool

    enableShadingRate

    Set to true if the texture is to be used as a shading rate image.

    Declaration
    public bool enableShadingRate { readonly get; set; }
    Property Value
    Type Description
    bool
    Remarks

    Width and height are usually in pixels but if enableShadingRate is set to true, width and height are in tiles. See also Variable Rate Shading.

    filterMode

    Filtering mode of the RTHandle.

    Declaration
    public FilterMode filterMode { readonly get; set; }
    Property Value
    Type Description
    FilterMode

    format

    GraphicsFormat of a color buffer.

    Declaration
    public GraphicsFormat format { readonly get; set; }
    Property Value
    Type Description
    GraphicsFormat

    isShadowMap

    Set to true if the texture is sampled as a shadow map.

    Declaration
    public bool isShadowMap { readonly get; set; }
    Property Value
    Type Description
    bool

    memoryless

    Use this property to set the render texture memoryless modes.

    Declaration
    public RenderTextureMemoryless memoryless { readonly get; set; }
    Property Value
    Type Description
    RenderTextureMemoryless

    mipMapBias

    Bias applied to mipmaps during filtering.

    Declaration
    public float mipMapBias { readonly get; set; }
    Property Value
    Type Description
    float

    msaaSamples

    Number of MSAA samples for the RTHandle.

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

    name

    Name of the RTHandle.

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

    slices

    Number of slices of the RTHandle.

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

    useDynamicScale

    See Dynamic Resolution documentation](https://docs.unity3d.com/Manual/DynamicResolution.html)

    Declaration
    public bool useDynamicScale { readonly get; set; }
    Property Value
    Type Description
    bool

    useDynamicScaleExplicit

    See Dynamic Resolution documentation](https://docs.unity3d.com/Manual/DynamicResolution-control-when-occurs.html)

    Declaration
    public bool useDynamicScaleExplicit { readonly get; set; }
    Property Value
    Type Description
    bool

    useMipMap

    Set to true if the texture should have mipmaps.

    Declaration
    public bool useMipMap { readonly get; set; }
    Property Value
    Type Description
    bool

    vrUsage

    Special treatment of the VR eye texture used in stereoscopic rendering.

    Declaration
    public VRTextureUsage vrUsage { readonly get; set; }
    Property Value
    Type Description
    VRTextureUsage

    wrapModeU

    Addressing mode of the RTHandle.

    Declaration
    public TextureWrapMode wrapModeU { readonly get; set; }
    Property Value
    Type Description
    TextureWrapMode

    wrapModeV

    Addressing mode of the RTHandle.

    Declaration
    public TextureWrapMode wrapModeV { readonly get; set; }
    Property Value
    Type Description
    TextureWrapMode

    wrapModeW

    Addressing mode of the RTHandle.

    Declaration
    public TextureWrapMode wrapModeW { readonly get; set; }
    Property Value
    Type Description
    TextureWrapMode

    Extension Methods

    AnalyticsUtils.ToNestedColumnWithDefault<T>(T, T, bool)
    AnalyticsUtils.ToNestedColumn<T>(T, bool)
    AnalyticsUtils.ToNestedColumn<T>(T, T)
    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)