FRDGTextureDesc

Descriptor used to create a render graph texture.

Windows
MacOS
Linux

References

Module

RenderCore

Header

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

Include

#include "RenderGraphResources.h"

Syntax

struct FRDGTextureDesc

Remarks

Descriptor used to create a render graph texture.

Variables

Name Description

Public variable

uint16

 

ArraySize

The number of array elements in the texture. (Keep at 1 if dimension is 3D).

Public variable

FClearValueBind...

 

ClearValue

Clear value to use when fast-clearing the texture.

Public variable

uint16

 

Depth

Depth of the texture if the dimension is 3D.

Public variable

ETextureDimensi...

 

Dimension

Texture dimension to use when creating the RHI texture.

Public variable

FIntPoint

 

Extent

Extent of the texture in x and y.

Public variable

ETextureCreateF...

 

Flags

Texture flags passed on to RHI texture.

Public variable

EPixelFormat

 

Format

Pixel format used to create RHI texture.

Public variable

uint8

 

NumMips

Number of mips in the texture mip-map chain.

Public variable

uint8

 

NumSamples

Number of samples in the texture. >1 for MSAA.

Constructors

Name Description

Public function

FRDGTextureDesc()

Public function

FRDGTextureDesc

(
    FClearValueBinding InClearValue,
    ETextureDimension InDimension,
    ETextureCreateFlags InFlags,
    EPixelFormat InFormat,
    FIntPoint InExtent,
    uint16 InDepth,
    uint16 InArraySize,
    uint8 InNumMips,
    uint8 InNumSamples
)

Functions

Name Description

Public function Static

FRDGTextureD...

 

Create2D

(
    FIntPoint InExtent,
    EPixelFormat InFormat,
    FClearValueBinding InClearValue,
    ETextureCreateFlags InFlags,
    uint8 InNumMips,
    uint8 InNumSamples
)

Public function Static

FRDGTextureD...

 

Create2DArray

(
    FIntPoint InExtent,
    EPixelFormat InFormat,
    FClearValueBinding InClearValue,
    ETextureCreateFlags InFlags,
    uint32 InArraySize,
    uint8 InNumMips,
    uint8 InNumSamples
)

Public function Static

FRDGTextureD...

 

Create3D

(
    FIntVector InSize,
    EPixelFormat InFormat,
    FClearValueBinding InClearValue,
    ETextureCreateFlags InFlags,
    uint8 InNumMips,
    uint8 InNumSamples
)

Public function Static

FRDGTextureD...

 

CreateCube

(
    uint32 InSizeInPixels,
    EPixelFormat InFormat,
    FClearValueBinding InClearValue,
    ETextureCreateFlags InFlags,
    uint8 InNumMips,
    uint8 InNumSamples
)

Public function Static

FRDGTextureD...

 

CreateCubeArray

(
    uint32 InSizeInPixels,
    EPixelFormat InFormat,
    FClearValueBinding InClearValue,
    ETextureCreateFlags InFlags,
    uint32 InArraySize,
    uint8 InNumMips,
    uint8 InNumSamples
)

Public function Const

FIntVector

 

GetSize()

Public function Const

FRDGTextureS...

 

GetSubresourceLayout()

Public function Const

bool

 

IsMipChain()

Public function Const

bool

 

IsMultisample()

Public function Const

bool

 

IsTexture2D()

Public function Const

bool

 

IsTexture3D()

Public function Const

bool

 

IsTextureArray()

Public function Const

bool

 

IsTextureCube()

Public function Const

bool

 

IsValid()

Returns whether this descriptor conforms to requirements.

Public function

void

 

Reset()

Deprecated Functions

Name Description

Public function Static

FRDGTextureD...

 

Create2DDesc

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

FRDGTextureDesc has been refactored. Use Create2D instead.

Public function Static

FRDGTextureD...

 

CreateCubemapArrayDesc

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

FRDGTextureDesc has been refactored. Use CreateCubeArray instead.

Public function Static

FRDGTextureD...

 

CreateCubemapDesc

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

FRDGTextureDesc has been refactored. Use CreateCube instead.

Public function Static

FRDGTextureD...

 

CreateVolumeDesc

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

FRDGTextureDesc has been refactored. Use Create3D instead.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss