UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Attributes | List of all members
FTextureResource Class Reference

#include <TextureResource.h>

+ Inheritance diagram for FTextureResource:

Public Member Functions

 FTextureResource ()
 
virtual ~FTextureResource ()
 
virtual bool IsProxy () const
 
virtual FTexture2DResource * GetTexture2DResource ()
 
virtual FTexture3DResource * GetTexture3DResource ()
 
virtual FTexture2DArrayResource * GetTexture2DArrayResource ()
 
virtual FStreamableTextureResource * GetStreamableTextureResource ()
 
virtual FVirtualTexture2DResource * GetVirtualTexture2DResource ()
 
virtual const FTexture2DResource * GetTexture2DResource () const
 
virtual const FTexture3DResource * GetTexture3DResource () const
 
virtual const FTexture2DArrayResource * GetTexture2DArrayResource () const
 
virtual const FStreamableTextureResource * GetStreamableTextureResource () const
 
virtual const FVirtualTexture2DResource * GetVirtualTexture2DResource () const
 
int32 GetCurrentMipCount () const
 
bool IsTextureRHIPartiallyResident () const
 
FRHITexture * GetTexture2DRHI () const
 
FRHITexture * GetTexture3DRHI () const
 
FRHITexture * GetTexture2DArrayRHI () const
 
void SetTextureReference (FRHITextureReference *TextureReference)
 
FRHITextureReference * GetTextureReference () 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 FTexture & operator= (const FTexture &Other)
 
RENDERCORE_API FTexture & operator= (FTexture &&Other)
 
const FTextureRHIRef & GetTextureRHI ()
 
virtual RENDERCORE_API uint32 GetSizeX () const
 
virtual RENDERCORE_API uint32 GetSizeY () const
 
virtual RENDERCORE_API uint32 GetSizeZ () const
 
virtual RENDERCORE_API void ReleaseRHI () override
 
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 FRenderResource & operator= (const FRenderResource &Other)
 
RENDERCORE_API FRenderResource & operator= (FRenderResource &&Other)
 
virtual RENDERCORE_API ~FRenderResource ()
 
virtual void InitRHI (FRHICommandListBase &RHICmdList)
 
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
 

Protected Attributes

FTextureReferenceRHIRef TextureReferenceRHI
 

Additional Inherited Members

- Public Types inherited from FRenderResource
enum class  EInitPhase : uint8 { Pre , Default , MAX }
 
- 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)
 
- 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 FRHISamplerState * GetOrCreateSamplerState (const FSamplerStateInitializerRHI &Initializer)
 
- Static Protected Member Functions inherited from FRenderResource
static RENDERCORE_API FRHICommandListBase & GetImmediateCommandList ()
 

Detailed Description

The rendering resource which represents a texture.

Constructor & Destructor Documentation

◆ FTextureResource()

FTextureResource::FTextureResource ( )
inline

◆ ~FTextureResource()

virtual FTextureResource::~FTextureResource ( )
inlinevirtual

Member Function Documentation

◆ GetCurrentMipCount()

int32 FTextureResource::GetCurrentMipCount ( ) const
inline

◆ GetStreamableTextureResource() [1/2]

virtual FStreamableTextureResource * FTextureResource::GetStreamableTextureResource ( )
inlinevirtual

Reimplemented in FStreamableTextureResource.

◆ GetStreamableTextureResource() [2/2]

virtual const FStreamableTextureResource * FTextureResource::GetStreamableTextureResource ( ) const
inlinevirtual

Reimplemented in FStreamableTextureResource.

◆ GetTexture2DArrayResource() [1/2]

virtual FTexture2DArrayResource * FTextureResource::GetTexture2DArrayResource ( )
inlinevirtual

Reimplemented in FTexture2DArrayResource.

◆ GetTexture2DArrayResource() [2/2]

virtual const FTexture2DArrayResource * FTextureResource::GetTexture2DArrayResource ( ) const
inlinevirtual

Reimplemented in FTexture2DArrayResource.

◆ GetTexture2DArrayRHI()

FRHITexture * FTextureResource::GetTexture2DArrayRHI ( ) const
inline

◆ GetTexture2DResource() [1/2]

virtual FTexture2DResource * FTextureResource::GetTexture2DResource ( )
inlinevirtual

Reimplemented in FTexture2DResource.

◆ GetTexture2DResource() [2/2]

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

Reimplemented in FTexture2DResource.

◆ GetTexture2DRHI()

FRHITexture * FTextureResource::GetTexture2DRHI ( ) const
inline

◆ GetTexture3DResource() [1/2]

virtual FTexture3DResource * FTextureResource::GetTexture3DResource ( )
inlinevirtual

Reimplemented in FTexture3DResource.

◆ GetTexture3DResource() [2/2]

virtual const FTexture3DResource * FTextureResource::GetTexture3DResource ( ) const
inlinevirtual

Reimplemented in FTexture3DResource.

◆ GetTexture3DRHI()

FRHITexture * FTextureResource::GetTexture3DRHI ( ) const
inline

◆ GetTextureReference()

FRHITextureReference * FTextureResource::GetTextureReference ( ) const
inline

◆ GetVirtualTexture2DResource() [1/2]

virtual FVirtualTexture2DResource * FTextureResource::GetVirtualTexture2DResource ( )
inlinevirtual

Reimplemented in FVirtualTexture2DResource.

◆ GetVirtualTexture2DResource() [2/2]

virtual const FVirtualTexture2DResource * FTextureResource::GetVirtualTexture2DResource ( ) const
inlinevirtual

Reimplemented in FVirtualTexture2DResource.

◆ IsProxy()

virtual bool FTextureResource::IsProxy ( ) const
inlinevirtual

Returns true if the resource is proxying another one.

Reimplemented in FTexture2DArrayResource, FTexture3DResource, FTextureCubeResource, FTextureCubeArrayResource, and FTexture2DResource.

◆ IsTextureRHIPartiallyResident()

bool FTextureResource::IsTextureRHIPartiallyResident ( ) const
inline

◆ SetTextureReference()

void FTextureResource::SetTextureReference ( FRHITextureReference *  TextureReference)
inline

Member Data Documentation

◆ TextureReferenceRHI

FTextureReferenceRHIRef FTextureResource::TextureReferenceRHI
protected
The documentation for this class was generated from the following file: