1. Epic GamesDeveloper
  3. UTextureRenderTarget2D

UTextureRenderTarget2D

TextureRenderTarget2D

Unreal Engine C++ API Reference > Runtime > Engine > Engine

Inheritance Hierarchy

References

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

Syntax

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

Remarks

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.

Variables

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

Constructors

  Type Name Description
Public function  

UTextureRenderTarget2D ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UTexture2D *

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

 Utility for creating a new UTexture2D from a UTextureRenderTarget2D
Public function Const int32  
Public function Virtual Const ETextureRenderTargetSampleCount  
Public function Const ETextureSourceFormat  
Public function void

InitAutoFormat ( uint32 InSizeX,
uint32 InSizeY
)

 Initializes the render target, the format will be derived from the value of bHDR.
Public function void

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

 Initialize the settings needed to create a render target texture and create its resource
Public function void

ResizeTarget ( uint32 InSizeX,
uint32 InSizeY
)

 Resizes the render target without recreating the FTextureResource.
Public function PRAGMA_ENABLE_DEPRECATION_WARNINGS void

UpdateResourceImmediate ( bool bClearRenderTarget
)

 Updates (resolves) the render target texture immediately.
Public function void

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

 Utility for updating an existing UTexture2D from a TextureRenderTarget2D
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS void

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

  

Overridden from UTextureRenderTarget

  Type Name Description
Public function Virtual Const bool

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

 Validates that the UTextureRenderTarget can be converted to a UTexture (e.g. supported format, valid size, etc.)
Public function Virtual Const float Render target resource should be sampled in linear color space
Public function Virtual Const EPixelFormat  
Public function Virtual Const ETextureClass GetTextureClass() will just return "RenderTarget" ; to get the sub-type (2d/cube), use GetRenderTargetTextureClass.
Public function Virtual Const TSubclassOf< UTexture > Returns the UTexture class that corresponds to this render target (e.g. UTexture2D for UTextureRenderTarget2D)
Public function Virtual Const bool

IsSRGB ()

  

Overridden from UTexture

  Type Name Description
Public function Virtual Const uint32 Calculates the size of this texture if it had MipCount miplevels streamed in.
Public function Virtual FTextureResource * Implemented by subclasses to create a new resource for the texture.
Public function Virtual Const EMaterialValueType  
Public function Virtual Const uint32  
Public function Virtual Const float  
Public function Virtual Const float  
Public function Virtual Const float  

Overridden from UObject

  Type Name Description
Public function Virtual FString

GetDesc ()

 Return a one line description of an object for viewing in the thumbnail view of the generic browser
Public function Virtual 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).
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name Description
FTextureChangingDelegate Utility for updating an existing UTexture2D from a TextureRenderTarget2D

Deprecated Variables

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page