FPooledRenderTargetDesc

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

Windows
MacOS
Linux

References

Module

RenderCore

Header

/Engine/Source/Runtime/RenderCore/Public/RendererInterface.h

Include

#include "RendererInterface.h"

Syntax

struct FPooledRenderTargetDesc

Remarks

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

Variables

Name Description

Public variable

union FPooledRe...

 

@1993

Public variable

uint16

 

ArraySize

1 if a texture array should be used (not supported on DX9)

Public variable

uint8: 1

 

AutoWritable

Automatically set to writable via barrier during

Public variable

uint8: 1

 

bCreateRenderTargetFmask

Create render target fmask (supported only on specific platforms)

Public variable

uint8: 1

 

bCreateRenderTargetWriteMask

Create render target write mask (supported only on specific platforms)

Public variable

uint8: 1

 

bForceSeparateTargetAndShaderResource

Whether the shader-resource and targetable texture must be separate textures.

Public variable

uint8: 1

 

bForceSharedTargetAndShaderResource

Whether the shader-resource and targetable texture must be the same resource.

Public variable

uint8: 1

 

bIsArray

True if an array texture.

that ArraySize still can be 1

Public variable

uint8: 1

 

bIsCubemap

True if a cubemap texture

Public variable

uint8: 1

 

bReserved0

Unused flag.

Public variable

FClearValueBind...

 

ClearValue

Value allowed for fast clears for this target.

Public variable

const TCHAR ...

 

DebugName

Only set a pointer to memory that never gets released

Public variable

uint16

 

Depth

0, unless it's texture array or volume texture

Public variable

FIntPoint

 

Extent

In pixels, (0,0) if not set, (x,0) for cube maps, todo: make 3d int vector for volume textures

Public variable

ETextureCreateF...

 

Flags

The flags that must be set on both the shader-resource and the targetable texture.

Public variable

EPixelFormat

 

Format

Texture format e.g. PF_B8G8R8A8

Public variable

uint8

 

NumMips

Number of mips

Public variable

uint8

 

NumSamples

Number of MSAA samples, default: 1

Public variable

uint8

 

PackedBits

Public variable

ETextureCreateF...

 

TargetableFlags

The flags that must be set on the targetable texture.

Constructors

Name Description

Public function

FPooledRenderTargetDesc()

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

Functions

Name Description

Public function Const

bool

 

Compare

(
    const FPooledRenderTargetDesc& rhs,
    bool bExact
)

Comparison operator to test if a render target can be reused

Public function Static

FPooledRende...

 

Create2DDesc

(
    FIntPoint InExtent,
    EPixelFormat InFormat,
    const FClearValueBinding& InClearV...,
    ETextureCreateFlags InFlags,
    ETextureCreateFlags InTargetableFla...,
    bool bInForceSeparateTargetAndShade...,
    uint16 InNumMips,
    bool InAutowritable,
    bool InCreateRTWriteMask,
    bool InCreateFmask
)

Factory function to create 2D texture description

Public function Static

FPooledRende...

 

CreateCubemapArrayDesc

(
    uint32 InExtent,
    EPixelFormat InFormat,
    const FClearValueBinding& InClearV...,
    ETextureCreateFlags InFlags,
    ETextureCreateFlags InTargetableFla...,
    bool bInForceSeparateTargetAndShade...,
    uint32 InArraySize,
    uint16 InNumMips,
    bool InAutowritable
)

Factory function to create cube map array texture description

Public function Static

FPooledRende...

 

CreateCubemapDesc

(
    uint32 InExtent,
    EPixelFormat InFormat,
    const FClearValueBinding& InClearV...,
    ETextureCreateFlags InFlags,
    ETextureCreateFlags InTargetableFla...,
    bool bInForceSeparateTargetAndShade...,
    uint32 InArraySize,
    uint16 InNumMips,
    bool InAutowritable
)

Factory function to create cube map texture description

Public function Static

FPooledRende...

 

CreateVolumeDesc

(
    uint32 InSizeX,
    uint32 InSizeY,
    uint32 InSizeZ,
    EPixelFormat InFormat,
    const FClearValueBinding& InClearV...,
    ETextureCreateFlags InFlags,
    ETextureCreateFlags InTargetableFla...,
    bool bInForceSeparateTargetAndShade...,
    uint16 InNumMips,
    bool InAutowritable
)

Factory function to create 3D texture description

Public function Const

FString

 

GenerateInfoString()

For debugging purpose

Public function Const

FIntVector

 

GetSize()

Public function Const

bool

 

Is2DTexture()

Public function Const

bool

 

Is3DTexture()

Public function Const

bool

 

IsArray()

Public function Const

bool

 

IsCubemap()

Public function Const

bool

 

IsValid()

Public function

void

 

Reset()

Useful when compositing graph takes an input as output format

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss