FRHITextureDesc | Unreal Engine 5.7 Documentation

Descriptor used to create a texture resource


Name	FRHITextureDesc
Type	struct
Header File	/Engine/Source/Runtime/RHI/Public/RHIResources.h
Include Path	#include "RHIResources.h"

Syntax

struct FRHITextureDesc

Name	Remarks	Include Path	Unreal Specifiers
FRHITextureDesc ( const FRHITextureDesc& Other )		RHIResources.h
FRHITextureDesc ()		RHIResources.h
FRHITextureDesc ( ETextureDimension InDimension )		RHIResources.h
FRHITextureDesc ( ETextureDimension InDimension, ETextureCreateFlags InFlags, EPixelFormat InFormat, FClearValueBinding InClearValue, FIntPoint InExtent, uint16 InDepth, uint16 InArraySize, uint8 InNumMips, uint8 InNumSamples, uint32 InExtData )		RHIResources.h

Name	Type	Remarks	Include Path
AliasableFormats	TArray< EPixelFormat, TInlineAllocator< 1 > >	Array of pixel formats that this texture can alias to	RHIResources.h
ArraySize	uint16	The number of array elements in the texture. (Keep at 1 if dimension is 3D).	RHIResources.h
ClearValue	FClearValueBinding	Clear value to use when fast-clearing the texture.	RHIResources.h
Depth	uint16	Depth of the texture if the dimension is 3D.	RHIResources.h
Dimension	ETextureDimension	Texture dimension to use when creating the RHI texture.	RHIResources.h
ExtData	uint32	Platform-specific additional data. Used for offline processed textures on some platforms.	RHIResources.h
Extent	FIntPoint	Extent of the texture in x and y.	RHIResources.h
FastVRAMPercentage	uint8	Resource memory percentage which should be allocated onto fast VRAM (hint-only).	RHIResources.h
Flags	ETextureCreateFlags	Texture flags passed on to RHI texture.	RHIResources.h
Format	EPixelFormat	Pixel format used to create RHI texture.	RHIResources.h
GPUMask	FRHIGPUMask	A mask representing which GPUs to create the resource on, in a multi-GPU system.	RHIResources.h
NumMips	uint8	Number of mips in the texture mip-map chain.	RHIResources.h
NumSamples	uint8	Number of samples in the texture. >1 for MSAA.	RHIResources.h
UAVFormat	EPixelFormat	Texture format used when creating the UAV.	RHIResources.h

Name	Remarks	Include Path
uint64 CalcMemorySizeEstimate ( uint32 FirstMipIndex, uint32 LastMipIndex ) const	Returns an estimated total memory size the described texture will occupy in GPU memory.	RHIResources.h
uint64 CalcMemorySizeEstimate ( uint32 FirstMipIndex ) const		RHIResources.h
FIntVector GetSize()		RHIResources.h
uint16 GetSubresourceCount()		RHIResources.h
bool IsMipChain()		RHIResources.h
bool IsMultisample()		RHIResources.h
bool IsTexture2D()		RHIResources.h
bool IsTexture3D()		RHIResources.h
bool IsTextureArray()		RHIResources.h
bool IsTextureCube()		RHIResources.h
bool IsValid()	Returns whether this descriptor conforms to requirements.	RHIResources.h
void Reset()		RHIResources.h

Name	Remarks	Include Path	Unreal Specifiers
static bool CheckValidity ( const FRHITextureDesc& Desc, const TCHAR* Name )	Check the validity.	RHIResources.h
static bool Validate ( const FRHITextureDesc& Desc, const TCHAR* Name, bool bFatal )		RHIResources.h

Name	Remarks	Include Path	Unreal Specifiers
bool operator!= ( const FRHITextureDesc& Other ) const		RHIResources.h
FRHITextureDesc & operator= ( const FRHITextureDesc& Other )		RHIResources.h
bool operator== ( const FRHITextureDesc& Other ) const		RHIResources.h