Class RTHandles

Default instance of a RTHandleSystem

Inheritance

object

RTHandles

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.Rendering

Assembly: Unity.RenderPipelines.Core.Runtime.dll

Syntax

public static class RTHandles

Properties

maxHeight

Maximum allocated height of the default RTHandle System

Declaration

public static int maxHeight { get; }

Property Value

Type	Description
int

maxWidth

Maximum allocated width of the default RTHandle System

Declaration

public static int maxWidth { get; }

Property Value

Type	Description
int

rtHandleProperties

Current properties of the default RTHandle System

Declaration

public static RTHandleProperties rtHandleProperties { get; }

Property Value

Type	Description
RTHandleProperties

Methods

Alloc(int, int, int, DepthBits, GraphicsFormat, FilterMode, TextureWrapMode, TextureDimension, bool, bool, bool, bool, int, float, MSAASamples, bool, bool, bool, RenderTextureMemoryless, VRTextureUsage, string)

Allocate a new fixed sized RTHandle with the default RTHandle System.

Declaration

public static RTHandle Alloc(int width, int height, int slices = 1, DepthBits depthBufferBits = DepthBits.None, GraphicsFormat colorFormat = GraphicsFormat.R8G8B8A8_SRGB, FilterMode filterMode = FilterMode.Point, TextureWrapMode wrapMode = TextureWrapMode.Repeat, TextureDimension dimension = TextureDimension.Tex2D, bool enableRandomWrite = false, bool useMipMap = false, bool autoGenerateMips = true, bool isShadowMap = false, int anisoLevel = 1, float mipMapBias = 0, MSAASamples msaaSamples = MSAASamples.None, bool bindTextureMS = false, bool useDynamicScale = false, bool useDynamicScaleExplicit = false, RenderTextureMemoryless memoryless = RenderTextureMemoryless.None, VRTextureUsage vrUsage = VRTextureUsage.None, string name = "")

Parameters

Type	Name	Description
int	width	With of the RTHandle.
int	height	Heigh of the RTHandle.
int	slices	Number of slices of the RTHandle.
DepthBits	depthBufferBits	Bit depths of a depth buffer.
GraphicsFormat	colorFormat	GraphicsFormat of a color buffer.
FilterMode	filterMode	Filtering mode of the RTHandle.
TextureWrapMode	wrapMode	Addressing mode of the RTHandle.
TextureDimension	dimension	Texture dimension of the RTHandle.
bool	enableRandomWrite	Set to true to enable UAV random read writes on the texture.
bool	useMipMap	Set to true if the texture should have mipmaps.
bool	autoGenerateMips	Set to true to automatically generate mipmaps.
bool	isShadowMap	Set to true if the depth buffer should be used as a shadow map.
int	anisoLevel	Anisotropic filtering level.
float	mipMapBias	Bias applied to mipmaps during filtering.
MSAASamples	msaaSamples	Number of MSAA samples for the RTHandle.
bool	bindTextureMS	Set to true if the texture needs to be bound as a multisampled texture in the shader.
bool	useDynamicScale	See Dynamic Resolution documentation
bool	useDynamicScaleExplicit	See Dynamic Resolution documentation
RenderTextureMemoryless	memoryless	Use this property to set the render texture memoryless modes.
VRTextureUsage	vrUsage	Special treatment of the VR eye texture used in stereoscopic rendering.
string	name	Name of the RTHandle.

Returns

Type	Description
RTHandle	A new RTHandle.

Alloc(int, int, RTHandleAllocInfo)

Allocate a new fixed sized RTHandle with the default RTHandle System.

Declaration

public static RTHandle Alloc(int width, int height, RTHandleAllocInfo info)

Parameters

Type	Name	Description
int	width	With of the RTHandle.
int	height	Height of the RTHandle.
RTHandleAllocInfo	info	Struct containing details of allocation

Returns

Type	Description
RTHandle	A new RTHandle.

Alloc(int, int, TextureWrapMode, TextureWrapMode, TextureWrapMode, int, DepthBits, GraphicsFormat, FilterMode, TextureDimension, bool, bool, bool, bool, int, float, MSAASamples, bool, bool, bool, RenderTextureMemoryless, VRTextureUsage, string)

Allocate a new fixed sized RTHandle with the default RTHandle System.

Declaration

