FRHITransientResourceHeapAllocator | Unreal Engine 5.7 Documentation

A base class for implementing IRHITransientResourceAllocator for a virtual aliasing placed resource heap allocation strategy.


Name	FRHITransientResourceHeapAllocator
Type	class
Header File	/Engine/Source/Runtime/RHICore/Public/RHICoreTransientResourceAllocator.h
Include Path	#include "RHICoreTransientResourceAllocator.h"

Syntax

class FRHITransientResourceHeapAllocator : public IRHITransientResourceAllocator

Name	Remarks	Include Path	Unreal Specifiers
FRHITransientResourceHeapAllocator ( FRHITransientHeapCache& InHeapCache )		RHICoreTransientResourceAllocator.h

Name	Remarks	Include Path	Unreal Specifiers
~FRHITransientResourceHeapAllocator()		RHICoreTransientResourceAllocator.h

Name	Type	Remarks	Include Path	Unreal Specifiers
HeapCache	FRHITransientHeapCache &		RHICoreTransientResourceAllocator.h

Name	Type	Include Path
ActiveResources	TSet< FRHITransientResource * >	RHICoreTransientResourceAllocator.h
CreateMode	ERHITransientResourceCreateMode	RHICoreTransientResourceAllocator.h
CurrentCycle	uint64	RHICoreTransientResourceAllocator.h
DeallocationCount	uint32	RHICoreTransientResourceAllocator.h
Heaps	TArray< FRHITransientHeap * >	RHICoreTransientResourceAllocator.h

Name	Remarks	Include Path	Unreal Specifiers
TransientResourceType * CreateTransientResource ( LambdaType&& Lambda, uint64 Hash, uint64 Size, const ResourceCreateInfo& CreateInfo )		RHICoreTransientResourceAllocator.h
TConstArrayView< FRHITransientHeap * > GetHeaps()	Returns the array of heaps used by this allocator, including the required commit size for each.	RHICoreTransientResourceAllocator.h

Name	Remarks	Include Path
virtual void DeallocateMemory ( FRHITransientTexture* Texture, const FRHITransientAllocationFences& Fences )	Deallocates a texture from its parent heap. Provide the current platform fence value used to update the heap.	RHICoreTransientResourceAllocator.h
virtual void DeallocateMemory ( FRHITransientBuffer* Buffer, const FRHITransientAllocationFences& Fences )	Deallocates a buffer from its parent heap. Provide the current platform fence value used to update the heap.	RHICoreTransientResourceAllocator.h
virtual void Flush ( FRHICommandListImmediate& RHICmdList, FRHITransientAllocationStats* OutAllocationStats )	Called to flush any active allocations prior to rendering.	RHICoreTransientResourceAllocator.h
virtual void SetCreateMode ( ERHITransientResourceCreateMode InCreateMode )	Sets the create mode for allocations.	RHICoreTransientResourceAllocator.h

Name	Remarks	Include Path	Unreal Specifiers
FRHITransientBuffer * CreateBufferInternal ( const FRHIBufferCreateInfo& CreateInfo, const TCHAR* DebugName, const FRHITransientAllocationFences& Fences, uint32 BufferSize, uint32 BufferAlignment, FRHITransientHeap::FCreateBufferFunction CreateBufferFunction )	Allocates a buffer on a heap at a specific offset, returning a cached RHI transient buffer pointer, or null if the allocation failed.	RHICoreTransientResourceAllocator.h
FRHITransientTexture * CreateTextureInternal ( const FRHITextureCreateInfo& CreateInfo, const TCHAR* DebugName, const FRHITransientAllocationFences& Fences, uint64 TextureSize, uint32 TextureAlignment, FRHITransientHeap::FCreateTextureFunction CreateTextureFunction )	Allocates a texture on a heap at a specific offset, returning a cached RHI transient texture pointer, or null if the allocation failed.	RHICoreTransientResourceAllocator.h