Static helpers for common Vulkan allocation, copy, descriptor, and debug operations. More...

#include <VulkanHelper.h>

Collaboration diagram for VulkanHelper:

Static Public Member Functions
static void	initializeDebugFunctions (VkInstance instance)
	Loads debug utils extension functions from an instance.
static void	initializeFunctions (VkInstance instance, VkDevice device)
	Loads all Vulkan extension functions used by the engine.
static const VulkanFunctions &	getFunctions ()
	Returns the loaded Vulkan extension function table.
template<typename T>
static void	loadVkFunction (VkInstance instance, const std::string &name, T &functionPointer)
	Loads one Vulkan instance-level function pointer.
template<typename T>
static void	loadVkDeviceFunction (VkDevice device, const std::string &name, T &functionPointer)
	Loads one Vulkan device-level function pointer.
static void	createBuffer (VkDevice device, VkPhysicalDevice physicalDevice, VkDeviceSize size, VkBufferUsageFlags usage, VkMemoryPropertyFlags properties, VkBuffer &buffer, VkDeviceMemory &bufferMemory)
	Creates a Vulkan buffer, allocates memory for it, and binds the memory at offset 0.
static void	uploadDataToExistingBuffer (VkDevice device, VkPhysicalDevice physicalDevice, VkCommandPool commandPool, VkQueue queue, VkDeviceSize size, const void *dataPtr, VkBuffer targetBuffer)
	Uploads CPU memory into an existing buffer through a temporary staging buffer.
static bool	isValid (void *object)
	Checks whether a Vulkan dispatchable handle value is non-null.
static std::string	strIsValid (void *object)
	Returns a checkmark or cross string for a Vulkan dispatchable handle value.
static uint32_t	findMemoryType (VkPhysicalDevice physicalDevice, uint32_t typeFilter, VkMemoryPropertyFlags properties)
	Finds a memory type index that satisfies a bitmask and required properties.
static bool	findSuitableMemoryType (VkPhysicalDevice physicalDevice, VkMemoryRequirements2 requirements, VkMemoryPropertyFlags properties, uint32_t &out_typeIndex)
	Finds a memory type index without throwing on failure.
static VkDeviceSize	align (VkDeviceSize value, VkDeviceSize alignment)
	Rounds a size up to the next multiple of an alignment.
static void	copyBuffer (VkDevice device, VkCommandPool commandPool, VkQueue graphicsQueue, VkBuffer sourceBuffer, VkBuffer destinationBuffer, VkDeviceSize size)
	Copies bytes from one buffer to another and waits for the queue to become idle.
static void	copyBufferMultiple (VkDevice device, VkCommandPool commandPool, VkQueue graphicsQueue, const std::vector< BufferCopyObject > &bufferCopyObjects)
	Copies several buffer regions in one command buffer and waits for the queue to become idle.
static void	recordBufferCopyMultiple (Engine::Core::ApplicationContext *context, VkCommandBuffer commandBuffer, const std::vector< BufferCopyObject > &bufferCopyObjects)
	Records several buffer copy commands into an existing command buffer.
static VkCommandBuffer	beginSingleTimeCommands (VkDevice device, VkCommandPool commandPool)
	Allocates and begins a primary command buffer for one-time submission.
static void	endSingleTimeCommands (VkDevice device, VkQueue graphicsQueue, VkCommandPool commandPool, VkCommandBuffer commandBuffer)
	Ends, submits, waits for, and frees a one-time command buffer.
static void	cleanupBuffer (VkDevice device, VkBuffer buffer, VkDeviceMemory bufferMemory)
	Destroys a buffer and frees its memory when the handles are non-null.
static void	createImage (VkDevice device, VkPhysicalDevice physicalDevice, uint32_t width, uint32_t height, VkFormat format, VkImageTiling tiling, VkImageUsageFlags usage, VkMemoryPropertyFlags properties, VkImage &image, VkDeviceMemory &imageMemory)
	Creates a 2D image, allocates memory for it, and binds the memory at offset 0.
static void	transitionImageLayout (VkCommandBuffer commandBuffer, VkDevice device, VkQueue graphicsQueue, VkCommandPool commandPool, VkImage image, VkFormat format, VkImageLayout oldLayout, VkImageLayout newLayout, uint32_t layerCount=1)
	Records an image layout transition barrier into an existing command buffer.
static bool	hasStencilComponent (VkFormat format)
	Checks whether a Vulkan format contains a stencil component.
static void	copyBufferToImage (VkDevice device, VkCommandPool commandPool, VkQueue graphicsQueue, VkBuffer buffer, VkImage image, uint32_t width, uint32_t height)
	Copies a buffer into the first layer and mip level of a 2D image.
static VkImageView	createImageView (VkDevice device, VkImage image, VkFormat format, VkImageAspectFlags aspectFlags)
	Creates a 2D image view over one mip level and one array layer.
static VkDescriptorBufferInfo	fullBufferInfo (VkBuffer buffer)
	Creates descriptor buffer info for a whole buffer binding.
static VkResult	allocateDescriptorSets (VkDevice device, const VkDescriptorSetAllocateInfo pAllocateInfo, VkDescriptorSet pDescriptorSets, const std::string &name)
	Allocates descriptor sets and assigns a debug name to the first returned set.
static VkResult	createSemaphore (VkDevice device, const VkSemaphoreCreateInfo pCreateInfo, const VkAllocationCallbacks pAllocator, VkSemaphore *pSemaphore, const std::string &name)
	Creates a semaphore and assigns a debug name.
static VkResult	allocateCommandBuffers (VkDevice device, const VkCommandBufferAllocateInfo pAllocateInfo, VkCommandBuffer pCommandBuffers, const std::string &name)
	Allocates command buffers and assigns a debug name to the first returned command buffer.
static VkResult	createDescriptorSetLayout (VkDevice device, const VkDescriptorSetLayoutCreateInfo pCreateInfo, const VkAllocationCallbacks pAllocator, VkDescriptorSetLayout *pSetLayout, const std::string &name)
	Creates a descriptor set layout and assigns a debug name.
static VkResult	createPipelineLayout (VkDevice device, const VkPipelineLayoutCreateInfo pCreateInfo, const VkAllocationCallbacks pAllocator, VkPipelineLayout *pPipelineLayout, const std::string &name)
	Creates a pipeline layout and assigns a debug name.
static void	createFence (VkDevice device, const VkFenceCreateInfo pCreateInfo, const VkAllocationCallbacks pAllocator, VkFence *pFence, const std::string &name)
	Creates a fence and assigns a debug name.
static VkResult	createDescriptorPool (VkDevice device, const VkDescriptorPoolCreateInfo pCreateInfo, const VkAllocationCallbacks pAllocator, VkDescriptorPool *pDescriptorPool, const std::string &name)
	Creates a descriptor pool and assigns a debug name.
static void	beginLabel (VkCommandBuffer, const char , const float )
	Release-build no-op for beginning a Vulkan debug label region.
static void	endLabel (VkCommandBuffer)
	Release-build no-op for ending a Vulkan debug label region.
template<typename VulkanObjectType>
static void	setObjectName (VkDevice device, VulkanObjectType objectHandle, const std::string &name)
	Release-build no-op for assigning a Vulkan object debug name.
template<typename VulkanObjectType>
static std::string	getDebugName (VulkanObjectType objectHandle)
	Release-build no-op for retrieving a Vulkan object debug name.

Static Private Member Functions
static std::string	getName (const std::string &name, const std::string &suffix)
	Appends an object-type suffix to a debug name.

Static Private Attributes
static VulkanFunctions	s_functions
static DynamicFunctionInitState	s_functionInitializationState
static std::mutex	s_mutex

Detailed Description

Static helpers for common Vulkan allocation, copy, descriptor, and debug operations.

The helper does not own Vulkan objects unless a function explicitly creates an object and returns it through an output parameter. Destroy buffers, images, image views, descriptor pools, descriptor set layouts, pipeline layouts, fences, semaphores, and command pools with the matching Vulkan destroy call.

Definition at line 93 of file VulkanHelper.h.

Member Function Documentation

◆ align()

VkDeviceSize VulkanHelper::align	(	VkDeviceSize	value,
		VkDeviceSize	alignment )

static

Rounds a size up to the next multiple of an alignment.

Parameters

value	Value to align in bytes.
alignment	Alignment in bytes. Must be a non-zero power of two.

Returns: value rounded up to alignment, or 0 when value is 0.

◆ allocateCommandBuffers()

VkResult VulkanHelper::allocateCommandBuffers	(	VkDevice	device,
		const VkCommandBufferAllocateInfo *	pAllocateInfo,
		VkCommandBuffer *	pCommandBuffers,
		const std::string &	name )

static

Allocates command buffers and assigns a debug name to the first returned command buffer.

Parameters

device	Logical device that owns the command pool referenced by `pAllocateInfo`.
pAllocateInfo	Vulkan command buffer allocation info.
pCommandBuffers	Output command buffer array.
name	Base debug name. The helper appends a command-buffer suffix.

Returns: VK_SUCCESS when allocation succeeds.

Exceptions

std::runtime_error when vkAllocateCommandBuffers fails.

◆ allocateDescriptorSets()

VkResult VulkanHelper::allocateDescriptorSets	(	VkDevice	device,
		const VkDescriptorSetAllocateInfo *	pAllocateInfo,
		VkDescriptorSet *	pDescriptorSets,
		const std::string &	name )

static

Allocates descriptor sets and assigns a debug name to the first returned set.

Parameters

device	Logical device that owns the descriptor pool referenced by `pAllocateInfo`.
pAllocateInfo	Vulkan allocation info.
pDescriptorSets	Output descriptor set array.
name	Base debug name. The helper appends a descriptor-set suffix.

Returns: Result from vkAllocateDescriptorSets.

◆ beginLabel()

void VulkanHelper::beginLabel	(	VkCommandBuffer	,
		const char *	,
		const float *	)

inlinestatic

Release-build no-op for beginning a Vulkan debug label region.

Definition at line 582 of file VulkanHelper.h.

◆ beginSingleTimeCommands()

VkCommandBuffer VulkanHelper::beginSingleTimeCommands	(	VkDevice	device,
		VkCommandPool	commandPool )

static

Allocates and begins a primary command buffer for one-time submission.

Parameters

device	Logical device that owns `commandPool`.
commandPool	Command pool used to allocate the command buffer.

Returns: Begun command buffer with VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT.

◆ cleanupBuffer()

void VulkanHelper::cleanupBuffer	(	VkDevice	device,
		VkBuffer	buffer,
		VkDeviceMemory	bufferMemory )

static

Destroys a buffer and frees its memory when the handles are non-null.

Parameters

device	Logical device that owns the buffer and memory.
buffer	Buffer handle to destroy.
bufferMemory	Device memory handle to free.

◆ copyBuffer()

void VulkanHelper::copyBuffer	(	VkDevice	device,
		VkCommandPool	commandPool,
		VkQueue	graphicsQueue,
		VkBuffer	sourceBuffer,
		VkBuffer	destinationBuffer,
		VkDeviceSize	size )

static

Copies bytes from one buffer to another and waits for the queue to become idle.

Parameters

device	Logical device that owns the command pool.
commandPool	Command pool used to allocate a one-time primary command buffer.
graphicsQueue	Queue that executes the copy command.
sourceBuffer	Source buffer. It must support VK_BUFFER_USAGE_TRANSFER_SRC_BIT.
destinationBuffer	Destination buffer. It must support VK_BUFFER_USAGE_TRANSFER_DST_BIT.
size	Number of bytes to copy from offset 0 to offset 0.

◆ copyBufferMultiple()

void VulkanHelper::copyBufferMultiple	(	VkDevice	device,
		VkCommandPool	commandPool,
		VkQueue	graphicsQueue,
		const std::vector< BufferCopyObject > &	bufferCopyObjects )

static

Copies several buffer regions in one command buffer and waits for the queue to become idle.

Parameters

device	Logical device that owns the command pool.
commandPool	Command pool used to allocate a one-time primary command buffer.
graphicsQueue	Queue that executes the copy commands.
bufferCopyObjects	Copy operations to record.

Warning: The current implementation uses each object's size and copies from offset 0 to offset 0.

◆ copyBufferToImage()

void VulkanHelper::copyBufferToImage	(	VkDevice	device,
		VkCommandPool	commandPool,
		VkQueue	graphicsQueue,
		VkBuffer	buffer,
		VkImage	image,
		uint32_t	width,
		uint32_t	height )

static

Copies a buffer into the first layer and mip level of a 2D image.

Parameters

device	Logical device that owns the command pool.
commandPool	Command pool used for the one-time copy command buffer.
graphicsQueue	Queue that executes the copy command and is waited idle before return.
buffer	Source buffer. It must support VK_BUFFER_USAGE_TRANSFER_SRC_BIT.
image	Destination image. It must be in VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL.
width	Copy width in pixels.
height	Copy height in pixels.

◆ createBuffer()

void VulkanHelper::createBuffer	(	VkDevice	device,
		VkPhysicalDevice	physicalDevice,
		VkDeviceSize	size,
		VkBufferUsageFlags	usage,
		VkMemoryPropertyFlags	properties,
		VkBuffer &	buffer,
		VkDeviceMemory &	bufferMemory )

static

Creates a Vulkan buffer, allocates memory for it, and binds the memory at offset 0.

Parameters

device	Logical device that owns the buffer and memory.
physicalDevice	Physical device used to select the memory type.
size	Buffer size in bytes.
usage	Vulkan buffer usage flags.
properties	Required memory property flags.
buffer	Output buffer handle.
bufferMemory	Output device memory handle bound to `buffer`.

Exceptions

std::runtime_error when buffer creation, memory type selection, or memory allocation fails.

◆ createDescriptorPool()

VkResult VulkanHelper::createDescriptorPool	(	VkDevice	device,
		const VkDescriptorPoolCreateInfo *	pCreateInfo,
		const VkAllocationCallbacks *	pAllocator,
		VkDescriptorPool *	pDescriptorPool,
		const std::string &	name )

static

Creates a descriptor pool and assigns a debug name.

Parameters

device	Logical device that owns the pool.
pCreateInfo	Vulkan descriptor pool create info.
pAllocator	Optional Vulkan allocation callbacks.
pDescriptorPool	Output descriptor pool handle.
name	Base debug name. The helper appends a descriptor-pool suffix.

Returns: Result from vkCreateDescriptorPool.

◆ createDescriptorSetLayout()

VkResult VulkanHelper::createDescriptorSetLayout	(	VkDevice	device,
		const VkDescriptorSetLayoutCreateInfo *	pCreateInfo,
		const VkAllocationCallbacks *	pAllocator,
		VkDescriptorSetLayout *	pSetLayout,
		const std::string &	name )

static

Creates a descriptor set layout and assigns a debug name.

Parameters

device	Logical device that owns the layout.
pCreateInfo	Vulkan descriptor set layout create info.
pAllocator	Optional Vulkan allocation callbacks.
pSetLayout	Output descriptor set layout handle.
name	Base debug name. The helper appends a descriptor-set-layout suffix.

Returns: VK_SUCCESS when creation succeeds.

Exceptions

std::runtime_error when vkCreateDescriptorSetLayout fails.

◆ createFence()

void VulkanHelper::createFence	(	VkDevice	device,
		const VkFenceCreateInfo *	pCreateInfo,
		const VkAllocationCallbacks *	pAllocator,
		VkFence *	pFence,
		const std::string &	name )

static

Creates a fence and assigns a debug name.

Parameters

device	Logical device that owns the fence.
pCreateInfo	Vulkan fence create info.
pAllocator	Optional Vulkan allocation callbacks.
pFence	Output fence handle.
name	Base debug name. The helper appends a fence suffix.

Exceptions

std::runtime_error when vkCreateFence fails.

◆ createImage()

void VulkanHelper::createImage	(	VkDevice	device,
		VkPhysicalDevice	physicalDevice,
		uint32_t	width,
		uint32_t	height,
		VkFormat	format,
		VkImageTiling	tiling,
		VkImageUsageFlags	usage,
		VkMemoryPropertyFlags	properties,
		VkImage &	image,
		VkDeviceMemory &	imageMemory )

static

Creates a 2D image, allocates memory for it, and binds the memory at offset 0.

Parameters

device	Logical device that owns the image and memory.
physicalDevice	Physical device used to select the memory type.
width	Image width in pixels.
height	Image height in pixels.
format	Image format.
tiling	Image tiling mode.
usage	Vulkan image usage flags.
properties	Required memory property flags.
image	Output image handle.
imageMemory	Output device memory handle bound to `image`.

Exceptions

std::runtime_error when image creation, memory type selection, or memory allocation fails.

