FRHITransientResource Class Reference

#include <RHITransientResourceAllocator.h>

Inheritance diagram for FRHITransientResource:

Classes
struct	FResourceTaskResult

Public Types
using	FResourceTask = UE::Tasks::TTask< FResourceTaskResult >

Public Member Functions
RHI_API	FRHITransientResource (FRHIResource *InResource, uint64 InGpuVirtualAddress, uint64 InHash, uint64 InSize, ERHITransientAllocationType InAllocationType, ERHITransientResourceType InResourceType)
RHI_API	FRHITransientResource (const FResourceTask &InResourceTask, uint64 InHash, uint64 InSize, ERHITransientAllocationType InAllocationType, ERHITransientResourceType InResourceType)
virtual RHI_API	~FRHITransientResource ()
void	Acquire (const TCHAR *InName, uint32 InAcquirePassIndex, ERHIPipeline InAcquirePipeline, uint64 InAllocatorCycle)
	Internal Allocator API.
void	Discard (const FRHITransientAllocationFences &Fences)
void	AddAliasingOverlap (FRHITransientResource *InBeforeResource, uint32 InAcquirePassIndex)
void	Finish (FRHICommandListBase &RHICmdList)
FRHITransientHeapAllocation &	GetHeapAllocation ()
const FRHITransientHeapAllocation &	GetHeapAllocation () const
FRHITransientPageAllocation &	GetPageAllocation ()
const FRHITransientPageAllocation &	GetPageAllocation () const
FRHIResource *	GetRHI () const
uint64	GetGpuVirtualAddress () const
bool	HasResourceTask () const
const TCHAR *	GetName () const
uint64	GetHash () const
uint64	GetSize () const
uint64	GetAcquireCycle () const
uint32	GetAcquireCount () const
TConstArrayView< FRHITransientAliasingOverlap >	GetAliasingOverlaps () const
uint32	GetAcquirePass () const
uint32	GetDiscardPass () const
bool	IsAcquired () const
bool	IsDiscarded () const
ERHITransientResourceType	GetResourceType () const
bool	IsTexture () const
bool	IsBuffer () const
ERHITransientAllocationType	GetAllocationType () const
bool	IsHeapAllocated () const
bool	IsPageAllocated () const

Static Public Attributes
static const uint32	kInvalidPassIndex = TNumericLimits<uint32>::Max()

Member Typedef Documentation

FResourceTask

using FRHITransientResource::FResourceTask = UE::Tasks::TTask<FResourceTaskResult>

Constructor & Destructor Documentation

FRHITransientResource() [1/2]

FRHITransientResource::FRHITransientResource	(	FRHIResource *	InResource,
		uint64	InGpuVirtualAddress,
		uint64	InHash,
		uint64	InSize,
		ERHITransientAllocationType	InAllocationType,
		ERHITransientResourceType	InResourceType
	)

FRHITransientResource() [2/2]

FRHITransientResource::FRHITransientResource	(	const FResourceTask &	InResourceTask,
		uint64	InHash,
		uint64	InSize,
		ERHITransientAllocationType	InAllocationType,
		ERHITransientResourceType	InResourceType
	)

~FRHITransientResource()

FRHITransientResource::~FRHITransientResource ( )

virtualdefault

Member Function Documentation

Acquire()

void FRHITransientResource::Acquire ( const TCHAR *  InName, uint32  InAcquirePassIndex, ERHIPipeline  InAcquirePipeline, uint64  InAllocatorCycle  )

inline

Internal Allocator API.

AddAliasingOverlap()

void FRHITransientResource::AddAliasingOverlap ( FRHITransientResource *  InBeforeResource, uint32  InAcquirePassIndex  )

inline

Discard()

void FRHITransientResource::Discard ( const FRHITransientAllocationFences &  Fences )

inline

Finish()

void FRHITransientResource::Finish ( FRHICommandListBase &  RHICmdList )

inline

GetAcquireCount()

uint32 FRHITransientResource::GetAcquireCount ( ) const

inline

GetAcquireCycle()

uint64 FRHITransientResource::GetAcquireCycle ( ) const

inline

GetAcquirePass()

uint32 FRHITransientResource::GetAcquirePass ( ) const

inline

GetAliasingOverlaps()

TConstArrayView< FRHITransientAliasingOverlap > FRHITransientResource::GetAliasingOverlaps ( ) const

inline

GetAllocationType()

ERHITransientAllocationType FRHITransientResource::GetAllocationType ( ) const

inline

GetDiscardPass()

uint32 FRHITransientResource::GetDiscardPass ( ) const

inline

GetGpuVirtualAddress()

uint64 FRHITransientResource::GetGpuVirtualAddress ( ) const

inline

GetHash()

uint64 FRHITransientResource::GetHash ( ) const

inline

GetHeapAllocation() [1/2]

FRHITransientHeapAllocation & FRHITransientResource::GetHeapAllocation ( )

inline

GetHeapAllocation() [2/2]

const FRHITransientHeapAllocation & FRHITransientResource::GetHeapAllocation ( ) const

inline

GetName()

const TCHAR * FRHITransientResource::GetName ( ) const

inline

GetPageAllocation() [1/2]

FRHITransientPageAllocation & FRHITransientResource::GetPageAllocation ( )

inline

GetPageAllocation() [2/2]

const FRHITransientPageAllocation & FRHITransientResource::GetPageAllocation ( ) const

inline

GetResourceType()

ERHITransientResourceType FRHITransientResource::GetResourceType ( ) const

inline

GetRHI()

FRHIResource * FRHITransientResource::GetRHI ( ) const

inline

GetSize()

uint64 FRHITransientResource::GetSize ( ) const

inline

HasResourceTask()

bool FRHITransientResource::HasResourceTask ( ) const

inline

IsAcquired()

bool FRHITransientResource::IsAcquired ( ) const

inline

IsBuffer()

bool FRHITransientResource::IsBuffer ( ) const

inline

IsDiscarded()

bool FRHITransientResource::IsDiscarded ( ) const

inline

IsHeapAllocated()

bool FRHITransientResource::IsHeapAllocated ( ) const

inline

IsPageAllocated()

bool FRHITransientResource::IsPageAllocated ( ) const

inline

IsTexture()

bool FRHITransientResource::IsTexture ( ) const

inline

Member Data Documentation

kInvalidPassIndex

const uint32 FRHITransientResource::kInvalidPassIndex = TNumericLimits<uint32>::Max()

static

---

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

• Engine/Source/Runtime/RHI/Public/RHITransientResourceAllocator.h
• Engine/Source/Runtime/RHI/Private/RHITransientResourceAllocator.cpp