DescriptorAllocator Class Reference

Manage descriptor set allocations by creating and reusing internal descriptor pools. More...

#include <DescriptorAllocator.hpp>

Classes
struct	DescriptorPool
	Descriptor pool management info. More...

Public Member Functions
void	init (GPUContext *context, uint poolCount)
DescriptorSet	allocateSet (VkDescriptorSetLayout &setLayout)
void	freeSet (const DescriptorSet &set)
void	clean ()
VkDescriptorPool	getImGuiPool ()

Private Member Functions
DescriptorPool	createPool (uint count, bool combined)

Private Attributes
GPUContext *	_context = nullptr
	The GPU context.
std::deque< DescriptorPool >	_pools
	Available pools.
DescriptorPool	_imguiPool
	ImGui dedicated pool.
uint	_maxPoolCount = 2
	Maximum number of pools to create.
uint	_currentPoolCount = 0
	Current number of created pools.

Detailed Description

Manage descriptor set allocations by creating and reusing internal descriptor pools.

By default each pool will contain up to DEFAULT_SET_COUNT of each kind defined in createPool.

Member Function Documentation

allocateSet()

DescriptorSet DescriptorAllocator::allocateSet

(

VkDescriptorSetLayout &

setLayout

)

Allocate a descriptor set from an available pool, using the specified layout.

Parameters

setLayout

the layout to use

Returns

the allocated descriptor set info

clean()

void DescriptorAllocator::clean

(

)

Reset all descriptor pools

createPool()

DescriptorAllocator::DescriptorPool DescriptorAllocator::createPool ( uint  count, bool  combined  )

private

Create a descriptor pool containing count descriptors.

Parameters

count	the maximmum number of descriptors of each type to store in the poll
combined	should images and samplers be represented by combined descriptors or separate sampled image/sampler descriptors.

Returns

descriptor pool info

freeSet()

void DescriptorAllocator::freeSet

(

const DescriptorSet &

set

)

Mark an allocated descriptor set as unused

Parameters

set	the set to free

getImGuiPool()

VkDescriptorPool DescriptorAllocator::getImGuiPool ( )

inline

Returns

the ImGui dedicated descriptor pool

init()

void DescriptorAllocator::init	(	GPUContext *	context,
		uint	poolCount
	)

Setup the allocator.

Parameters

context	the GPU context
poolCount	the maximum number of pools to allocate

---

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

• src/engine/graphics/DescriptorAllocator.hpp
• src/engine/graphics/DescriptorAllocator.cpp