vks::tools Namespace Reference

Functions
std::string	errorString (VkResult errorCode)
	Returns an error code as a string.
std::string	physicalDeviceTypeString (VkPhysicalDeviceType type)
	Returns the device type as a string.
VkBool32	getSupportedDepthFormat (VkPhysicalDevice physicalDevice, VkFormat *depthFormat)
VkBool32	formatIsFilterable (VkPhysicalDevice physicalDevice, VkFormat format, VkImageTiling tiling)
void	setImageLayout (VkCommandBuffer cmdbuffer, VkImage image, VkImageLayout oldImageLayout, VkImageLayout newImageLayout, VkImageSubresourceRange subresourceRange, VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask)
void	setImageLayout (VkCommandBuffer cmdbuffer, VkImage image, VkImageAspectFlags aspectMask, VkImageLayout oldImageLayout, VkImageLayout newImageLayout, VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask)
void	insertImageMemoryBarrier (VkCommandBuffer cmdbuffer, VkImage image, VkAccessFlags srcAccessMask, VkAccessFlags dstAccessMask, VkImageLayout oldImageLayout, VkImageLayout newImageLayout, VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask, VkImageSubresourceRange subresourceRange)
	Insert an image memory barrier into the command buffer.
void	exitFatal (const std::string &message, int32_t exitCode)
void	exitFatal (const std::string &message, VkResult resultCode)
VkShaderModule	loadShaderModule (const std::string fileName, VkDevice device)
VkShaderModule	loadShader (const char *fileName, VkDevice device)
bool	fileExists (const std::string &filename)
	Checks if a file exists.
uint32_t	alignedSize (uint32_t value, uint32_t alignment)
VkShaderModule	loadShaderModule (const std::string &fileName, const std::map< std::string, std::string > &macros, const std::string &MD5Encode, VkDevice device)
VkShaderModule	loadShader (const std::string &fileName, const std::map< std::string, std::string > &macros, const std::string &MD5Encode, VkDevice device)

Variables
bool	errorModeSilent = false
	Disable message boxes on fatal errors.

Function Documentation

alignedSize()

uint32_t vks::tools::alignedSize	(	uint32_t	value,
		uint32_t	alignment )

Definition at line 382 of file VulkanTools.cpp.

errorString()

std::string vks::tools::errorString

(

VkResult

errorCode

)

Returns an error code as a string.

Definition at line 17 of file VulkanTools.cpp.

Here is the caller graph for this function:

exitFatal() [1/2]

void vks::tools::exitFatal	(	const std::string &	message,
		int32_t	exitCode )

Definition at line 281 of file VulkanTools.cpp.

Here is the caller graph for this function:

exitFatal() [2/2]

void vks::tools::exitFatal	(	const std::string &	message,
		VkResult	resultCode )

Definition at line 297 of file VulkanTools.cpp.

Here is the call graph for this function:

fileExists()

bool vks::tools::fileExists

(

const std::string &

filename

)

Checks if a file exists.

Definition at line 376 of file VulkanTools.cpp.

Here is the caller graph for this function:

formatIsFilterable()

VkBool32 vks::tools::formatIsFilterable	(	VkPhysicalDevice	physicalDevice,
		VkFormat	format,
		VkImageTiling	tiling )

Definition at line 94 of file VulkanTools.cpp.

getSupportedDepthFormat()

VkBool32 vks::tools::getSupportedDepthFormat	(	VkPhysicalDevice	physicalDevice,
		VkFormat *	depthFormat )

Definition at line 66 of file VulkanTools.cpp.

Here is the caller graph for this function:

insertImageMemoryBarrier()

void vks::tools::insertImageMemoryBarrier	(	VkCommandBuffer	cmdbuffer,
		VkImage	image,
		VkAccessFlags	srcAccessMask,
		VkAccessFlags	dstAccessMask,
		VkImageLayout	oldImageLayout,
		VkImageLayout	newImageLayout,
		VkPipelineStageFlags	srcStageMask,
		VkPipelineStageFlags	dstStageMask,
		VkImageSubresourceRange	subresourceRange )

Insert an image memory barrier into the command buffer.

Definition at line 252 of file VulkanTools.cpp.

Here is the call graph for this function:

loadShader() [1/2]

VkShaderModule vks::tools::loadShader	(	const char *	fileName,
		VkDevice	device )

Definition at line 342 of file VulkanTools.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

loadShader() [2/2]

VkShaderModule vks::tools::loadShader	(	const std::string &	fileName,
		const std::map< std::string, std::string > &	macros,
		const std::string &	MD5Encode,
		VkDevice	device )

loadShaderModule() [1/2]

VkShaderModule vks::tools::loadShaderModule	(	const std::string &	fileName,
		const std::map< std::string, std::string > &	macros,
		const std::string &	MD5Encode,
		VkDevice	device )

loadShaderModule() [2/2]

VkShaderModule vks::tools::loadShaderModule	(	const std::string	fileName,
		VkDevice	device )

Definition at line 303 of file VulkanTools.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

physicalDeviceTypeString()

std::string vks::tools::physicalDeviceTypeString

(

VkPhysicalDeviceType

type

)

Returns the device type as a string.

Definition at line 51 of file VulkanTools.cpp.

setImageLayout() [1/2]

void vks::tools::setImageLayout	(	VkCommandBuffer	cmdbuffer,
		VkImage	image,
		VkImageAspectFlags	aspectMask,
		VkImageLayout	oldImageLayout,
		VkImageLayout	newImageLayout,
		VkPipelineStageFlags	srcStageMask,
		VkPipelineStageFlags	dstStageMask )

Definition at line 235 of file VulkanTools.cpp.

Here is the call graph for this function:

setImageLayout() [2/2]

void vks::tools::setImageLayout	(	VkCommandBuffer	cmdbuffer,
		VkImage	image,
		VkImageLayout	oldImageLayout,
		VkImageLayout	newImageLayout,
		VkImageSubresourceRange	subresourceRange,
		VkPipelineStageFlags	srcStageMask,
		VkPipelineStageFlags	dstStageMask )

Definition at line 112 of file VulkanTools.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

errorModeSilent

bool vks::tools::errorModeSilent = false

Disable message boxes on fatal errors.

Definition at line 15 of file VulkanTools.cpp.