UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FRHITextureCreateDesc Struct Reference

#include <RHIResources.h>

+ Inheritance diagram for FRHITextureCreateDesc:

Public Member Functions

 FRHITextureCreateDesc ()=default
 
 FRHITextureCreateDesc (const TCHAR *InDebugName, ETextureDimension InDimension)
 
 FRHITextureCreateDesc (FRHITextureDesc const &InDesc, ERHIAccess InInitialState, TCHAR const *InDebugName, FResourceBulkDataInterface *InBulkData=nullptr)
 
void CheckValidity () const
 
FRHITextureCreateDescSetFlags (ETextureCreateFlags InFlags)
 
FRHITextureCreateDescAddFlags (ETextureCreateFlags InFlags)
 
FRHITextureCreateDescSetClearValue (FClearValueBinding InClearValue)
 
FRHITextureCreateDescSetExtData (uint32 InExtData)
 
FRHITextureCreateDescSetExtent (const FIntPoint &InExtent)
 
FRHITextureCreateDescSetExtent (int32 InExtentX, int32 InExtentY)
 
FRHITextureCreateDescSetExtent (uint32 InExtent)
 
FRHITextureCreateDescSetDepth (uint16 InDepth)
 
FRHITextureCreateDescSetArraySize (uint16 InArraySize)
 
FRHITextureCreateDescSetNumMips (uint8 InNumMips)
 
FRHITextureCreateDescSetNumSamples (uint8 InNumSamples)
 
FRHITextureCreateDescSetDimension (ETextureDimension InDimension)
 
FRHITextureCreateDescSetFormat (EPixelFormat InFormat)
 
FRHITextureCreateDescSetUAVFormat (EPixelFormat InUAVFormat)
 
FRHITextureCreateDescSetDebugName (const TCHAR *InDebugName)
 
FRHITextureCreateDescSetInitialState (ERHIAccess InInitialState)
 
FRHITextureCreateDescSetInitAction (ERHITextureInitAction InInitAction)
 
FRHITextureCreateDescSetGPUMask (FRHIGPUMask InGPUMask)
 
FRHITextureCreateDescSetClassName (FName InClassName)
 
FRHITextureCreateDescSetOwnerName (FName InOwnerName)
 
FRHITextureCreateDescAddAliasbleFormat (EPixelFormat InFormat)
 
FRHITextureCreateDescSetFastVRAMPercentage (float InFastVRAMPercentage)
 
FRHITextureCreateDescDetermineInititialState ()
 
FRHITextureCreateDescSetInitActionNone ()
 
FRHITextureCreateDescSetInitActionInitializer ()
 
FRHITextureCreateDescSetInitActionBulkData (FResourceBulkDataInterface *InBulkData)
 
FRHITextureCreateDescSetBulkData (FResourceBulkDataInterface *InBulkData)
 
FName GetTraceClassName () const
 
- 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
 
