Navigation
API > API/Runtime > API/Runtime/Engine
| Name | UTextureRenderTarget |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Engine/TextureRenderTarget.h |
| Include Path | #include "Engine/TextureRenderTarget.h" |
Syntax
UCLASS (Abstract, MinimalAPI)
class UTextureRenderTarget : public UTexture
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UStreamableRenderAsset → UTexture → UTextureRenderTarget
Implements Interfaces
Derived Classes
- UTextureRenderTarget2D
- UTextureRenderTarget2DArray
- UTextureRenderTargetCube
- UTextureRenderTargetVolume
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UTextureRenderTarget
(
const FObjectInitializer& ObjectInitializer |
Engine/TextureRenderTarget.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnTextureChangingDelegate | TFunctionRef< void(UTexture *)> | Utility for updating an existing UTexture from a TextureRenderTarget | Engine/TextureRenderTarget.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| OnTextureChangingDefault | auto | Engine/TextureRenderTarget.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCanCreateUAV | uint32 | If true, it will be possible to create a FUnorderedAccessViewRHIRef using RHICreateUnorderedAccessView and the internal FTextureRHIRef. | Engine/TextureRenderTarget.h | |
| bNeedsTwoCopies | uint32 | If true, there will be two copies in memory - one for the texture and one for the render target. | Engine/TextureRenderTarget.h | |
| bTargetArraySlicesIndependently | uint32 | If true, RTVs will be created for each slice (texture array and/or cube). | Engine/TextureRenderTarget.h | |
| TargetGamma | float | Will override FTextureRenderTarget2DResource::GetDisplayGamma if > 0. | Engine/TextureRenderTarget.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanConvertToTexture
(
ETextureSourceFormat& OutTextureSourceFormat, |
Validates that the UTextureRenderTarget can be converted to a UTexture (e.g. supported format, valid size, etc.) | Engine/TextureRenderTarget.h | |
bool CanConvertToTexture
(
FText* OutErrorMessage |
Validates that the UTextureRenderTarget can be converted to a UTexture (e.g. supported format, valid size, etc.) | Engine/TextureRenderTarget.h | |
UTexture * ConstructTexture
(
UObject* InOuter, |
Utility for creating a new UTexture from a UTextureRenderTarget. | Engine/TextureRenderTarget.h | |
| Returns a pointer to the (game thread managed) render target resource. | Engine/TextureRenderTarget.h | ||
virtual float GetDisplayGamma() |
Engine/TextureRenderTarget.h | ||
virtual EPixelFormat GetFormat() |
Engine/TextureRenderTarget.h | ||
FTextureRenderTargetResource * GetRenderTargetResource() |
Render thread: Access the render target resource for this texture target object | Engine/TextureRenderTarget.h | |
virtual ETextureClass GetRenderTargetTextureClass() |
GetTextureClass() will just return "RenderTarget" ; to get the sub-type (2d/cube), use GetRenderTargetTextureClass. | Engine/TextureRenderTarget.h | |
virtual TSubclassOf< UTexture > GetTextureUClass() |
Returns the UTexture class that corresponds to this render target (e.g. UTexture2D for UTextureRenderTarget2D) | Engine/TextureRenderTarget.h | |
virtual bool IsSRGB() |
Engine/TextureRenderTarget.h | ||
bool UpdateTexture
(
UTexture* InTexture, |
Engine/TextureRenderTarget.h |
Overridden from UTexture
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FTextureResource * CreateResource() |
Implemented by subclasses to create a new resource for the texture. | Engine/TextureRenderTarget.h | |
virtual EMaterialValueType GetMaterialType() |
Engine/TextureRenderTarget.h | ||
virtual ETextureClass GetTextureClass() |
Get Texture Class | Engine/TextureRenderTarget.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ETextureSourceFormat ValidateTextureFormatForConversionToTextureInternal
(
EPixelFormat InFormat, |
Engine/TextureRenderTarget.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static float GetDefaultDisplayGamma() |
UTextureRenderTarget default display gamma if none is set returns hard-coded 2.2 | Engine/TextureRenderTarget.h | |
static ERawImageFormat::Type GetReadPixelsFormat
(
EPixelFormat PF, |
Get the variant of ReadPixels call that should be used either BGRA8,RGBA32F,or RGBA16F for FColor,FLinearColor, or Float16 | Engine/TextureRenderTarget.h |