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

#include <RHIResources.h>

+ Inheritance diagram for FRHITexture:

Public Member Functions

virtual const FRHITextureDesc & GetDesc () const
 
virtual class FRHITextureReference * GetTextureReference ()
 
virtual FRHIDescriptorHandle GetDefaultBindlessHandle () const
 
virtual void * GetNativeResource () const
 
virtual void * GetNativeShaderResourceView () const
 
virtual void * GetTextureBaseRHI ()
 
virtual void GetWriteMaskProperties (void *&OutData, uint32 &OutSize)
 
FIntVector GetSizeXYZ () const
 
FIntVector GetMipDimensions (uint8 MipIndex) const
 
bool IsMultisampled () const
 
bool HasClearValue () const
 
FLinearColor GetClearColor () const
 
void GetDepthStencilClearValue (float &OutDepth, uint32 &OutStencil) const
 
float GetDepthClearValue () const
 
uint32 GetStencilClearValue () const
 
void SetLastRenderTime (float InLastRenderTime)
 
double GetLastRenderTime () const
 
RHI_API void SetName (FName InName)
 
FRHITexture * GetTexture2D ()
 
FRHITexture * GetTexture2DArray ()
 
FRHITexture * GetTexture3D ()
 
FRHITexture * GetTextureCube ()
 
uint32 GetSizeX () const
 
uint32 GetSizeY () const
 
FIntPoint GetSizeXY () const
 
uint32 GetSizeZ () const
 
uint32 GetNumMips () const
 
EPixelFormat GetFormat () const
 
ETextureCreateFlags GetFlags () const
 
uint32 GetNumSamples () const
 
const FClearValueBinding GetClearBinding () const
 
uint32 GetSize () const
 
- Public Member Functions inherited from FRHIViewableResource
ERHIAccess GetTrackedAccess_Unsafe () const
 
FName GetName () const
 
- Public Member Functions inherited from FRHIResource
RHI_API FRHIResource (ERHIResourceType InResourceType)
 
uint32 AddRef () const
 
uint32 Release () const
 
uint32 GetRefCount () const
 
bool IsValid () const
 
void DisableLifetimeExtension ()
 
ERHIResourceType GetType () const
 
FName GetOwnerName () const
 
void SetOwnerName (FName InOwnerName)
 

Protected Member Functions

 FRHITexture ()=delete
 
RHI_API FRHITexture (const FRHITextureCreateDesc &CreateDesc)
 
RHI_API FRHITexture (ERHIResourceType InResourceType)
 
- Protected Member Functions inherited from FRHIViewableResource
 FRHIViewableResource (ERHIResourceType InResourceType, ERHIAccess InAccess, const TCHAR *InName, FName InOwnerName)
 
virtual void SetTrackedAccessFromContext (FRHITrackedAccess InTrackedAccess)
 
void TakeOwnership (FRHIViewableResource &Other)
 
void ReleaseOwnership ()
 
- Protected Member Functions inherited from FRHIResource
virtual RHI_API ~FRHIResource ()
 

Friends

class FRHITextureReference
 

Additional Inherited Members

- Protected Attributes inherited from FRHIViewableResource
FName Name
 

Constructor & Destructor Documentation

◆ FRHITexture() [1/3]

FRHITexture::FRHITexture ( )
protecteddelete

◆ FRHITexture() [2/3]

FRHITexture::FRHITexture ( const FRHITextureCreateDesc &  CreateDesc)
protected

Initialization constructor. Should only be called by platform RHI implementations.

◆ FRHITexture() [3/3]

FRHITexture::FRHITexture ( ERHIResourceType  InResourceType)
protected

Constructor for texture references

Member Function Documentation

◆ GetClearBinding()

const FClearValueBinding FRHITexture::GetClearBinding ( ) const
inline

◆ GetClearColor()

FLinearColor FRHITexture::GetClearColor ( ) const
inline
Returns
the clear color value if set

◆ GetDefaultBindlessHandle()

virtual FRHIDescriptorHandle FRHITexture::GetDefaultBindlessHandle ( ) const
inlinevirtual

Reimplemented in FD3D12Texture, FRHITextureReference, and FVulkanTexture.

◆ GetDepthClearValue()

float FRHITexture::GetDepthClearValue ( ) const
inline
Returns
the depth clear value if set

◆ GetDepthStencilClearValue()

void FRHITexture::GetDepthStencilClearValue ( float &  OutDepth,
uint32 &  OutStencil 
) const
inline
Returns
the depth & stencil clear value if set

◆ GetDesc()

virtual const FRHITextureDesc & FRHITexture::GetDesc ( ) const
inlinevirtual

Get the texture description used to create the texture Still virtual because FRHITextureReference can override this function - remove virtual when FRHITextureReference is deprecated

Returns
TextureDesc used to create the texture

Reimplemented in FRHITextureReference.

◆ GetFlags()

ETextureCreateFlags FRHITexture::GetFlags ( ) const
inline

◆ GetFormat()

EPixelFormat FRHITexture::GetFormat ( ) const
inline

◆ GetLastRenderTime()

double FRHITexture::GetLastRenderTime ( ) const
inline

◆ GetMipDimensions()

FIntVector FRHITexture::GetMipDimensions ( uint8  MipIndex) const
inline

Returns the dimensions (i.e. the actual number of texels in each dimension) of the specified mip. ArraySize is ignored. The Z component will always be 1 for 2D/cube resources and will contain depth for volume textures. This differs from GetSizeXYZ() which returns ArraySize in Z for 2D arrays.

◆ GetNativeResource()

virtual void * FRHITexture::GetNativeResource ( ) const
inlinevirtual

Returns access to the platform-specific native resource pointer. This is designed to be used to provide plugins with access to the underlying resource and should be used very carefully or not at all.

Returns
The pointer to the native resource or NULL if it not initialized or not supported for this resource type for some reason

Reimplemented in FOpenGLTexture, FRHITextureReference, FD3D11Texture, FMetalSurface, FD3D12Texture, and FVulkanTexture.

◆ GetNativeShaderResourceView()

virtual void * FRHITexture::GetNativeShaderResourceView ( ) const
inlinevirtual

Returns access to the platform-specific native shader resource view pointer. This is designed to be used to provide plugins with access to the underlying resource and should be used very carefully or not at all.

Returns
The pointer to the native resource or NULL if it not initialized or not supported for this resource type for some reason

Reimplemented in FRHITextureReference, and FD3D11Texture.

◆ GetNumMips()

uint32 FRHITexture::GetNumMips ( ) const
inline

◆ GetNumSamples()

uint32 FRHITexture::GetNumSamples ( ) const
inline

◆ GetSize()

uint32 FRHITexture::GetSize ( ) const
inline

◆ GetSizeX()

uint32 FRHITexture::GetSizeX ( ) const
inline

◆ GetSizeXY()

FIntPoint FRHITexture::GetSizeXY ( ) const
inline

◆ GetSizeXYZ()

FIntVector FRHITexture::GetSizeXYZ ( ) const
inline

Helper getter functions - non virtual Returns the x, y & z dimensions if the texture The Z component will always be 1 for 2D/cube resources and will contain depth for volume textures & array size for array textures

◆ GetSizeY()

uint32 FRHITexture::GetSizeY ( ) const
inline

◆ GetSizeZ()

uint32 FRHITexture::GetSizeZ ( ) const
inline

◆ GetStencilClearValue()

uint32 FRHITexture::GetStencilClearValue ( ) const
inline
Returns
the stencil clear value if set

◆ GetTexture2D()

FRHITexture * FRHITexture::GetTexture2D ( )
inline

Deprecated functions

◆ GetTexture2DArray()

FRHITexture * FRHITexture::GetTexture2DArray ( )
inline

◆ GetTexture3D()

FRHITexture * FRHITexture::GetTexture3D ( )
inline

◆ GetTextureBaseRHI()

virtual void * FRHITexture::GetTextureBaseRHI ( )
inlinevirtual

Returns access to the platform-specific RHI texture baseclass. This is designed to provide the RHI with fast access to its base classes in the face of multiple inheritance.

Returns
The pointer to the platform-specific RHI texture baseclass or NULL if it not initialized or not supported for this RHI

Reimplemented in FRHITextureReference, FD3D11Texture, FMetalSurface, FD3D12Texture, FOpenGLTexture, and FVulkanTexture.

◆ GetTextureCube()

FRHITexture * FRHITexture::GetTextureCube ( )
inline

◆ GetTextureReference()

virtual class FRHITextureReference * FRHITexture::GetTextureReference ( )
inlinevirtual

Virtual functions implemented per RHI

Reimplemented in FRHITextureReference.

◆ GetWriteMaskProperties()

virtual void FRHITexture::GetWriteMaskProperties ( void *&  OutData,
uint32 &  OutSize 
)
inlinevirtual

Reimplemented in FRHITextureReference.

◆ HasClearValue()

bool FRHITexture::HasClearValue ( ) const
inline
Returns
Whether the texture has a clear color defined

◆ IsMultisampled()

bool FRHITexture::IsMultisampled ( ) const
inline
Returns
Whether the texture is multi sampled.

◆ SetLastRenderTime()

void FRHITexture::SetLastRenderTime ( float  InLastRenderTime)
inline

RenderTime & Name functions - non virtual sets the last time this texture was cached in a resource table.

◆ SetName()

void FRHITexture::SetName ( FName  InName)

Friends And Related Symbol Documentation

◆ FRHITextureReference

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