1. Epic GamesDeveloper
  3. FPooledRenderTargetDesc

FPooledRenderTargetDesc

All necessary data to create a render target from the pooled render targets.

API > API/Runtime > API/Runtime/RenderCore

All necessary data to create a render target from the pooled render targets.

   
Name FPooledRenderTargetDesc
Type struct
Header File /Engine/Source/Runtime/RenderCore/Public/RendererInterface.h
Include Path #include "RendererInterface.h"

Syntax

struct FPooledRenderTargetDesc

Constructors

Name Remarks Include Path Unreal Specifiers

FPooledRenderTargetDesc()

 Default constructor, use one of the factory functions below to make a valid description RendererInterface.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AliasableFormats TArray< EPixelFormat, TInlineAllocator< 1 > > Formats this texture is aliasable to RendererInterface.h  
ArraySize uint16 >1 if a texture array should be used (not supported on DX9) RendererInterface.h  
bIsArray uint8 True if an array texture. Note that ArraySize still can be 1 RendererInterface.h  
bIsCubemap uint8 True if a cubemap texture RendererInterface.h  
bReserved0 uint8 Unused flags. RendererInterface.h  
ClearValue FClearValueBinding Value allowed for fast clears for this target. RendererInterface.h  
DebugName const TCHAR * Only set a pointer to memory that never gets released RendererInterface.h  
Depth uint16 0, unless it's texture array or volume texture RendererInterface.h  
Extent FIntPoint In pixels, (0,0) if not set, (x,0) for cube maps, todo: make 3d int vector for volume textures RendererInterface.h  
FastVRAMPercentage uint8 Resource memory percentage which should be allocated onto fast VRAM (hint-only). RendererInterface.h  
Flags ETextureCreateFlags The flags that must be set on both the shader-resource and the targetable texture. RendererInterface.h  
Format EPixelFormat Texture format e.g. PF_B8G8R8A8 RendererInterface.h  
FPooledRenderTargetDesc union FPooledRenderTargetDesc   RendererInterface.h  
NumMips uint8 Number of mips RendererInterface.h  
NumSamples uint8 Number of MSAA samples, default: 1 RendererInterface.h  
PackedBits uint8   RendererInterface.h  
UAVFormat EPixelFormat Texture format used when creating the UAV (if TexCreate_UAV is also passed in TargetableFlags, ignored otherwise). RendererInterface.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool Compare ( const FPooledRenderTargetDesc& rhs,
bool bExact
) const

 Comparison operator to test if a render target can be reused RendererInterface.h  

FString GenerateInfoString()

 For debugging purpose RendererInterface.h  

FIntVector GetSize()

   RendererInterface.h  

bool Is2DTexture()

   RendererInterface.h  

bool Is3DTexture()

   RendererInterface.h  

bool IsArray()

   RendererInterface.h  

bool IsCubemap()

   RendererInterface.h  

bool IsValid()

   RendererInterface.h  

void Reset()

 Useful when compositing graph takes an input as output format RendererInterface.h  

Static

Name Remarks Include Path Unreal Specifiers

static FPooledRenderTargetDesc Create2DArrayDesc ( FIntPoint InExtent,
EPixelFormat InFormat,
const FClearValueBinding& InClearValue,
ETextureCreateFlags InFlags,
ETextureCreateFlags InTargetableFlags,
bool bInForceSeparateTargetAndShaderResource,
uint16 InArraySize,
uint8 InNumMips,
bool InAutowritable,
bool InCreateRTWriteMask,
bool InCreateFmask
)

 Factory function to create 2D array texture description RendererInterface.h  

static FPooledRenderTargetDesc Create2DDesc ( FIntPoint InExtent,
EPixelFormat InFormat,
const FClearValueBinding& InClearValue,
ETextureCreateFlags InFlags,
ETextureCreateFlags InTargetableFlags,
bool bInForceSeparateTargetAndShaderResource,
uint8 InNumMips,
bool InAutowritable,
bool InCreateRTWriteMask,
bool InCreateFmask
)

 Factory function to create 2D texture description RendererInterface.h  

static FPooledRenderTargetDesc CreateCubemapArrayDesc ( uint32 InExtent,
EPixelFormat InFormat,
const FClearValueBinding& InClearValue,
ETextureCreateFlags InFlags,
ETextureCreateFlags InTargetableFlags,
bool bInForceSeparateTargetAndShaderResource,
uint16 InArraySize,
uint8 InNumMips,
bool InAutowritable
)

 Factory function to create cube map array texture description RendererInterface.h  

static FPooledRenderTargetDesc CreateCubemapDesc ( uint32 InExtent,
EPixelFormat InFormat,
const FClearValueBinding& InClearValue,
ETextureCreateFlags InFlags,
ETextureCreateFlags InTargetableFlags,
bool bInForceSeparateTargetAndShaderResource,
uint16 InArraySize,
uint8 InNumMips,
bool InAutowritable
)

 Factory function to create cube map texture description RendererInterface.h  

static FPooledRenderTargetDesc CreateVolumeDesc ( uint32 InSizeX,
uint32 InSizeY,
uint16 InSizeZ,
EPixelFormat InFormat,
const FClearValueBinding& InClearValue,
ETextureCreateFlags InFlags,
ETextureCreateFlags InTargetableFlags,
bool bInForceSeparateTargetAndShaderResource,
uint8 InNumMips,
bool InAutowritable
)

 Factory function to create 3D texture description RendererInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page