public static RTHandle Alloc(int width, int height, TextureWrapMode wrapModeU, TextureWrapMode wrapModeV, TextureWrapMode wrapModeW = TextureWrapMode.Repeat, int slices = 1, DepthBits depthBufferBits = DepthBits.None, GraphicsFormat colorFormat = GraphicsFormat.R8G8B8A8_SRGB, FilterMode filterMode = FilterMode.Point, TextureDimension dimension = TextureDimension.Tex2D, bool enableRandomWrite = false, bool useMipMap = false, bool autoGenerateMips = true, bool isShadowMap = false, int anisoLevel = 1, float mipMapBias = 0, MSAASamples msaaSamples = MSAASamples.None, bool bindTextureMS = false, bool useDynamicScale = false, bool useDynamicScaleExplicit = false, RenderTextureMemoryless memoryless = RenderTextureMemoryless.None, VRTextureUsage vrUsage = VRTextureUsage.None, string name = "")

Parameters

Type	Name	Description
int	width	With of the RTHandle.
int	height	Heigh of the RTHandle.
TextureWrapMode	wrapModeU	U coordinate wrapping mode of the RTHandle.
TextureWrapMode	wrapModeV	V coordinate wrapping mode of the RTHandle.
TextureWrapMode	wrapModeW	W coordinate wrapping mode of the RTHandle.
int	slices	Number of slices of the RTHandle.
DepthBits	depthBufferBits	Bit depths of a depth buffer.
GraphicsFormat	colorFormat	GraphicsFormat of a color buffer.
FilterMode	filterMode	Filtering mode of the RTHandle.
TextureDimension	dimension	Texture dimension of the RTHandle.
bool	enableRandomWrite	Set to true to enable UAV random read writes on the texture.
bool	useMipMap	Set to true if the texture should have mipmaps.
bool	autoGenerateMips	Set to true to automatically generate mipmaps.
bool	isShadowMap	Set to true if the depth buffer should be used as a shadow map.
int	anisoLevel	Anisotropic filtering level.
float	mipMapBias	Bias applied to mipmaps during filtering.
MSAASamples	msaaSamples	Number of MSAA samples for the RTHandle.
bool	bindTextureMS	Set to true if the texture needs to be bound as a multisampled texture in the shader.
bool	useDynamicScale	See Dynamic Resolution documentation
bool	useDynamicScaleExplicit	See Dynamic Resolution documentation
RenderTextureMemoryless	memoryless	Use this property to set the render texture memoryless modes.
VRTextureUsage	vrUsage	Special treatment of the VR eye texture used in stereoscopic rendering.
string	name	Name of the RTHandle.

Returns

Type	Description
RTHandle	A new RTHandle.

Alloc(RenderTexture, bool)

Allocate a RTHandle from a regular RenderTexture for the default RTHandle system.

Declaration

public static RTHandle Alloc(RenderTexture tex, bool transferOwnership = false)

Parameters

Type	Name	Description
RenderTexture	tex	Input texture
bool	transferOwnership	To transfer ownership of the RenderTexture to the default RTHandles system, false by default

Returns

Type	Description
RTHandle	A new RTHandle referencing the input texture.

Alloc(in RenderTextureDescriptor, FilterMode, TextureWrapMode, bool, int, float, string)

Allocate a new fixed sized RTHandle with the default RTHandle System.

Declaration

public static RTHandle Alloc(in RenderTextureDescriptor descriptor, FilterMode filterMode = FilterMode.Point, TextureWrapMode wrapMode = TextureWrapMode.Repeat, bool isShadowMap = false, int anisoLevel = 1, float mipMapBias = 0, string name = "")

Parameters

Type	Name	Description
RenderTextureDescriptor	descriptor	RenderTexture descriptor of the RTHandle.
FilterMode	filterMode	Filtering mode of the RTHandle.
TextureWrapMode	wrapMode	Addressing mode of the RTHandle.
bool	isShadowMap	Set to true if the depth buffer should be used as a shadow map.
int	anisoLevel	Anisotropic filtering level.
float	mipMapBias	Bias applied to mipmaps during filtering.
string	name	Name of the RTHandle.

Returns

Type	Description
RTHandle	A new RTHandle.

Alloc(RenderTargetIdentifier)

Allocate a RTHandle from a regular render target identifier for the default RTHandle system.

Declaration

public static RTHandle Alloc(RenderTargetIdentifier tex)

Parameters

Type	Name	Description
RenderTargetIdentifier	tex	Input render target identifier.

Returns

Type	Description
RTHandle	A new RTHandle referencing the input render target identifier.

Alloc(RenderTargetIdentifier, string)

Allocate a RTHandle from a regular render target identifier for the default RTHandle system.

Declaration

public static RTHandle Alloc(RenderTargetIdentifier tex, string name)

Parameters

Type	Name	Description
RenderTargetIdentifier	tex	Input render target identifier.
string	name	Name of the render target.

Returns

Type	Description
RTHandle	A new RTHandle referencing the input render target identifier.

Alloc(ScaleFunc, int, DepthBits, GraphicsFormat, FilterMode, TextureWrapMode, TextureDimension, bool, bool, bool, bool, int, float, MSAASamples, bool, bool, bool, RenderTextureMemoryless, VRTextureUsage, string)

Allocate a new automatically sized RTHandle for the default RTHandle System.

Declaration

public static RTHandle Alloc(ScaleFunc scaleFunc, int slices = 1, DepthBits depthBufferBits = DepthBits.None, GraphicsFormat colorFormat = GraphicsFormat.R8G8B8A8_SRGB, FilterMode filterMode = FilterMode.Point, TextureWrapMode wrapMode = TextureWrapMode.Repeat, TextureDimension dimension = TextureDimension.Tex2D, bool enableRandomWrite = false, bool useMipMap = false, bool autoGenerateMips = true, bool isShadowMap = false, int anisoLevel = 1, float mipMapBias = 0, MSAASamples msaaSamples = MSAASamples.None, bool bindTextureMS = false, bool useDynamicScale = false, bool useDynamicScaleExplicit = false, RenderTextureMemoryless memoryless = RenderTextureMemoryless.None, VRTextureUsage vrUsage = VRTextureUsage.None, string name = "")

Parameters

Type	Name	Description
ScaleFunc	scaleFunc	Function used for the RTHandle size computation.
int	slices	Number of slices of the RTHandle.
DepthBits	depthBufferBits	Bit depths of a depth buffer.
GraphicsFormat	colorFormat	GraphicsFormat of a color buffer.
FilterMode	filterMode	Filtering mode of the RTHandle.
TextureWrapMode	wrapMode	Addressing mode of the RTHandle.
TextureDimension	dimension	Texture dimension of the RTHandle.
bool	enableRandomWrite	Set to true to enable UAV random read writes on the texture.
bool	useMipMap	Set to true if the texture should have mipmaps.
bool	autoGenerateMips	Set to true to automatically generate mipmaps.
bool	isShadowMap	Set to true if the depth buffer should be used as a shadow map.
int	anisoLevel	Anisotropic filtering level.
float	mipMapBias	Bias applied to mipmaps during filtering.
MSAASamples	msaaSamples	Number of MSAA samples.
bool	bindTextureMS	Set to true if the texture needs to be bound as a multisampled texture in the shader.
bool	useDynamicScale	See Dynamic Resolution documentation
bool	useDynamicScaleExplicit	See Dynamic Resolution documentation
RenderTextureMemoryless	memoryless	Use this property to set the render texture memoryless modes.
VRTextureUsage	vrUsage	Special treatment of the VR eye texture used in stereoscopic rendering.
string	name	Name of the RTHandle.

Returns

Type	Description
RTHandle	A new RTHandle.

Alloc(ScaleFunc, in RenderTextureDescriptor, FilterMode, TextureWrapMode, bool, int, float, string)

Allocate a new automatically sized RTHandle for the default RTHandle System.

Declaration

public static RTHandle Alloc(ScaleFunc scaleFunc, in RenderTextureDescriptor descriptor, FilterMode filterMode = FilterMode.Point, TextureWrapMode wrapMode = TextureWrapMode.Repeat, bool isShadowMap = false, int anisoLevel = 1, float mipMapBias = 0, string name = "")

Parameters

Type	Name	Description
ScaleFunc	scaleFunc	Function used for the RTHandle size computation.
RenderTextureDescriptor	descriptor	RenderTexture descriptor of the RTHandle.
FilterMode	filterMode	Filtering mode of the RTHandle.
TextureWrapMode	wrapMode	Addressing mode of the RTHandle.
bool	isShadowMap	Set to true if the depth buffer should be used as a shadow map.
int	anisoLevel	Anisotropic filtering level.
float	mipMapBias	Bias applied to mipmaps during filtering.
string	name	Name of the RTHandle.

Returns

Type	Description
RTHandle	A new RTHandle.

Alloc(ScaleFunc, RTHandleAllocInfo)

Allocate a new automatically sized RTHandle for the default RTHandle System.

Declaration

public static RTHandle Alloc(ScaleFunc scaleFunc, RTHandleAllocInfo info)

Parameters

Type	Name	Description
ScaleFunc	scaleFunc	Function used for the RTHandle size computation.
RTHandleAllocInfo	info	Struct containing details of allocation

Returns

Type	Description
RTHandle	A new RTHandle.

Alloc(Texture)

Allocate a RTHandle from a regular Texture for the default RTHandle system.

Declaration

public static RTHandle Alloc(Texture tex)

Parameters

Type	Name	Description
Texture	tex	Input texture

Returns

Type	Description
RTHandle	A new RTHandle referencing the input texture.

Alloc(Vector2, int, DepthBits, GraphicsFormat, FilterMode, TextureWrapMode, TextureDimension, bool, bool, bool, bool, int, float, MSAASamples, bool, bool, bool, RenderTextureMemoryless, VRTextureUsage, string)

Allocate a new automatically sized RTHandle for the default RTHandle System.

Declaration

public static RTHandle Alloc(Vector2 scaleFactor, int slices = 1, DepthBits depthBufferBits = DepthBits.None, GraphicsFormat colorFormat = GraphicsFormat.R8G8B8A8_SRGB, FilterMode filterMode = FilterMode.Point, TextureWrapMode wrapMode = TextureWrapMode.Repeat, TextureDimension dimension = TextureDimension.Tex2D, bool enableRandomWrite = false, bool useMipMap = false, bool autoGenerateMips = true, bool isShadowMap = false, int anisoLevel = 1, float mipMapBias = 0, MSAASamples msaaSamples = MSAASamples.None, bool bindTextureMS = false, bool useDynamicScale = false, bool useDynamicScaleExplicit = false, RenderTextureMemoryless memoryless = RenderTextureMemoryless.None, VRTextureUsage vrUsage = VRTextureUsage.None, string name = "")

Parameters

Type	Name	Description
Vector2	scaleFactor	Constant scale for the RTHandle size computation.
int	slices	Number of slices of the RTHandle.
DepthBits	depthBufferBits	Bit depths of a depth buffer.
GraphicsFormat	colorFormat	GraphicsFormat of a color buffer.
FilterMode	filterMode	Filtering mode of the RTHandle.
TextureWrapMode	wrapMode	Addressing mode of the RTHandle.
TextureDimension	dimension	Texture dimension of the RTHandle.
bool	enableRandomWrite	Set to true to enable UAV random read writes on the texture.
bool	useMipMap	Set to true if the texture should have mipmaps.
bool	autoGenerateMips	Set to true to automatically generate mipmaps.
bool	isShadowMap	Set to true if the depth buffer should be used as a shadow map.
int	anisoLevel	Anisotropic filtering level.
float	mipMapBias	Bias applied to mipmaps during filtering.
MSAASamples	msaaSamples	Number of MSAA samples.
bool	bindTextureMS	Set to true if the texture needs to be bound as a multisampled texture in the shader.
bool	useDynamicScale	See Dynamic Resolution documentation
bool	useDynamicScaleExplicit	See Dynamic Resolution documentation
RenderTextureMemoryless	memoryless	Use this property to set the render texture memoryless modes.
VRTextureUsage	vrUsage	Special treatment of the VR eye texture used in stereoscopic rendering.
string	name	Name of the RTHandle.

Returns

Type	Description
RTHandle	A new RTHandle.

Alloc(Vector2, in RenderTextureDescriptor, FilterMode, TextureWrapMode, bool, int, float, string)

Allocate a new automatically sized RTHandle for the default RTHandle System.

Declaration

public static RTHandle Alloc(Vector2 scaleFactor, in RenderTextureDescriptor descriptor, FilterMode filterMode = FilterMode.Point, TextureWrapMode wrapMode = TextureWrapMode.Repeat, bool isShadowMap = false, int anisoLevel = 1, float mipMapBias = 0, string name = "")

