kraken_engine/kraken
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add GPU debug labels for render passes

Browse Source
This commit is contained in:
Kearwood Gilbert
2025-04-09 22:48:38 -07:00
parent 4ccdaea970
commit 698f890500
8 changed files with 60 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
kraken/KRDevice.cpp
View File

@@ -587,6 +587,11 @@ void KRDevice::setDebugLabel(const VkCommandBuffer& commandBuffer, const char* d
setDebugLabel((uint64_t)commandBuffer, VK_OBJECT_TYPE_COMMAND_BUFFER, debugLabel); setDebugLabel((uint64_t)commandBuffer, VK_OBJECT_TYPE_COMMAND_BUFFER, debugLabel);
} }
void KRDevice::setDebugLabel(const VkRenderPass& renderPass, const char* debugLabel)
{
setDebugLabel((uint64_t)renderPass, VK_OBJECT_TYPE_RENDER_PASS, debugLabel);
}
void KRDevice::setDebugLabel(const VkDevice& device, const char* debugLabel) void KRDevice::setDebugLabel(const VkDevice& device, const char* debugLabel)
{ {
setDebugLabel((uint64_t)device, VK_OBJECT_TYPE_DEVICE, debugLabel); setDebugLabel((uint64_t)device, VK_OBJECT_TYPE_DEVICE, debugLabel);

1
kraken/KRDevice.h
View File

@@ -56,6 +56,7 @@ public:
void setDebugLabel(const VkBuffer& buffer, const char* debugLabel); void setDebugLabel(const VkBuffer& buffer, const char* debugLabel);
void setDebugLabel(const VkQueue& queue, const char* debugLabel); void setDebugLabel(const VkQueue& queue, const char* debugLabel);
void setDebugLabel(const VkCommandBuffer& commandBuffer, const char* debugLabel); void setDebugLabel(const VkCommandBuffer& commandBuffer, const char* debugLabel);
void setDebugLabel(const VkRenderPass& renderPass, const char* debugLabel);
void setDebugLabel(const VkDevice& device, const char* debugLabel); void setDebugLabel(const VkDevice& device, const char* debugLabel);
#endif // KRENGINE_DEBUG_GPU_LABELS #endif // KRENGINE_DEBUG_GPU_LABELS

1
kraken/KRRenderGraph.cpp
View File

@@ -133,6 +133,7 @@ void KRRenderGraph::addRenderPass(KRDevice& device, const RenderPassInfo& info)
KRRenderPass *pass = new KRRenderPass(getContext()); KRRenderPass *pass = new KRRenderPass(getContext());
pass->create(device, info, renderPassInfo); pass->create(device, info, renderPassInfo);
m_renderPasses.push_back(pass); m_renderPasses.push_back(pass);
} }

4
kraken/KRRenderGraphBlackFrame.cpp
View File

@@ -63,6 +63,10 @@ KrResult KRRenderGraphBlackFrame::initialize(KRSurface &surface)
info.depthAttachment.loadOp = VK_ATTACHMENT_LOAD_OP_CLEAR; info.depthAttachment.loadOp = VK_ATTACHMENT_LOAD_OP_CLEAR;
info.finalPass = true; info.finalPass = true;
info.type = RenderPassType::RENDER_PASS_BLACK_FRAME; info.type = RenderPassType::RENDER_PASS_BLACK_FRAME;
#if KRENGINE_DEBUG_GPU_LABELS
strncpy(info.debugLabel, "Black Frame", KRENGINE_DEBUG_GPU_LABEL_MAX_LEN);
#endif
addRenderPass(*surface.getDevice(), info); addRenderPass(*surface.getDevice(), info);
return KR_SUCCESS; return KR_SUCCESS;

24
kraken/KRRenderGraphDeferred.cpp
View File

@@ -71,6 +71,9 @@ KrResult KRRenderGraphDeferred::initialize(KRSurface &surface)
info.finalPass = false; info.finalPass = false;
info.type = RenderPassType::RENDER_PASS_PRESTREAM; info.type = RenderPassType::RENDER_PASS_PRESTREAM;
#if KRENGINE_DEBUG_GPU_LABELS
strncpy(info.debugLabel, "PreStream", KRENGINE_DEBUG_GPU_LABEL_MAX_LEN);
#endif
addRenderPass(*surface.getDevice(), info); addRenderPass(*surface.getDevice(), info);
for (int shadow_index = 0; shadow_index < shadow_buffer_count; shadow_index++) { for (int shadow_index = 0; shadow_index < shadow_buffer_count; shadow_index++) {
@@ -80,6 +83,9 @@ KrResult KRRenderGraphDeferred::initialize(KRSurface &surface)
info.depthAttachment.clearVaue.depthStencil.depth = 1.0f; info.depthAttachment.clearVaue.depthStencil.depth = 1.0f;
info.depthAttachment.clearVaue.depthStencil.stencil = 0; info.depthAttachment.clearVaue.depthStencil.stencil = 0;
info.type = RenderPassType::RENDER_PASS_SHADOWMAP; info.type = RenderPassType::RENDER_PASS_SHADOWMAP;
#if KRENGINE_DEBUG_GPU_LABELS
snprintf(info.debugLabel, KRENGINE_DEBUG_GPU_LABEL_MAX_LEN, "Shadow Map %i", shadow_index);
#endif
addRenderPass(*surface.getDevice(), info); addRenderPass(*surface.getDevice(), info);
} }
@@ -100,6 +106,9 @@ KrResult KRRenderGraphDeferred::initialize(KRSurface &surface)
info.colorAttachments[0].loadOp = VK_ATTACHMENT_LOAD_OP_CLEAR; info.colorAttachments[0].loadOp = VK_ATTACHMENT_LOAD_OP_CLEAR;
info.colorAttachments[0].stencilLoadOp = VK_ATTACHMENT_LOAD_OP_DONT_CARE; info.colorAttachments[0].stencilLoadOp = VK_ATTACHMENT_LOAD_OP_DONT_CARE;
info.type = RenderPassType::RENDER_PASS_DEFERRED_GBUFFER; info.type = RenderPassType::RENDER_PASS_DEFERRED_GBUFFER;
#if KRENGINE_DEBUG_GPU_LABELS
strncpy(info.debugLabel, "Deferred GBuffer", KRENGINE_DEBUG_GPU_LABEL_MAX_LEN);
#endif
addRenderPass(*surface.getDevice(), info); addRenderPass(*surface.getDevice(), info);
// ----====---- Opaque Geometry, Deferred rendering Pass 2 ----====---- // ----====---- Opaque Geometry, Deferred rendering Pass 2 ----====----
@@ -115,12 +124,18 @@ KrResult KRRenderGraphDeferred::initialize(KRSurface &surface)
info.colorAttachments[1].loadOp = VK_ATTACHMENT_LOAD_OP_CLEAR; info.colorAttachments[1].loadOp = VK_ATTACHMENT_LOAD_OP_CLEAR;
info.colorAttachments[1].stencilLoadOp = VK_ATTACHMENT_LOAD_OP_DONT_CARE; info.colorAttachments[1].stencilLoadOp = VK_ATTACHMENT_LOAD_OP_DONT_CARE;
info.type = RenderPassType::RENDER_PASS_DEFERRED_LIGHTS; info.type = RenderPassType::RENDER_PASS_DEFERRED_LIGHTS;
#if KRENGINE_DEBUG_GPU_LABELS
strncpy(info.debugLabel, "Deferred Lights", KRENGINE_DEBUG_GPU_LABEL_MAX_LEN);
#endif
addRenderPass(*surface.getDevice(), info); addRenderPass(*surface.getDevice(), info);
// ----====---- Opaque Geometry, Deferred rendering Pass 3 ----====---- // ----====---- Opaque Geometry, Deferred rendering Pass 3 ----====----
info.colorAttachments[0].loadOp = VK_ATTACHMENT_LOAD_OP_CLEAR; info.colorAttachments[0].loadOp = VK_ATTACHMENT_LOAD_OP_CLEAR;
info.colorAttachments[1].loadOp = VK_ATTACHMENT_LOAD_OP_LOAD; info.colorAttachments[1].loadOp = VK_ATTACHMENT_LOAD_OP_LOAD;
info.type = RenderPassType::RENDER_PASS_DEFERRED_OPAQUE; info.type = RenderPassType::RENDER_PASS_DEFERRED_OPAQUE;
#if KRENGINE_DEBUG_GPU_LABELS
strncpy(info.debugLabel, "Deferred Opaque", KRENGINE_DEBUG_GPU_LABEL_MAX_LEN);
#endif
addRenderPass(*surface.getDevice(), info); addRenderPass(*surface.getDevice(), info);
info.colorAttachments[1] = {}; info.colorAttachments[1] = {};
@@ -141,13 +156,22 @@ KrResult KRRenderGraphDeferred::initialize(KRSurface &surface)
info.colorAttachments[0].stencilLoadOp = VK_ATTACHMENT_LOAD_OP_DONT_CARE; info.colorAttachments[0].stencilLoadOp = VK_ATTACHMENT_LOAD_OP_DONT_CARE;
info.type = RenderPassType::RENDER_PASS_FORWARD_TRANSPARENT; info.type = RenderPassType::RENDER_PASS_FORWARD_TRANSPARENT;
#if KRENGINE_DEBUG_GPU_LABELS
strncpy(info.debugLabel, "Forward Transparent", KRENGINE_DEBUG_GPU_LABEL_MAX_LEN);
#endif
addRenderPass(*surface.getDevice(), info); addRenderPass(*surface.getDevice(), info);
info.type = RenderPassType::RENDER_PASS_DEBUG_OVERLAYS; info.type = RenderPassType::RENDER_PASS_DEBUG_OVERLAYS;
#if KRENGINE_DEBUG_GPU_LABELS
strncpy(info.debugLabel, "Debug Overlays", KRENGINE_DEBUG_GPU_LABEL_MAX_LEN);
#endif
addRenderPass(*surface.getDevice(), info); addRenderPass(*surface.getDevice(), info);
info.finalPass = true; info.finalPass = true;
info.type = RenderPassType::RENDER_PASS_POST_COMPOSITE; info.type = RenderPassType::RENDER_PASS_POST_COMPOSITE;
#if KRENGINE_DEBUG_GPU_LABELS
strncpy(info.debugLabel, "Post Composite", KRENGINE_DEBUG_GPU_LABEL_MAX_LEN);
#endif
addRenderPass(*surface.getDevice(), info); addRenderPass(*surface.getDevice(), info);
return KR_SUCCESS; return KR_SUCCESS;

18
kraken/KRRenderGraphForward.cpp
View File

@@ -70,6 +70,9 @@ KrResult KRRenderGraphForward::initialize(KRSurface &surface)
info.finalPass = false; info.finalPass = false;
info.type = RenderPassType::RENDER_PASS_PRESTREAM; info.type = RenderPassType::RENDER_PASS_PRESTREAM;
#if KRENGINE_DEBUG_GPU_LABELS
strncpy(info.debugLabel, "PreStream", KRENGINE_DEBUG_GPU_LABEL_MAX_LEN);
#endif
addRenderPass(*surface.getDevice(), info); addRenderPass(*surface.getDevice(), info);
for (int shadow_index = 0; shadow_index < shadow_buffer_count; shadow_index++) { for (int shadow_index = 0; shadow_index < shadow_buffer_count; shadow_index++) {
@@ -79,6 +82,9 @@ KrResult KRRenderGraphForward::initialize(KRSurface &surface)
info.depthAttachment.clearVaue.depthStencil.depth = 1.0f; info.depthAttachment.clearVaue.depthStencil.depth = 1.0f;
info.depthAttachment.clearVaue.depthStencil.stencil = 0; info.depthAttachment.clearVaue.depthStencil.stencil = 0;
info.type = RenderPassType::RENDER_PASS_SHADOWMAP; info.type = RenderPassType::RENDER_PASS_SHADOWMAP;
#if KRENGINE_DEBUG_GPU_LABELS
snprintf(info.debugLabel, KRENGINE_DEBUG_GPU_LABEL_MAX_LEN, "Shadow Map %i", shadow_index);
#endif
addRenderPass(*surface.getDevice(), info); addRenderPass(*surface.getDevice(), info);
} }
@@ -98,6 +104,9 @@ KrResult KRRenderGraphForward::initialize(KRSurface &surface)
info.colorAttachments[0].stencilLoadOp = VK_ATTACHMENT_LOAD_OP_DONT_CARE; info.colorAttachments[0].stencilLoadOp = VK_ATTACHMENT_LOAD_OP_DONT_CARE;
info.type = RenderPassType::RENDER_PASS_FORWARD_OPAQUE; info.type = RenderPassType::RENDER_PASS_FORWARD_OPAQUE;
#if KRENGINE_DEBUG_GPU_LABELS
strncpy(info.debugLabel, "Forward Opaque", KRENGINE_DEBUG_GPU_LABEL_MAX_LEN);
#endif
addRenderPass(*surface.getDevice(), info); addRenderPass(*surface.getDevice(), info);
// ----====---- Transparent Geometry, Forward Rendering ----====---- // ----====---- Transparent Geometry, Forward Rendering ----====----
@@ -116,13 +125,22 @@ KrResult KRRenderGraphForward::initialize(KRSurface &surface)
info.colorAttachments[0].stencilLoadOp = VK_ATTACHMENT_LOAD_OP_DONT_CARE; info.colorAttachments[0].stencilLoadOp = VK_ATTACHMENT_LOAD_OP_DONT_CARE;
info.type = RenderPassType::RENDER_PASS_FORWARD_TRANSPARENT; info.type = RenderPassType::RENDER_PASS_FORWARD_TRANSPARENT;
#if KRENGINE_DEBUG_GPU_LABELS
strncpy(info.debugLabel, "Forward Transparent", KRENGINE_DEBUG_GPU_LABEL_MAX_LEN);
#endif
addRenderPass(*surface.getDevice(), info); addRenderPass(*surface.getDevice(), info);
info.type = RenderPassType::RENDER_PASS_DEBUG_OVERLAYS; info.type = RenderPassType::RENDER_PASS_DEBUG_OVERLAYS;
#if KRENGINE_DEBUG_GPU_LABELS
strncpy(info.debugLabel, "Debug Overlays", KRENGINE_DEBUG_GPU_LABEL_MAX_LEN);
#endif
addRenderPass(*surface.getDevice(), info); addRenderPass(*surface.getDevice(), info);
info.finalPass = true; info.finalPass = true;
info.type = RenderPassType::RENDER_PASS_POST_COMPOSITE; info.type = RenderPassType::RENDER_PASS_POST_COMPOSITE;
#if KRENGINE_DEBUG_GPU_LABELS
strncpy(info.debugLabel, "Post Composite", KRENGINE_DEBUG_GPU_LABEL_MAX_LEN);
#endif
addRenderPass(*surface.getDevice(), info); addRenderPass(*surface.getDevice(), info);
return KR_SUCCESS; return KR_SUCCESS;

