Debug marker functions naming

This commit is contained in:
saschawillems 2016-05-28 12:00:43 +02:00
parent 286c801230
commit 4dabec717b
2 changed files with 116 additions and 138 deletions

View file

@ -17,6 +17,9 @@
#ifdef __ANDROID__
#include "vulkanandroid.h"
#endif
#define GLM_FORCE_RADIANS
#define GLM_FORCE_DEPTH_ZERO_TO_ONE
#include <glm/glm.hpp>
namespace vkDebug
{
@ -44,67 +47,53 @@ namespace vkDebug
// Clear debug callback
void freeDebugCallback(VkInstance instance);
// Functions for the VK_EXT_debug_report extensions
namespace debugReport
// Setup and functions for the VK_EXT_debug_marker_extension
// Extension spec can be found at https://github.com/KhronosGroup/Vulkan-Docs/blob/1.0-VK_EXT_debug_marker/doc/specs/vulkan/appendices/VK_EXT_debug_marker.txt
// Note that the extension will only be present if run from an offline debugging application
// The actual check for extension presence and enabling it on the device is done in the example base class
// See VulkanExampleBase::createInstance and VulkanExampleBase::createDevice (base/vulkanexamplebase.cpp)
namespace DebugMarker
{
// Set up the debug marker function pointers
void setupDebugMarkers(VkDevice device);
// Set to true if function pointer for the debug marker are available
extern bool active;
// Functions for naming different Vulkan object types
// General
// Get function pointers for the debug report extensions from the device
void setup(VkDevice device);
// Sets the debug name of an object
// All Objects in Vulkan are represented by their 64-bit handles which are passed into this function
// along with the object type
void setObjectName(VkDevice device, uint64_t object, VkDebugReportObjectTypeEXT objectType, const char *name);
// Dedicated object type
void setCommandBufferName(VkDevice device, VkCommandBuffer cmdBuffer, const char *name);
void setQueueName(VkDevice device, VkQueue queue, const char *name);
void setImageName(VkDevice device, VkImage image, const char *name);
void setSamplerName(VkDevice device, VkSampler sampler, const char *name);
void setBufferName(VkDevice device, VkBuffer buffer, const char *name);
void setDeviceMemoryName(VkDevice device, VkDeviceMemory memory, const char *name);
void setShaderModuleName(VkDevice device, VkShaderModule shaderModule, const char *name);
void setPipelineName(VkDevice device, VkPipeline pipeline, const char *name);
void setPipelineLayoutName(VkDevice device, VkPipelineLayout pipelineLayout, const char *name);
void setRenderPassName(VkDevice device, VkRenderPass renderPass, const char *name);
void setFramebufferName(VkDevice device, VkFramebuffer framebuffer, const char *name);
void setDescriptorSetLayoutName(VkDevice device, VkDescriptorSetLayout descriptorSetLayout, const char *name);
void setDescriptorSetName(VkDevice device, VkDescriptorSet descriptorSet, const char *name);
void setSemaphoreName(VkDevice device, VkSemaphore semaphore, const char *name);
void setFenceName(VkDevice device, VkFence fence, const char *name);
void setEventName(VkDevice device, VkEvent _event, const char *name);
/*
// Set the tag for an object
void setObjectTag(VkDevice device, uint64_t object, VkDebugReportObjectTypeEXT objectType, uint64_t name, size_t tagSize, const void* tag);
OBJECT_TYPE(DESCRIPTOR_POOL, VkDescriptorPool);
// Start a new debug marker region
void beginRegion(VkCommandBuffer cmdbuffer, const char* pMarkerName, glm::vec4 color);
OBJECT_TYPE(COMMAND_POOL, VkCommandPool);
// Insert a new debug marker into the command buffer
void insert(VkCommandBuffer cmdbuffer, std::string markerName, glm::vec4 color);
OBJECT_TYPE(QUERY_POOL, VkQueryPool);
// End the current debug marker region
void endRegion(VkCommandBuffer cmdBuffer);
OBJECT_TYPE(BUFFER_VIEW, VkBufferView);
OBJECT_TYPE(IMAGE_VIEW, VkImageView);
OBJECT_TYPE(PIPELINE_CACHE, VkPipelineCache);
*/
// Object specific naming functions
void setCommandBufferName(VkDevice device, VkCommandBuffer cmdBuffer, const char * name);
void setQueueName(VkDevice device, VkQueue queue, const char * name);
void setImageName(VkDevice device, VkImage image, const char * name);
void setSamplerName(VkDevice device, VkSampler sampler, const char * name);
void setBufferName(VkDevice device, VkBuffer buffer, const char * name);
void setDeviceMemoryName(VkDevice device, VkDeviceMemory memory, const char * name);
void setShaderModuleName(VkDevice device, VkShaderModule shaderModule, const char * name);
void setPipelineName(VkDevice device, VkPipeline pipeline, const char * name);
void setPipelineLayoutName(VkDevice device, VkPipelineLayout pipelineLayout, const char * name);
void setRenderPassName(VkDevice device, VkRenderPass renderPass, const char * name);
void setFramebufferName(VkDevice device, VkFramebuffer framebuffer, const char * name);
void setDescriptorSetLayoutName(VkDevice device, VkDescriptorSetLayout descriptorSetLayout, const char * name);
void setDescriptorSetName(VkDevice device, VkDescriptorSet descriptorSet, const char * name);
void setSemaphoreName(VkDevice device, VkSemaphore semaphore, const char * name);
void setFenceName(VkDevice device, VkFence fence, const char * name);
void setEventName(VkDevice device, VkEvent _event, const char * name);
};
// insert a debug label into the command buffer, with or
// without a color
void insertDebugMarker(
VkCommandBuffer cmdbuffer,
const char* pMarkerName,
float color[4]);
void insertDebugMarker(
VkCommandBuffer cmdbuffer,
const char* pMarkerName);
// Helper class for pushing and popping a debug region around some section of code.
struct DebugMarkerRegion
{
DebugMarkerRegion(VkCommandBuffer cmdbuffer,
const char* pMarkerName,
float color[4]);
DebugMarkerRegion(VkCommandBuffer cmdbuffer,
const char* pMarkerName);
~DebugMarkerRegion();
VkCommandBuffer cmd;
};
}
}