1. Epic GamesDeveloper
  3. UTextureRenderTarget2D

UTextureRenderTarget2D

TextureRenderTarget2D

API > API/Runtime > API/Runtime/Engine

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.

   
Name UTextureRenderTarget2D
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Engine/TextureRenderTarget2D.h
Include Path #include "Engine/TextureRenderTarget2D.h"

Syntax

UCLASS (HideCategories=Object, HideCategories=Texture, HideCategories=Compression,  
       HideCategories=Adjustments, HideCategories=Compositing, MinimalAPI)  
class UTextureRenderTarget2D : public UTextureRenderTarget

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UTextureRenderTarget2D ( const FObjectInitializer& ObjectInitializer
)

   Engine/TextureRenderTarget2D.h  

Typedefs

Name Type Remarks Include Path
FTextureChangingDelegate TBaseDelegate_OneParam< void, UTexture2D * > Utility for updating an existing UTexture2D from a TextureRenderTarget2D Engine/TextureRenderTarget2D.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AddressX TEnumAsByte< enum TextureAddress > The addressing mode to use for the X axis. Engine/TextureRenderTarget2D.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=TextureRenderTarget2D
  • AssetRegistrySearchable
AddressY TEnumAsByte< enum TextureAddress > The addressing mode to use for the Y axis. Engine/TextureRenderTarget2D.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=TextureRenderTarget2D
  • AssetRegistrySearchable
bAutoGenerateMips uint8 Whether to support Mip maps for this render target texture Engine/TextureRenderTarget2D.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=TextureRenderTarget2D
  • AssetRegistrySearchable
bForceLinearGamma uint8 True to force linear gamma space for this render target Engine/TextureRenderTarget2D.h  
bGPUSharedFlag uint8 Whether to support GPU sharing of the underlying native texture resource. Engine/TextureRenderTarget2D.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=TextureRenderTarget2D
  • Meta=(DisplayName="Shared")
  • AssetRegistrySearchable
  • AdvancedDisplay
bNoFastClear uint8 If true fast clear will be disabled on the rendertarget. Engine/TextureRenderTarget2D.h  
bSupportsUAV uint8 Whether this render target can be used as an unordered access view Engine/TextureRenderTarget2D.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=TextureRenderTarget2D
  • AssetRegistrySearchable
ClearColor FLinearColor The color the texture is cleared to Engine/TextureRenderTarget2D.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=TextureRenderTarget2D
MipsAddressU TEnumAsByte< enum TextureAddress > AutoGenerateMips sampler address mode for U channel. Defaults to clamp. Engine/TextureRenderTarget2D.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=TextureRenderTarget2D
  • AssetRegistrySearchable
  • Meta=(editcondition="bAutoGenerateMips")
MipsAddressV TEnumAsByte< enum TextureAddress > AutoGenerateMips sampler address mode for V channel. Defaults to clamp. Engine/TextureRenderTarget2D.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=TextureRenderTarget2D
  • AssetRegistrySearchable
  • Meta=(editcondition="bAutoGenerateMips")
MipsSamplerFilter TEnumAsByte< enum TextureFilter > Sampler filter type for AutoGenerateMips. Defaults to match texture filter. Engine/TextureRenderTarget2D.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=TextureRenderTarget2D
  • AssetRegistrySearchable
  • Meta=(editcondition="bAutoGenerateMips")
OverrideFormat TEnumAsByte< enum EPixelFormat > Normally the format is derived from RenderTargetFormat, this allows code to set the format explicitly. Engine/TextureRenderTarget2D.h  
RenderTargetFormat TEnumAsByte< ETextureRenderTargetFormat > Format of the texture render target. Engine/TextureRenderTarget2D.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=TextureRenderTarget2D
  • AssetRegistrySearchable
SizeX int32 The width of the texture. Engine/TextureRenderTarget2D.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=TextureRenderTarget2D
  • AssetRegistrySearchable
SizeY int32 The height of the texture. Engine/TextureRenderTarget2D.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=TextureRenderTarget2D
  • AssetRegistrySearchable

Protected

Name Type Remarks Include Path Unreal Specifiers
NumMips int32   Engine/TextureRenderTarget2D.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UTexture2D * ConstructTexture2D ( UObject* InOuter,
const FString& InNewTextureName,
EObjectFlags InObjectFlags,
uint32 InFlags,
TArray< uint8 >* InAlphaOverride
)

 Utility for creating a new UTexture2D from a UTextureRenderTarget2D Engine/TextureRenderTarget2D.h  

int32 GetNumMips()

   Engine/TextureRenderTarget2D.h  

virtual ETextureRenderTargetSampleCount GetSampleCount()

   Engine/TextureRenderTarget2D.h  

ETextureSourceFormat GetTextureFormatForConversionToTexture2D()

   Engine/TextureRenderTarget2D.h  

void InitAutoFormat ( uint32 InSizeX,
uint32 InSizeY
)

 Initializes the render target, the format will be derived from the value of bHDR. Engine/TextureRenderTarget2D.h  

void InitCustomFormat ( uint32 InSizeX,
uint32 InSizeY,
EPixelFormat InOverrideFormat,
bool bInForceLinearGamma
)

 Initialize the settings needed to create a render target texture and create its resource Engine/TextureRenderTarget2D.h  

void ResizeTarget ( uint32 InSizeX,
uint32 InSizeY
)

 Resizes the render target without recreating the FTextureResource. Engine/TextureRenderTarget2D.h  

void UpdateResourceImmediate ( bool bClearRenderTarget
)

 Updates (resolves) the render target texture immediately. Engine/TextureRenderTarget2D.h  

void UpdateTexture2D ( UTexture2D* InTexture2D,
ETextureSourceFormat InTextureFormat,
uint32 Flags,
TArray< uint8 >* AlphaOverride
)

 Utility for updating an existing UTexture2D from a TextureRenderTarget2D Engine/TextureRenderTarget2D.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS void UpdateTexture2D ( UTexture2D* InTexture2D,
ETextureSourceFormat InTextureFormat,
uint32 Flags,
TArray< uint8 >* AlphaOverride,
FTextureChangingDelegate TextureChangingDelegate
)

   Engine/TextureRenderTarget2D.h  

Overridden from UTextureRenderTarget

Name Remarks Include Path Unreal Specifiers

virtual bool CanConvertToTexture ( ETextureSourceFormat& OutTextureSourceFormat,
EPixelFormat& OutPixelFormat,
FText* OutErrorMessage
) const

 Validates that the UTextureRenderTarget can be converted to a UTexture (e.g. supported format, valid size, etc.) Engine/TextureRenderTarget2D.h  

virtual float GetDisplayGamma()

 Render target resource should be sampled in linear color space Engine/TextureRenderTarget2D.h  

virtual EPixelFormat GetFormat()

   Engine/TextureRenderTarget2D.h  

virtual ETextureClass GetRenderTargetTextureClass()

 GetTextureClass() will just return "RenderTarget" ; to get the sub-type (2d/cube), use GetRenderTargetTextureClass. Engine/TextureRenderTarget2D.h  

virtual TSubclassOf< UTexture > GetTextureUClass()

 Returns the UTexture class that corresponds to this render target (e.g. UTexture2D for UTextureRenderTarget2D) Engine/TextureRenderTarget2D.h  

virtual bool IsSRGB()

   Engine/TextureRenderTarget2D.h  

Overridden from UTexture

Name Remarks Include Path Unreal Specifiers

virtual uint32 CalcTextureMemorySizeEnum ( ETextureMipCount Enum
) const

 Calculates the size of this texture if it had MipCount miplevels streamed in. Engine/TextureRenderTarget2D.h  

virtual FTextureResource * CreateResource()

 Implemented by subclasses to create a new resource for the texture. Engine/TextureRenderTarget2D.h  

virtual EMaterialValueType GetMaterialType()

   Engine/TextureRenderTarget2D.h  

virtual uint32 GetSurfaceArraySize()

   Engine/TextureRenderTarget2D.h  

virtual float GetSurfaceDepth()

   Engine/TextureRenderTarget2D.h  

virtual float GetSurfaceHeight()

   Engine/TextureRenderTarget2D.h  

virtual float GetSurfaceWidth()

   Engine/TextureRenderTarget2D.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual FString GetDesc()

   Engine/TextureRenderTarget2D.h  

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   Engine/TextureRenderTarget2D.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Engine/TextureRenderTarget2D.h  

virtual void PostLoad()

   Engine/TextureRenderTarget2D.h  

virtual void Serialize ( FArchive& Ar
)

   Engine/TextureRenderTarget2D.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bHDR_DEPRECATED uint8 Whether to support storing HDR values, which requires more memory. Engine/TextureRenderTarget2D.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page