4
kraken/KRRenderPass.cpp
View File

@@ -56,6 +56,10 @@ void KRRenderPass::create(KRDevice& device, const RenderPassInfo& info, const Vk
if (vkCreateRenderPass(device.m_logicalDevice, &createInfo, nullptr, &m_renderPass) != VK_SUCCESS) { if (vkCreateRenderPass(device.m_logicalDevice, &createInfo, nullptr, &m_renderPass) != VK_SUCCESS) {
// failed! TODO - Error handling // failed! TODO - Error handling
} }
#if KRENGINE_DEBUG_GPU_LABELS
device.setDebugLabel(m_renderPass, info.debugLabel);
#endif
} }
void KRRenderPass::destroy(KRDevice& device) void KRRenderPass::destroy(KRDevice& device)

3
kraken/KRRenderPass.h
View File

@@ -68,6 +68,9 @@ struct RenderPassInfo
RenderPassType type; RenderPassType type;
RenderPassAttachmentInfo colorAttachments[RENDER_PASS_ATTACHMENT_MAX_COUNT]; RenderPassAttachmentInfo colorAttachments[RENDER_PASS_ATTACHMENT_MAX_COUNT];
RenderPassAttachmentInfo depthAttachment; RenderPassAttachmentInfo depthAttachment;
#if KRENGINE_DEBUG_GPU_LABELS
char debugLabel[KRENGINE_DEBUG_GPU_LABEL_MAX_LEN];
#endif
bool finalPass; bool finalPass;
}; };