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)
Syntax
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
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
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
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
Release(RTHandle)
Declaration
public static void Release(RTHandle rth)
Parameters
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
Returns
Type |
Description |
RenderTargetIdentifier |
|
Implicit(RTHandle to RenderTexture)
Declaration
public static implicit operator RenderTexture(RTHandle handle)
Parameters
Returns
Type |
Description |
RenderTexture |
|
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.