UTextureRenderTarget2D | Unreal Engine 4.27 Documentation

Inheritance Hierarchy


Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Engine/TextureRenderTarget2D.h
Include	#include "Engine/TextureRenderTarget2D.h"

class UTextureRenderTarget2D : public UTextureRenderTarget

TextureRenderTarget2D

2D render target texture resource. This can be used as a target for rendering as well as rendered as a regular 2D texture resource.

Type	Name	Description
TEnumAsByte< enum TextureAddress >	AddressX	The addressing mode to use for the X axis.
TEnumAsByte< enum TextureAddress >	AddressY	The addressing mode to use for the Y axis.
uint8: 1	bAutoGenerateMips	Whether to support Mip maps for this render target texture
uint8: 1	bForceLinearGamma	True to force linear gamma space for this render target
uint8: 1	bGPUSharedFlag	Whether to support GPU sharing of the underlying native texture resource.
FLinearColor	ClearColor	The color the texture is cleared to
TEnumAsByte< enum TextureAddress >	MipsAddressU	AutoGenerateMips sampler address mode for U channel. Defaults to clamp.
TEnumAsByte< enum TextureAddress >	MipsAddressV	AutoGenerateMips sampler address mode for V channel. Defaults to clamp.
TEnumAsByte< enum TextureFilter >	MipsSamplerFilter	Sampler filter type for AutoGenerateMips. Defaults to match texture filter.
TEnumAsByte< enum EPixelFormat >	OverrideFormat	Normally the format is derived from RenderTargetFormat, this allows code to set the format explicitly.
TEnumAsByte< ETextureRenderTargetFormat >	RenderTargetFormat	Format of the texture render target.
int32	SizeX	The width of the texture.
int32	SizeY	The height of the texture.

	Type	Name	Description
		UTextureRenderTarget2D ( const FObjectInitializer& ObjectInitializer )

Type	Name	Description
UTexture2D *	ConstructTexture2D ( UObject* InOuter, const FString& NewTexName, EObjectFlags InObjectFlags, uint32 Flags, TArray< uint8 >* AlphaOverride )	Utility for creating a new UTexture2D from a TextureRenderTarget2D TextureRenderTarget2D must be square and a power of two size.
EPixelFormat	GetFormat ()
int32	GetNumMips ()
ETextureSourceFormat	GetTextureFormatForConversionToTexture2D ()
void	InitAutoFormat ( uint32 InSizeX, uint32 InSizeY )	Initializes the render target, the format will be derived from the value of bHDR.
void	InitCustomFormat ( uint32 InSizeX, uint32 InSizeY, EPixelFormat InOverrideFormat, bool bInForceLinearGamma )	Initialize the settings needed to create a render target texture and create its resource
bool	IsSRGB ()
void	ResizeTarget ( uint32 InSizeX, uint32 InSizeY )	Resizes the render target without recreating the FTextureResource.
void	UpdateResourceImmediate ( bool bClearRenderTarget )	Updates (resolves) the render target texture immediately.
void	UpdateTexture2D ( UTexture2D* InTexture2D, ETextureSourceFormat InTextureFormat, uint32 Flags, TArray< uint8 >* AlphaOverride )	Utility for updating an existing UTexture2D from a TextureRenderTarget2D TextureRenderTarget2D must be square and a power of two size.
void	UpdateTexture2D ( UTexture2D* InTexture2D, ETextureSourceFormat InTextureFormat, uint32 Flags, TArray< uint8 >* AlphaOverride, FTextureChangingDelegate TextureChangingDelegate )

Type	Name	Description
uint32	CalcTextureMemorySizeEnum ( ETextureMipCount Enum )	Calculates the size of this texture if it had MipCount miplevels streamed in.
FTextureResource *	CreateResource ()	Implemented by subclasses to create a new resource for the texture.
EMaterialValueType	GetMaterialType ()
uint32	GetSurfaceArraySize ()
float	GetSurfaceDepth ()
float	GetSurfaceHeight ()
float	GetSurfaceWidth ()

Type	Name	Description
FString	GetDesc ()	Return a one line description of an object for viewing in the thumbnail view of the generic browser
void	GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize )	Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent )	Called when a property on this object has been modified externally
void	PostLoad ()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Name	Description
FTextureChangingDelegate	Utility for updating an existing UTexture2D from a TextureRenderTarget2D TextureRenderTarget2D must be square and a power of two size.

	Type	Name	Description
	uint8: 1	bHDR_DEPRECATED	Whether to support storing HDR values, which requires more memory.