UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | List of all members
FRDGTextureDesc Struct Reference

#include <RenderGraphDefinitions.h>

+ Inheritance diagram for FRDGTextureDesc:

Public Member Functions

 FRDGTextureDesc ()=default
 
 FRDGTextureDesc (ETextureDimension InDimension, ETextureCreateFlags InFlags, EPixelFormat InFormat, FClearValueBinding InClearValue, FIntPoint InExtent, uint16 InDepth, uint16 InArraySize, uint8 InNumMips, uint8 InNumSamples, uint32 InExtData)
 
- Public Member Functions inherited from FRHITextureDesc
 FRHITextureDesc ()=default
 
 FRHITextureDesc (const FRHITextureDesc &Other)
 
 FRHITextureDesc (ETextureDimension InDimension)
 
 FRHITextureDesc (ETextureDimension InDimension, ETextureCreateFlags InFlags, EPixelFormat InFormat, FClearValueBinding InClearValue, FIntPoint InExtent, uint16 InDepth, uint16 InArraySize, uint8 InNumMips, uint8 InNumSamples, uint32 InExtData)
 
bool operator== (const FRHITextureDesc &Other) const
 
bool operator!= (const FRHITextureDesc &Other) const
 
FRHITextureDesc & operator= (const FRHITextureDesc &Other)
 
bool IsTexture2D () const
 
bool IsTexture3D () const
 
bool IsTextureCube () const
 
bool IsTextureArray () const
 
bool IsMipChain () const
 
bool IsMultisample () const
 
FIntVector GetSize () const
 
void Reset ()
 
bool IsValid () const
 
RHI_API uint64 CalcMemorySizeEstimate (uint32 FirstMipIndex, uint32 LastMipIndex) const
 
uint64 CalcMemorySizeEstimate (uint32 FirstMipIndex=0) const
 
uint16 GetSubresourceCount () const
 

Static Public Member Functions

static FRDGTextureDesc Create2D (FIntPoint Size, EPixelFormat Format, FClearValueBinding ClearValue, ETextureCreateFlags Flags, uint8 NumMips=1, uint8 NumSamples=1, uint32 ExtData=0)
 
static FRDGTextureDesc Create2DArray (FIntPoint Size, EPixelFormat Format, FClearValueBinding ClearValue, ETextureCreateFlags Flags, uint16 ArraySize, uint8 NumMips=1, uint8 NumSamples=1, uint32 ExtData=0)
 
static FRDGTextureDesc Create3D (FIntVector Size, EPixelFormat Format, FClearValueBinding ClearValue, ETextureCreateFlags Flags, uint8 NumMips=1, uint32 ExtData=0)
 
static FRDGTextureDesc CreateCube (uint32 Size, EPixelFormat Format, FClearValueBinding ClearValue, ETextureCreateFlags Flags, uint8 NumMips=1, uint8 NumSamples=1, uint32 ExtData=0)
 
static FRDGTextureDesc CreateCubeArray (uint32 Size, EPixelFormat Format, FClearValueBinding ClearValue, ETextureCreateFlags Flags, uint16 ArraySize, uint8 NumMips=1, uint8 NumSamples=1, uint32 ExtData=0)
 
static FRDGTextureDesc CreateRenderTargetTextureDesc (FIntPoint Size, EPixelFormat Format, FClearValueBinding ClearValue, ETextureCreateFlags Flags, const bool bRequireMultiView, uint16 MobileMultiViewRenderTargetNumLayers=2)
 
- Static Public Member Functions inherited from FRHITextureDesc
static bool CheckValidity (const FRHITextureDesc &Desc, const TCHAR *Name)
 

Additional Inherited Members

- Public Attributes inherited from FRHITextureDesc
ETextureCreateFlags Flags = TexCreate_None
 
FClearValueBinding ClearValue
 
FRHIGPUMask GPUMask = FRHIGPUMask::All()
 
uint32 ExtData = 0
 
FIntPoint Extent = FIntPoint(1, 1)
 
uint16 Depth = 1
 
uint16 ArraySize = 1
 
uint8 NumMips = 1
 
uint8 NumSamples = 1
 
ETextureDimension Dimension = ETextureDimension::Texture2D
 
EPixelFormat Format = PF_Unknown
 
EPixelFormat UAVFormat = PF_Unknown
 
uint8 FastVRAMPercentage = 0xFF
 
TArray< EPixelFormat, TInlineAllocator< 1 > > AliasableFormats
 

Constructor & Destructor Documentation

◆ FRDGTextureDesc() [1/2]

FRDGTextureDesc::FRDGTextureDesc ( )
default

◆ FRDGTextureDesc() [2/2]

FRDGTextureDesc::FRDGTextureDesc ( ETextureDimension  InDimension,
ETextureCreateFlags  InFlags,
EPixelFormat  InFormat,
FClearValueBinding  InClearValue,
FIntPoint  InExtent,
uint16  InDepth,
uint16  InArraySize,
uint8  InNumMips,
uint8  InNumSamples,
uint32  InExtData 
)
inline

Member Function Documentation

◆ Create2D()

static FRDGTextureDesc FRDGTextureDesc::Create2D ( FIntPoint  Size,
EPixelFormat  Format,
FClearValueBinding  ClearValue,
ETextureCreateFlags  Flags,
uint8  NumMips = 1,
uint8  NumSamples = 1,
uint32  ExtData = 0 
)
inlinestatic

◆ Create2DArray()

static FRDGTextureDesc FRDGTextureDesc::Create2DArray ( FIntPoint  Size,
EPixelFormat  Format,
FClearValueBinding  ClearValue,
ETextureCreateFlags  Flags,
uint16  ArraySize,
uint8  NumMips = 1,
uint8  NumSamples = 1,
uint32  ExtData = 0 
)
inlinestatic

◆ Create3D()

static FRDGTextureDesc FRDGTextureDesc::Create3D ( FIntVector  Size,
EPixelFormat  Format,
FClearValueBinding  ClearValue,
ETextureCreateFlags  Flags,
uint8  NumMips = 1,
uint32  ExtData = 0 
)
inlinestatic

◆ CreateCube()

static FRDGTextureDesc FRDGTextureDesc::CreateCube ( uint32  Size,
EPixelFormat  Format,
FClearValueBinding  ClearValue,
ETextureCreateFlags  Flags,
uint8  NumMips = 1,
uint8  NumSamples = 1,
uint32  ExtData = 0 
)
inlinestatic

◆ CreateCubeArray()

static FRDGTextureDesc FRDGTextureDesc::CreateCubeArray ( uint32  Size,
EPixelFormat  Format,
FClearValueBinding  ClearValue,
ETextureCreateFlags  Flags,
uint16  ArraySize,
uint8  NumMips = 1,
uint8  NumSamples = 1,
uint32  ExtData = 0 
)
inlinestatic

◆ CreateRenderTargetTextureDesc()

static FRDGTextureDesc FRDGTextureDesc::CreateRenderTargetTextureDesc ( FIntPoint  Size,
EPixelFormat  Format,
FClearValueBinding  ClearValue,
ETextureCreateFlags  Flags,
const bool  bRequireMultiView,
uint16  MobileMultiViewRenderTargetNumLayers = 2 
)
inlinestatic
The documentation for this struct was generated from the following file: