#include <RHITextureReference.h>

Inheritance diagram for FRHITextureReference:

Public Member Functions
	FRHITextureReference ()=delete

RHI_API	FRHITextureReference (FRHITexture *InReferencedTexture)

RHI_API	~FRHITextureReference ()

virtual RHI_API class FRHITextureReference *	GetTextureReference () override

virtual RHI_API FRHIDescriptorHandle	GetDefaultBindlessHandle () const override

virtual RHI_API void *	GetNativeResource () const override

virtual RHI_API void *	GetNativeShaderResourceView () const override

virtual RHI_API void *	GetTextureBaseRHI () override

virtual RHI_API void	GetWriteMaskProperties (void *&OutData, uint32 &OutSize) override

virtual RHI_API const FRHITextureDesc &	GetDesc () const override

FRHITexture *	GetReferencedTexture () const

Public Member Functions inherited from FRHITexture
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)

Static Public Member Functions
static FRHITexture *	GetDefaultTexture ()

Protected Member Functions
virtual RHI_API void	SetTrackedAccessFromContext (FRHITrackedAccess TrackedAccess) override

void	SetReferencedTexture (FRHITexture *InTexture)

Protected Member Functions inherited from FRHITexture
	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)

void	TakeOwnership (FRHIViewableResource &Other)

void	ReleaseOwnership ()

Protected Member Functions inherited from FRHIResource
virtual RHI_API	~FRHIResource ()

Protected Attributes
TRefCountPtr< FRHITexture >	ReferencedTexture

Protected Attributes inherited from FRHIViewableResource
FName	Name

Static Protected Attributes
static RHI_API TRefCountPtr< FRHITexture >	DefaultTexture

Friends
class	FDynamicRHI

class	FBlackTextureWithSRV

Constructor & Destructor Documentation

◆ FRHITextureReference() [1/2]

FRHITextureReference::FRHITextureReference ( )

delete

◆ FRHITextureReference() [2/2]

FRHITextureReference::FRHITextureReference ( FRHITexture * InReferencedTexture )

◆ ~FRHITextureReference()

FRHITextureReference::~FRHITextureReference ( )

default

Member Function Documentation

◆ GetDefaultBindlessHandle()

FRHIDescriptorHandle FRHITextureReference::GetDefaultBindlessHandle ( ) const

overridevirtual

Reimplemented from FRHITexture.

◆ GetDefaultTexture()

static FRHITexture * FRHITextureReference::GetDefaultTexture ( )

inlinestatic

◆ GetDesc()

const FRHITextureDesc & FRHITextureReference::GetDesc ( ) const

overridevirtual

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 from FRHITexture.

◆ GetNativeResource()

void * FRHITextureReference::GetNativeResource ( ) const

overridevirtual

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 from FRHITexture.

◆ GetNativeShaderResourceView()

void * FRHITextureReference::GetNativeShaderResourceView ( ) const

overridevirtual

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 from FRHITexture.

◆ GetReferencedTexture()

FRHITexture * FRHITextureReference::GetReferencedTexture ( ) const

inline

◆ GetTextureBaseRHI()

void * FRHITextureReference::GetTextureBaseRHI ( )

overridevirtual

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 from FRHITexture.

◆ GetTextureReference()

FRHITextureReference * FRHITextureReference::GetTextureReference ( )

overridevirtual

Virtual functions implemented per RHI

Reimplemented from FRHITexture.

◆ GetWriteMaskProperties()

void FRHITextureReference::GetWriteMaskProperties	(	void *&	OutData,
		uint32 &	OutSize
	)

overridevirtual

Reimplemented from FRHITexture.

◆ SetReferencedTexture()

void FRHITextureReference::SetReferencedTexture ( FRHITexture * InTexture )

inlineprotected

◆ SetTrackedAccessFromContext()

void FRHITextureReference::SetTrackedAccessFromContext ( FRHITrackedAccess TrackedAccess )

overrideprotectedvirtual

Reimplemented from FRHIViewableResource.

Friends And Related Symbol Documentation

◆ FBlackTextureWithSRV

friend class FBlackTextureWithSRV

friend

◆ FDynamicRHI

friend class FDynamicRHI

friend

Member Data Documentation

◆ DefaultTexture

TRefCountPtr< FRHITexture > FRHITextureReference::DefaultTexture

staticprotected

◆ ReferencedTexture

TRefCountPtr<FRHITexture> FRHITextureReference::ReferencedTexture

protected

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

Engine/Source/Runtime/RHI/Public/RHITextureReference.h
Engine/Source/Runtime/RHI/Private/RHI.cpp
Engine/Source/Runtime/RHI/Private/RHITextureReference.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Constructor & Destructor Documentation

◆ FRHITextureReference() [1/2]

◆ FRHITextureReference() [2/2]

◆ ~FRHITextureReference()

Member Function Documentation

◆ GetDefaultBindlessHandle()

◆ GetDefaultTexture()

◆ GetDesc()

◆ GetNativeResource()

◆ GetNativeShaderResourceView()

◆ GetReferencedTexture()

◆ GetTextureBaseRHI()

◆ GetTextureReference()

◆ GetWriteMaskProperties()

◆ SetReferencedTexture()

◆ SetTrackedAccessFromContext()

Friends And Related Symbol Documentation

◆ FBlackTextureWithSRV

◆ FDynamicRHI

Member Data Documentation

◆ DefaultTexture

◆ ReferencedTexture