FRHITextureDescoperator= (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 FRHITextureCreateDesc Create (const TCHAR *InDebugName, ETextureDimension InDimension)
 
static FRHITextureCreateDesc Create2D (const TCHAR *InDebugName)
 
static FRHITextureCreateDesc Create2DArray (const TCHAR *InDebugName)
 
static FRHITextureCreateDesc Create3D (const TCHAR *InDebugName)
 
static FRHITextureCreateDesc CreateCube (const TCHAR *InDebugName)
 
static FRHITextureCreateDesc CreateCubeArray (const TCHAR *InDebugName)
 
static FRHITextureCreateDesc Create2D (const TCHAR *DebugName, FIntPoint Size, EPixelFormat Format)
 
static FRHITextureCreateDesc Create2D (const TCHAR *DebugName, int32 SizeX, int32 SizeY, EPixelFormat Format)
 
static FRHITextureCreateDesc Create2DArray (const TCHAR *DebugName, FIntPoint Size, uint16 ArraySize, EPixelFormat Format)
 
static FRHITextureCreateDesc Create2DArray (const TCHAR *DebugName, int32 SizeX, int32 SizeY, int32 ArraySize, EPixelFormat Format)
 
static FRHITextureCreateDesc Create3D (const TCHAR *DebugName, FIntVector Size, EPixelFormat Format)
 
static FRHITextureCreateDesc Create3D (const TCHAR *DebugName, int32 SizeX, int32 SizeY, int32 SizeZ, EPixelFormat Format)
 
static FRHITextureCreateDesc CreateCube (const TCHAR *DebugName, uint32 Size, EPixelFormat Format)
 
static FRHITextureCreateDesc CreateCubeArray (const TCHAR *DebugName, uint32 Size, uint16 ArraySize, EPixelFormat Format)
 
- Static Public Member Functions inherited from FRHITextureDesc
static bool CheckValidity (const FRHITextureDesc &Desc, const TCHAR *Name)
 

Public Attributes

const TCHARDebugName = nullptr
 
ERHIAccess InitialState = ERHIAccess::Unknown
 
ERHITextureInitAction InitAction = ERHITextureInitAction::Default
 
FResourceBulkDataInterfaceBulkData = nullptr
 
FName ClassName = NAME_None
 
FName OwnerName = NAME_None
 
- 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

◆ FRHITextureCreateDesc() [1/3]

FRHITextureCreateDesc::FRHITextureCreateDesc ( )
default

◆ FRHITextureCreateDesc() [2/3]

FRHITextureCreateDesc::FRHITextureCreateDesc ( const TCHAR InDebugName,
ETextureDimension  InDimension 
)
inline

◆ FRHITextureCreateDesc() [3/3]

FRHITextureCreateDesc::FRHITextureCreateDesc ( FRHITextureDesc const &  InDesc,
ERHIAccess  InInitialState,
TCHAR const *  InDebugName,
FResourceBulkDataInterface InBulkData = nullptr 
)
inline

Member Function Documentation

◆ AddAliasbleFormat()

FRHITextureCreateDesc & FRHITextureCreateDesc::AddAliasbleFormat ( EPixelFormat  InFormat)
inline

◆ AddFlags()

FRHITextureCreateDesc & FRHITextureCreateDesc::AddFlags ( ETextureCreateFlags  InFlags)
inline

◆ CheckValidity()

void FRHITextureCreateDesc::CheckValidity ( ) const
inline

◆ Create()

static FRHITextureCreateDesc FRHITextureCreateDesc::Create ( const TCHAR InDebugName,
ETextureDimension  InDimension 
)
inlinestatic

◆ Create2D() [1/3]

static FRHITextureCreateDesc FRHITextureCreateDesc::Create2D ( const TCHAR DebugName,
FIntPoint  Size,
EPixelFormat  Format 
)
inlinestatic

◆ Create2D() [2/3]

static FRHITextureCreateDesc FRHITextureCreateDesc::Create2D ( const TCHAR DebugName,
int32  SizeX,
int32  SizeY,
EPixelFormat  Format 
)
inlinestatic

◆ Create2D() [3/3]

static FRHITextureCreateDesc FRHITextureCreateDesc::Create2D ( const TCHAR InDebugName)
inlinestatic

◆ Create2DArray() [1/3]

static FRHITextureCreateDesc FRHITextureCreateDesc::Create2DArray ( const TCHAR DebugName,
FIntPoint  Size,
uint16  ArraySize,
EPixelFormat  Format 
)
inlinestatic

◆ Create2DArray() [2/3]

static FRHITextureCreateDesc FRHITextureCreateDesc::Create2DArray ( const TCHAR DebugName,
int32  SizeX,
int32  SizeY,
int32  ArraySize,
EPixelFormat  Format 
)
inlinestatic

◆ Create2DArray() [3/3]

static FRHITextureCreateDesc FRHITextureCreateDesc::Create2DArray ( const TCHAR InDebugName)
inlinestatic

◆ Create3D() [1/3]

static FRHITextureCreateDesc FRHITextureCreateDesc::Create3D ( const TCHAR DebugName,
FIntVector  Size,
EPixelFormat  Format 
)
inlinestatic

◆ Create3D() [2/3]

static FRHITextureCreateDesc FRHITextureCreateDesc::Create3D ( const TCHAR DebugName,
int32  SizeX,
int32  SizeY,
int32  SizeZ,
EPixelFormat  Format 
)
inlinestatic

◆ Create3D() [3/3]

static FRHITextureCreateDesc FRHITextureCreateDesc::Create3D ( const TCHAR InDebugName)
inlinestatic

◆ CreateCube() [1/2]

static FRHITextureCreateDesc FRHITextureCreateDesc::CreateCube ( const TCHAR DebugName,
uint32  Size,
EPixelFormat  Format 
)
inlinestatic

◆ CreateCube() [2/2]

static FRHITextureCreateDesc FRHITextureCreateDesc::CreateCube ( const TCHAR InDebugName)
inlinestatic

◆ CreateCubeArray() [1/2]

static FRHITextureCreateDesc FRHITextureCreateDesc::CreateCubeArray ( const TCHAR DebugName,
uint32  Size,
uint16  ArraySize,
EPixelFormat  Format 
)
inlinestatic

◆ CreateCubeArray() [2/2]

static FRHITextureCreateDesc FRHITextureCreateDesc::CreateCubeArray ( const TCHAR InDebugName)
inlinestatic

◆ DetermineInititialState()

FRHITextureCreateDesc & FRHITextureCreateDesc::DetermineInititialState ( )
inline

◆ GetTraceClassName()

FName FRHITextureCreateDesc::GetTraceClassName ( ) const
inline

◆ SetArraySize()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetArraySize ( uint16  InArraySize)
inline

◆ SetBulkData()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetBulkData ( FResourceBulkDataInterface InBulkData)
inline

◆ SetClassName()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetClassName ( FName  InClassName)
inline

◆ SetClearValue()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetClearValue ( FClearValueBinding  InClearValue)
inline

◆ SetDebugName()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetDebugName ( const TCHAR InDebugName)
inline

◆ SetDepth()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetDepth ( uint16  InDepth)
inline

◆ SetDimension()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetDimension ( ETextureDimension  InDimension)
inline

◆ SetExtData()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetExtData ( uint32  InExtData)
inline

◆ SetExtent() [1/3]

FRHITextureCreateDesc & FRHITextureCreateDesc::SetExtent ( const FIntPoint InExtent)
inline

◆ SetExtent() [2/3]

FRHITextureCreateDesc & FRHITextureCreateDesc::SetExtent ( int32  InExtentX,
int32  InExtentY 
)
inline

◆ SetExtent() [3/3]

FRHITextureCreateDesc & FRHITextureCreateDesc::SetExtent ( uint32  InExtent)
inline

◆ SetFastVRAMPercentage()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetFastVRAMPercentage ( float  InFastVRAMPercentage)
inline

◆ SetFlags()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetFlags ( ETextureCreateFlags  InFlags)
inline

◆ SetFormat()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetFormat ( EPixelFormat  InFormat)
inline

◆ SetGPUMask()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetGPUMask ( FRHIGPUMask  InGPUMask)
inline

◆ SetInitAction()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetInitAction ( ERHITextureInitAction  InInitAction)
inline

◆ SetInitActionBulkData()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetInitActionBulkData ( FResourceBulkDataInterface InBulkData)
inline

◆ SetInitActionInitializer()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetInitActionInitializer ( )
inline

◆ SetInitActionNone()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetInitActionNone ( )
inline

◆ SetInitialState()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetInitialState ( ERHIAccess  InInitialState)
inline

◆ SetNumMips()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetNumMips ( uint8  InNumMips)
inline

◆ SetNumSamples()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetNumSamples ( uint8  InNumSamples)
inline

◆ SetOwnerName()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetOwnerName ( FName  InOwnerName)
inline

◆ SetUAVFormat()

FRHITextureCreateDesc & FRHITextureCreateDesc::SetUAVFormat ( EPixelFormat  InUAVFormat)
inline

Member Data Documentation

◆ BulkData

FResourceBulkDataInterface* FRHITextureCreateDesc::BulkData = nullptr

◆ ClassName

FName FRHITextureCreateDesc::ClassName = NAME_None

◆ DebugName

const TCHAR* FRHITextureCreateDesc::DebugName = nullptr

◆ InitAction

ERHITextureInitAction FRHITextureCreateDesc::InitAction = ERHITextureInitAction::Default

◆ InitialState

ERHIAccess FRHITextureCreateDesc::InitialState = ERHIAccess::Unknown

◆ OwnerName

FName FRHITextureCreateDesc::OwnerName = NAME_None

The documentation for this struct was generated from the following file: