Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > VulkanRHI > FVulkanResourceHeap

Light Theme

Dark Theme

FVulkanResourceHeap

A set of Device Allocations (Heap Pages) for a specific memory type.

Windows

MacOS

Linux

References

Module	VulkanRHI
Header	/Engine/Source/Runtime/VulkanRHI/Public/VulkanMemory.h
Include	#include "VulkanMemory.h"

Syntax

class FVulkanResourceHeap

Remarks

A set of Device Allocations (Heap Pages) for a specific memory type. This handles pooling allocations inside memory pages to avoid doing allocations directly off the device's heaps

Variables

		Name	Description
	TArray< FVulkan...	ActivePages
	bool	bIsHostCachedSupported
	bool	bIsLazilyAllocatedSupported
	uint8	DefragCountDown
	uint16	HeapIndex
	uint16	MemoryTypeIndex
	uint32	OverridePageSize
	FMemoryManager ...	Owner
	uint32	PageIDCounter
	TArray< FVulkan...	PageSizeBuckets
	uint32	PeakPageSize
	TArray< FVulkan...	UsedDedicatedImagePages
	uint64	UsedMemory

Constructors

	Name	Description
	FVulkanResourceHeap ( FMemoryManager* InOwner, uint32 InMemoryTypeIndex, uint32 InOverridePageSize )

Destructors

	Name	Description
	~FVulkanResourceHeap()

Functions

		Name	Description
	bool	AllocateDedicatedImage ( FVulkanAllocation& OutAllocation, FVulkanEvictable* AllocationOw..., VkImage Image, uint32 Size, uint32 Alignment, EVulkanAllocationMetaType MetaType, const char* File, uint32 Line )
	bool	AllocateResource ( FVulkanAllocation& OutAllocation, FVulkanEvictable* AllocationOw..., EType Type, uint32 Size, uint32 Alignment, bool bMapAllocation, bool bForceSeparateAllocation, EVulkanAllocationMetaType MetaType, const char* File, uint32 Line )
	void	DefragTick ( FVulkanDevice& Device, FVulkanCommandListContext& Context, uint32 Count )
	void	DumpMemory ( FResourceHeapStats& Stats )
	uint64	EvictOne ( FVulkanDevice& Device )
	void	FreePage ( FVulkanSubresourceAllocator* I... )
	bool	GetIsDefragging ( FVulkanSubresourceAllocator* A... )
	uint32	GetMemoryTypeIndex()
	FMemoryManag...	GetOwner()
	uint32	GetPageSize()
	uint32	GetPageSizeBucket ( FVulkanPageSizeBucket& BucketOut, EType Type, uint32 AllocationSize, bool bForceSingleAllocation )
	bool	IsHostCachedSupported()
	bool	IsLazilyAllocatedSupported()
	void	ReleasePage ( FVulkanSubresourceAllocator* I... )
	void	SetDefragging ( FVulkanSubresourceAllocator* A... )
	bool	TryRealloc ( FVulkanAllocation& OutAllocation, FVulkanEvictable* AllocationOw..., EType Type, uint32 Size, uint32 Alignment, EVulkanAllocationMetaType MetaType )

Constants

Name	Description
MAX_BUCKETS

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss