UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FTexture2DResource Class Reference

#include <Texture2DResource.h>

+ Inheritance diagram for FTexture2DResource:

Public Member Functions

 FTexture2DResource (UTexture2D *InOwner, const FStreamableRenderResourceState &InPostInitState)
 
virtual ~FTexture2DResource ()
 
virtual FTexture2DResourceGetTexture2DResource ()
 
virtual const FTexture2DResourceGetTexture2DResource () const
 
void CacheSamplerStateInitializer (const UTexture2D *InOwner)
 
virtual uint64 GetPlatformMipsSize (uint32 NumMips) const override
 
virtual void InitRHI (FRHICommandListBase &RHICmdList) override
 
virtual bool IsProxy () const override
 
- Public Member Functions inherited from FStreamableTextureResource
 FStreamableTextureResource (UTexture *InOwner, const FTexturePlatformData *InPlatformData, const FStreamableRenderResourceState &InPostInitState, bool bAllowPartiallyResidentMips)
 
virtual FStreamableTextureResourceGetStreamableTextureResource ()
 
virtual const FStreamableTextureResourceGetStreamableTextureResource () const
 
virtual uint32 GetSizeX () const final override
 
virtual uint32 GetSizeY () const final override
 
virtual uint32 GetSizeZ () const final override
 
virtual void ReleaseRHI () final override
 
FStreamableRenderResourceState GetState () const
 
FStreamableRenderResourceState GetPostInitState () const
 
void FinalizeStreaming (FRHICommandListBase &RHICmdList, FRHITexture *InTextureRHI)
 
void FinalizeStreaming (FRHITexture *InTextureRHI)
 
TArrayView< const FTexture2DMipMap * > GetPlatformMipsView () const
 
const FTexture2DMipMapGetPlatformMip (int32 MipIdx) const
 
EPixelFormat GetPixelFormat () const
 
ETextureCreateFlags GetCreationFlags () const
 
const FNameGetTextureName () const
 
TextureGroup GetLODGroup () const
 
void RefreshSamplerStates ()
 
int32 GetCurrentFirstMip () const
 
uint32 GetExtData () const
 
- Public Member Functions inherited from FTextureResource
 FTextureResource ()
 
virtual ~FTextureResource ()
 
virtual FTexture3DResourceGetTexture3DResource ()
 
virtual FTexture2DArrayResourceGetTexture2DArrayResource ()
 
virtual FVirtualTexture2DResourceGetVirtualTexture2DResource ()
 
virtual const FTexture3DResourceGetTexture3DResource () const
 
virtual const FTexture2DArrayResourceGetTexture2DArrayResource () const
 
virtual const FVirtualTexture2DResourceGetVirtualTexture2DResource () const
 
int32 GetCurrentMipCount () const
 
bool IsTextureRHIPartiallyResident () const
 
FRHITextureGetTexture2DRHI () const
 
FRHITextureGetTexture3DRHI () const
 
FRHITextureGetTexture2DArrayRHI () const
 
void SetTextureReference (FRHITextureReference *TextureReference)
 
FRHITextureReferenceGetTextureReference () const
 
- Public Member Functions inherited from FTexture
RENDERCORE_API FTexture ()
 
virtual RENDERCORE_API ~FTexture ()
 
RENDERCORE_API FTexture (const FTexture &)
 
RENDERCORE_API FTexture (FTexture &&)
 
RENDERCORE_API FTextureoperator= (const FTexture &Other)
 
RENDERCORE_API FTextureoperator= (FTexture &&Other)
 
const FTextureRHIRefGetTextureRHI ()
 
virtual RENDERCORE_API FString GetFriendlyName () const override
 
- Public Member Functions inherited from FRenderResource
RENDERCORE_API FRenderResource ()
 
RENDERCORE_API FRenderResource (ERHIFeatureLevel::Type InFeatureLevel)
 
RENDERCORE_API FRenderResource (const FRenderResource &)
 
RENDERCORE_API FRenderResource (FRenderResource &&)
 
RENDERCORE_API FRenderResourceoperator= (const FRenderResource &Other)
 
RENDERCORE_API FRenderResourceoperator= (FRenderResource &&Other)
 
virtual RENDERCORE_API ~FRenderResource ()
 
virtual RENDERCORE_API void InitResource (FRHICommandListBase &RHICmdList)
 
virtual RENDERCORE_API void ReleaseResource ()
 
RENDERCORE_API void UpdateRHI (FRHICommandListBase &RHICmdList)
 
bool IsInitialized () const
 
int32 GetListIndex () const
 
EInitPhase GetInitPhase () const
 
void SetOwnerName (FName InOwnerName)
 
FName GetOwnerName () const
 
void SetResourceName (FName InResourceName)
 
FName GetResourceName () const
 

Static Public Member Functions

static uint32 CalculateTightPackedMipSize (int32 SizeX, int32 SizeY, EPixelFormat PixelFormat, uint32 &OutPitch)
 
static void WarnRequiresTightPackedMip (int32 SizeX, int32 SizeY, EPixelFormat PixelFormat, uint32 Pitch)
 
- Static Public Member Functions inherited from FRenderResource
static RENDERCORE_API void ReleaseRHIForAllResources ()
 
static RENDERCORE_API void InitPreRHIResources ()
 
static RENDERCORE_API void ChangeFeatureLevel (ERHIFeatureLevel::Type NewFeatureLevel)
 
static RENDERCORE_API FName SetScopeName (FName Name)
 

Friends

class UTexture2D
 
class FTexture2DUpdate
 
class FTexture2DMipAllocator_Virtual
 

Additional Inherited Members