Parameters

Type	Name	Description
Vector2	scaleFactor	Constant scale for the RTHandle size computation.
RenderTextureDescriptor	descriptor	RenderTexture descriptor of the RTHandle.
FilterMode	filterMode	Filtering mode of the RTHandle.
TextureWrapMode	wrapMode	Addressing mode of the RTHandle.
bool	isShadowMap	Set to true if the depth buffer should be used as a shadow map.
int	anisoLevel	Anisotropic filtering level.
float	mipMapBias	Bias applied to mipmaps during filtering.
string	name	Name of the RTHandle.

Returns

Type	Description
RTHandle	A new RTHandle.

Alloc(Vector2, RTHandleAllocInfo)

Allocate a new automatically sized RTHandle for the default RTHandle System.

Declaration

public static RTHandle Alloc(Vector2 scaleFactor, RTHandleAllocInfo info)

Parameters

Type	Name	Description
Vector2	scaleFactor	Constant scale for the RTHandle size computation.
RTHandleAllocInfo	info	Struct containing details of allocation

Returns

Type	Description
RTHandle	A new RTHandle.

CalculateDimensions(ScaleFunc)

Calculate the dimensions (in pixels) of the RTHandles given the scale function. The base unscaled size used, is the sizes passed to the last ResetReferenceSize call.

Declaration

public static Vector2Int CalculateDimensions(ScaleFunc scaleFunc)

Parameters

Type	Name	Description
ScaleFunc	scaleFunc	The scale function to use when calculating the dimensions.

Returns

Type	Description
Vector2Int	The calculated dimensions.

CalculateDimensions(Vector2)

Calculate the dimensions (in pixels) of the RTHandles given the scale factor.

Declaration

public static Vector2Int CalculateDimensions(Vector2 scaleFactor)

Parameters

Type	Name	Description
Vector2	scaleFactor	The scale factor to use when calculating the dimensions. The base unscaled size used, is the sizes passed to the last ResetReferenceSize call.

Returns

Type	Description
Vector2Int	The calculated dimensions.

CalculateRatioAgainstMaxSize(int, int)

Returns the ratio against the current target's max resolution

Declaration

public static Vector2 CalculateRatioAgainstMaxSize(int width, int height)

Parameters

Type	Name	Description
int	width	width to utilize
int	height	height to utilize

Returns

Type	Description
Vector2	retruns the width,height / maxTargetSize.xy ratio.

Initialize(int, int)

Initialize the default RTHandle system.

Declaration

public static void Initialize(int width, int height)

Parameters

Type	Name	Description
int	width	Initial reference rendering width.
int	height	Initial reference rendering height.

Initialize(int, int, bool)

Initialize the default RTHandle system.

Declaration

[Obsolete("useLegacyDynamicResControl is deprecated. Please use SetHardwareDynamicResolutionState() instead.")]
public static void Initialize(int width, int height, bool useLegacyDynamicResControl = false)

Parameters

Type	Name	Description
int	width	Initial reference rendering width.
int	height	Initial reference rendering height.
bool	useLegacyDynamicResControl	Use legacy hardware DynamicResolution control in the default RTHandle system.

Release(RTHandle)

Release memory of a RTHandle from the default RTHandle System

Declaration

public static void Release(RTHandle rth)

Parameters

Type	Name	Description
RTHandle	rth	RTHandle that should be released.

ResetReferenceSize(int, int)

Reset the reference size of the system and reallocate all textures.

Declaration

public static void ResetReferenceSize(int width, int height)

Parameters

Type	Name	Description
int	width	New width.
int	height	New height.

SetHardwareDynamicResolutionState(bool)

Enable or disable hardware dynamic resolution for the default RTHandle System

Declaration

public static void SetHardwareDynamicResolutionState(bool hwDynamicResRequested)

Parameters

Type	Name	Description
bool	hwDynamicResRequested	State of hardware dynamic resolution.

SetReferenceSize(int, int)

Sets the reference rendering size for subsequent rendering for the default RTHandle System

Declaration

public static void SetReferenceSize(int width, int height)

Parameters

Type	Name	Description
int	width	Reference rendering width for subsequent rendering.
int	height	Reference rendering height for subsequent rendering.