◆ createImageView()

VkImageView VulkanHelper::createImageView	(	VkDevice	device,
		VkImage	image,
		VkFormat	format,
		VkImageAspectFlags	aspectFlags )

static

Creates a 2D image view over one mip level and one array layer.

Parameters

device	Logical device that owns `image`.
image	Image handle to view. Must not be VK_NULL_HANDLE.
format	View format.
aspectFlags	Image aspect flags for the subresource range.

Returns: Created image view handle.

Exceptions

std::runtime_error when vkCreateImageView fails.

◆ createPipelineLayout()

VkResult VulkanHelper::createPipelineLayout	(	VkDevice	device,
		const VkPipelineLayoutCreateInfo *	pCreateInfo,
		const VkAllocationCallbacks *	pAllocator,
		VkPipelineLayout *	pPipelineLayout,
		const std::string &	name )

static

Creates a pipeline layout and assigns a debug name.

Parameters

device	Logical device that owns the layout.
pCreateInfo	Vulkan pipeline layout create info. Must not be null.
pAllocator	Optional Vulkan allocation callbacks.
pPipelineLayout	Output pipeline layout handle.
name	Base debug name. The helper appends a pipeline-layout suffix.

Returns: VK_SUCCESS when creation succeeds.

Exceptions

std::runtime_error when vkCreatePipelineLayout fails.

◆ createSemaphore()

VkResult VulkanHelper::createSemaphore	(	VkDevice	device,
		const VkSemaphoreCreateInfo *	pCreateInfo,
		const VkAllocationCallbacks *	pAllocator,
		VkSemaphore *	pSemaphore,
		const std::string &	name )

static

Creates a semaphore and assigns a debug name.

Parameters

device	Logical device that owns the semaphore.
pCreateInfo	Vulkan semaphore create info. Must not be null.
pAllocator	Optional Vulkan allocation callbacks.
pSemaphore	Output semaphore handle.
name	Base debug name. The helper appends a semaphore suffix.

Returns: VK_SUCCESS when the semaphore was created.

Exceptions

std::runtime_error when vkCreateSemaphore fails.

◆ endLabel()

void VulkanHelper::endLabel ( VkCommandBuffer )

inlinestatic

Release-build no-op for ending a Vulkan debug label region.

Definition at line 587 of file VulkanHelper.h.

◆ endSingleTimeCommands()

void VulkanHelper::endSingleTimeCommands	(	VkDevice	device,
		VkQueue	graphicsQueue,
		VkCommandPool	commandPool,
		VkCommandBuffer	commandBuffer )

static

Ends, submits, waits for, and frees a one-time command buffer.

Parameters

device	Logical device that owns `commandPool`.
graphicsQueue	Queue that executes the command buffer.
commandPool	Command pool used to free the command buffer.
commandBuffer	Command buffer returned by beginSingleTimeCommands().

◆ findMemoryType()

uint32_t VulkanHelper::findMemoryType	(	VkPhysicalDevice	physicalDevice,
		uint32_t	typeFilter,
		VkMemoryPropertyFlags	properties )

static

Finds a memory type index that satisfies a bitmask and required properties.

Parameters

physicalDevice	Physical device whose memory properties are queried.
typeFilter	Memory type bitmask from VkMemoryRequirements::memoryTypeBits.
properties	Required memory property flags.

Returns: Matching memory type index.

Exceptions

std::runtime_error when no supported memory type matches.

◆ findSuitableMemoryType()

bool VulkanHelper::findSuitableMemoryType	(	VkPhysicalDevice	physicalDevice,
		VkMemoryRequirements2	requirements,
		VkMemoryPropertyFlags	properties,
		uint32_t &	out_typeIndex )

static

Finds a memory type index without throwing on failure.

Parameters

physicalDevice	Physical device whose memory properties are queried.
requirements	Memory requirements containing the supported memory type bitmask.
properties	Required memory property flags.
out_typeIndex	Receives the matching memory type index when the function returns true.

Returns: true when a memory type matches requirements and properties.

◆ fullBufferInfo()

VkDescriptorBufferInfo VulkanHelper::fullBufferInfo ( VkBuffer buffer )

static

Creates descriptor buffer info for a whole buffer binding.

Parameters

buffer Buffer handle to describe.

Returns: VkDescriptorBufferInfo with offset 0 and range VK_WHOLE_SIZE.

◆ getDebugName()

template<typename VulkanObjectType>

std::string VulkanHelper::getDebugName ( VulkanObjectType objectHandle )

inlinestatic

Release-build no-op for retrieving a Vulkan object debug name.

Parameters

objectHandle Unused Vulkan object handle.

Returns: Empty string.

Definition at line 661 of file VulkanHelper.h.

◆ getFunctions()

const VulkanFunctions & VulkanHelper::getFunctions ( )

static

Returns the loaded Vulkan extension function table.

Returns: Reference to the engine-owned function table.

Exceptions

std::runtime_error when no Vulkan helper function initialization has run.

◆ getName()

std::string VulkanHelper::getName	(	const std::string &	name,
		const std::string &	suffix )

staticprivate

Appends an object-type suffix to a debug name.

Parameters

name	Base debug name.
suffix	Suffix added to `name`.

Returns: Combined debug name.

◆ hasStencilComponent()

bool VulkanHelper::hasStencilComponent ( VkFormat format )

static

Checks whether a Vulkan format contains a stencil component.

Parameters

format Format to inspect.

Returns: true for VK_FORMAT_D32_SFLOAT_S8_UINT and VK_FORMAT_D24_UNORM_S8_UINT.

◆ initializeDebugFunctions()

void VulkanHelper::initializeDebugFunctions ( VkInstance instance )

static

Loads debug utils extension functions from an instance.

Parameters

instance Vulkan instance used with vkGetInstanceProcAddr.

Exceptions

std::runtime_error in debug builds when a required debug utils entry point is unavailable.

◆ initializeFunctions()

void VulkanHelper::initializeFunctions	(	VkInstance	instance,
		VkDevice	device )

static

Loads all Vulkan extension functions used by the engine.

Parameters

instance	Vulkan instance used with vkGetInstanceProcAddr.
device	Vulkan device used with vkGetDeviceProcAddr.

Exceptions

std::runtime_error when a required instance or device entry point is unavailable.

◆ isValid()

bool VulkanHelper::isValid ( void * object )

static

Checks whether a Vulkan dispatchable handle value is non-null.

Parameters

object Handle value cast to void*.

Returns: true when object is not VK_NULL_HANDLE.

◆ loadVkDeviceFunction()

template<typename T>

void VulkanHelper::loadVkDeviceFunction	(	VkDevice	device,
		const std::string &	name,
		T &	functionPointer )

inlinestatic

Loads one Vulkan device-level function pointer.

Template Parameters

T	Function pointer type to assign.

Parameters

device	Vulkan device used with vkGetDeviceProcAddr.
name	Exact Vulkan entry point name.
functionPointer	Output function pointer.

Exceptions

std::runtime_error when the entry point is unavailable.

Definition at line 149 of file VulkanHelper.h.

◆ loadVkFunction()

template<typename T>

void VulkanHelper::loadVkFunction	(	VkInstance	instance,
		const std::string &	name,
		T &	functionPointer )

inlinestatic

Loads one Vulkan instance-level function pointer.

Template Parameters

T	Function pointer type to assign.

Parameters

instance	Vulkan instance used with vkGetInstanceProcAddr.
name	Exact Vulkan entry point name.
functionPointer	Output function pointer.

Exceptions

std::runtime_error when the entry point is unavailable.

Definition at line 127 of file VulkanHelper.h.

◆ recordBufferCopyMultiple()

void VulkanHelper::recordBufferCopyMultiple	(	Engine::Core::ApplicationContext *	context,
		VkCommandBuffer	commandBuffer,
		const std::vector< BufferCopyObject > &	bufferCopyObjects )

static

Records several buffer copy commands into an existing command buffer.

Parameters

context	Application context used to inspect graphics and transfer queue family indices.
commandBuffer	Command buffer already in the recording state.
bufferCopyObjects	Copy operations to record.

Warning: The current implementation uses each object's size and copies from offset 0 to offset 0.

◆ setObjectName()

template<typename VulkanObjectType>

void VulkanHelper::setObjectName	(	VkDevice	device,
		VulkanObjectType	objectHandle,
		const std::string &	name )

inlinestatic

Release-build no-op for assigning a Vulkan object debug name.

Parameters

device	Unused logical device.
objectHandle	Unused Vulkan object handle.
name	Unused debug name.

Definition at line 651 of file VulkanHelper.h.

◆ strIsValid()

std::string VulkanHelper::strIsValid ( void * object )

static

Returns a checkmark or cross string for a Vulkan dispatchable handle value.

Parameters

object Handle value cast to void*.

Returns: CHECK_STR when object is valid, otherwise CROSS_STR.

◆ transitionImageLayout()

void VulkanHelper::transitionImageLayout	(	VkCommandBuffer	commandBuffer,
		VkDevice	device,
		VkQueue	graphicsQueue,
		VkCommandPool	commandPool,
		VkImage	image,
		VkFormat	format,
		VkImageLayout	oldLayout,
		VkImageLayout	newLayout,
		uint32_t	layerCount = 1 )

static

Records an image layout transition barrier into an existing command buffer.

Parameters

commandBuffer	Command buffer already in the recording state.
device	Reserved; the current implementation does not access it.
graphicsQueue	Reserved; the current implementation does not submit work.
commandPool	Reserved; the current implementation does not allocate command buffers.
image	Image to transition.
format	Image format. Stencil formats add VK_IMAGE_ASPECT_STENCIL_BIT for depth-stencil layouts.
oldLayout	Source image layout.
newLayout	Destination image layout.
layerCount	Number of array layers in the barrier subresource range.

Exceptions

std::invalid_argument when the old/new layout pair is unsupported.

◆ uploadDataToExistingBuffer()

void VulkanHelper::uploadDataToExistingBuffer	(	VkDevice	device,
		VkPhysicalDevice	physicalDevice,
		VkCommandPool	commandPool,
		VkQueue	queue,
		VkDeviceSize	size,
		const void *	dataPtr,
		VkBuffer	targetBuffer )

static

Uploads CPU memory into an existing buffer through a temporary staging buffer.

Parameters

device	Logical device that owns the buffers.
physicalDevice	Physical device used to allocate the staging buffer memory.
commandPool	Command pool used for the one-time copy command buffer.
queue	Queue that executes the copy command and is waited idle before return.
size	Number of bytes to upload.
dataPtr	Source CPU memory. The pointer must reference at least `size` bytes.
targetBuffer	Destination buffer. It must support VK_BUFFER_USAGE_TRANSFER_DST_BIT.

Exceptions

std::runtime_error when staging buffer creation or memory allocation fails.

Member Data Documentation

◆ s_functionInitializationState

DynamicFunctionInitState VulkanHelper::s_functionInitializationState

staticprivate

Definition at line 669 of file VulkanHelper.h.

◆ s_functions

VulkanFunctions VulkanHelper::s_functions

staticprivate

Definition at line 668 of file VulkanHelper.h.

◆ s_mutex

std::mutex VulkanHelper::s_mutex

staticprivate

Definition at line 670 of file VulkanHelper.h.

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

/workspace/magerbeton/gl3-vulkan/code/Engine/include/Engine/Core/VulkanHelper.h

Static Public Member Functions

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

◆ align()

◆ allocateCommandBuffers()

◆ allocateDescriptorSets()

◆ beginLabel()

◆ beginSingleTimeCommands()

◆ cleanupBuffer()

◆ copyBuffer()

◆ copyBufferMultiple()

◆ copyBufferToImage()

◆ createBuffer()

◆ createDescriptorPool()

◆ createDescriptorSetLayout()

◆ createFence()

◆ createImage()

◆ createImageView()

◆ createPipelineLayout()

◆ createSemaphore()

◆ endLabel()

◆ endSingleTimeCommands()

◆ findMemoryType()

◆ findSuitableMemoryType()

◆ fullBufferInfo()

◆ getDebugName()

◆ getFunctions()

◆ getName()

◆ hasStencilComponent()

◆ initializeDebugFunctions()

◆ initializeFunctions()

◆ isValid()

◆ loadVkDeviceFunction()

◆ loadVkFunction()

◆ recordBufferCopyMultiple()

◆ setObjectName()

◆ strIsValid()

◆ transitionImageLayout()

◆ uploadDataToExistingBuffer()

Member Data Documentation

◆ s_functionInitializationState

◆ s_functions

◆ s_mutex