- Public Types inherited from FRenderResource
enum class  EInitPhase : uint8 { Pre , Default , MAX }
 
- Public Attributes inherited from FTexture
FTextureRHIRef TextureRHI
 
FSamplerStateRHIRef SamplerStateRHI
 
FSamplerStateRHIRef DeferredPassSamplerStateRHI
 
double LastRenderTime = -FLT_MAX
 
FMipBiasFade MipBiasFade
 
bool bGreyScaleFormat = false
 
bool bIgnoreGammaConversions = false
 
bool bSRGB = false
 
- Public Attributes inherited from FRenderResource
ERenderResourceState ResourceState = ERenderResourceState::Default
 
- Protected Member Functions inherited from FRenderResource
void SetFeatureLevel (const FStaticFeatureLevel InFeatureLevel)
 
const FStaticFeatureLevel GetFeatureLevel () const
 
bool HasValidFeatureLevel () const
 
template<typename T >
FBufferRHIRef CreateRHIBuffer (FRHICommandListBase &RHICmdList, T &InOutResourceObject, uint32 ResourceCount, EBufferUsageFlags InBufferUsageFlags, const TCHAR *InDebugName)
 
void SetInitPhase (EInitPhase InInitPhase)
 
- Static Protected Member Functions inherited from FTexture
static RENDERCORE_API FRHISamplerStateGetOrCreateSamplerState (const FSamplerStateInitializerRHI &Initializer)
 
- Static Protected Member Functions inherited from FRenderResource
static RENDERCORE_API FRHICommandListBaseGetImmediateCommandList ()
 
- Protected Attributes inherited from FStreamableTextureResource
const FTexturePlatformDataPlatformData
 
FStreamableRenderResourceState State
 
TEnumAsByte< ESamplerFilterFilter = SF_Point
 
TEnumAsByte< ESamplerAddressModeAddressU = AM_Wrap
 
TEnumAsByte< ESamplerAddressModeAddressV = AM_Wrap
 
TEnumAsByte< ESamplerAddressModeAddressW = AM_Wrap
 
float MipBias = 0
 
uint32 SizeX = 0
 
uint32 SizeY = 0
 
uint32 SizeZ = 0
 
FName TextureName
 
EMipFadeSettings MipFadeSetting = MipFade_Normal
 
TextureGroup LODGroup = TEXTUREGROUP_World
 
EPixelFormat PixelFormat = PF_Unknown
 
ETextureCreateFlags CreationFlags = TexCreate_None
 
bool bUsePartiallyResidentMips = false
 
int8 MaxAniso = 0
 
- Protected Attributes inherited from FTextureResource
FTextureReferenceRHIRef TextureReferenceRHI
 

Detailed Description

FTextureResource implementation for streamable 2D textures.

Constructor & Destructor Documentation

◆ FTexture2DResource()

FTexture2DResource::FTexture2DResource ( UTexture2D InOwner,
const FStreamableRenderResourceState InState 
)

Minimal initialization constructor.

Parameters
InOwnerUTexture2D which this FTexture2DResource represents.
InPostInitStateThe renderthread coherent state the resource will have once InitRHI() will be called.

Minimal initialization constructor.

Parameters
InOwnerUTexture2D which this FTexture2DResource represents.
InState

◆ ~FTexture2DResource()

FTexture2DResource::~FTexture2DResource ( )
virtual

Destructor, freeing MipData in the case of resource being destroyed without ever having been initialized by the rendering thread via InitRHI.

Member Function Documentation

◆ CacheSamplerStateInitializer()

void FTexture2DResource::CacheSamplerStateInitializer ( const UTexture2D InOwner)

Set the value of Filter, AddressU, AddressV, AddressW and MipBias from FStreamableTextureResource on the gamethread.

◆ CalculateTightPackedMipSize()

uint32 FTexture2DResource::CalculateTightPackedMipSize ( int32  SizeX,
int32  SizeY,
EPixelFormat  PixelFormat,
uint32 OutPitch 
)
static

◆ GetPlatformMipsSize()

uint64 FTexture2DResource::GetPlatformMipsSize ( uint32  NumMips) const
overridevirtual

Returns the platform mip size for the given mip count.

Implements FStreamableTextureResource.

◆ GetTexture2DResource() [1/2]

virtual FTexture2DResource * FTexture2DResource::GetTexture2DResource ( )
inlinevirtual

Reimplemented from FTextureResource.

◆ GetTexture2DResource() [2/2]

virtual const FTexture2DResource * FTexture2DResource::GetTexture2DResource ( ) const
inlinevirtual

Reimplemented from FTextureResource.

◆ InitRHI()

void FTexture2DResource::InitRHI ( FRHICommandListBase RHICmdList)
overridevirtual

Initializes the RHI resources used by this resource. Called when entering the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

Reimplemented from FStreamableTextureResource.

◆ IsProxy()

virtual bool FTexture2DResource::IsProxy ( ) const
inlineoverridevirtual

Returns true if the resource is proxying another one.

Reimplemented from FTextureResource.

◆ WarnRequiresTightPackedMip()

void FTexture2DResource::WarnRequiresTightPackedMip ( int32  SizeX,
int32  SizeY,
EPixelFormat  PixelFormat,
uint32  Pitch 
)
static

Friends And Related Symbol Documentation

◆ FTexture2DMipAllocator_Virtual

◆ FTexture2DUpdate

friend class FTexture2DUpdate
friend

◆ UTexture2D

friend class UTexture2D
friend

Texture streaming command classes that need to be friends in order to call Update/FinalizeMipCount.


The documentation for this class was generated from the following files: