Files
Vulkan-Samples/framework/core/hpp_debug.cpp
T
2025-09-04 10:54:47 +08:00

118 lines
4.8 KiB
C++

/* Copyright (c) 2023-2025, NVIDIA CORPORATION. All rights reserved.
*
* SPDX-License-Identifier: Apache-2.0
*
* Licensed under the Apache License, Version 2.0 the "License";
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "core/hpp_debug.h"
#include "core/command_buffer.h"
#include "core/device.h"
namespace vkb
{
namespace core
{
void HPPDebugUtilsExtDebugUtils::set_debug_name(vk::Device device, vk::ObjectType object_type, uint64_t object_handle, const char *name) const
{
vk::DebugUtilsObjectNameInfoEXT name_info{.objectType = object_type, .objectHandle = object_handle, .pObjectName = name};
device.setDebugUtilsObjectNameEXT(name_info);
}
void HPPDebugUtilsExtDebugUtils::set_debug_tag(
vk::Device device, vk::ObjectType object_type, uint64_t object_handle, uint64_t tag_name, const void *tag_data, size_t tag_data_size) const
{
vk::DebugUtilsObjectTagInfoEXT tag_info{.objectType = object_type, .objectHandle = object_handle, .tagName = tag_name, .tagSize = tag_data_size, .pTag = tag_data};
device.setDebugUtilsObjectTagEXT(tag_info);
}
void HPPDebugUtilsExtDebugUtils::cmd_begin_label(vk::CommandBuffer command_buffer, const char *name, glm::vec4 const color) const
{
vk::DebugUtilsLabelEXT label_info{.pLabelName = name, .color = reinterpret_cast<std::array<float, 4> const &>(*&color[0])};
command_buffer.beginDebugUtilsLabelEXT(label_info);
}
void HPPDebugUtilsExtDebugUtils::cmd_end_label(vk::CommandBuffer command_buffer) const
{
command_buffer.endDebugUtilsLabelEXT();
}
void HPPDebugUtilsExtDebugUtils::cmd_insert_label(vk::CommandBuffer command_buffer, const char *name, glm::vec4 const color) const
{
vk::DebugUtilsLabelEXT label_info{.pLabelName = name, .color = reinterpret_cast<std::array<float, 4> const &>(*&color[0])};
command_buffer.insertDebugUtilsLabelEXT(label_info);
}
void HPPDebugMarkerExtDebugUtils::set_debug_name(vk::Device device, vk::ObjectType object_type, uint64_t object_handle, const char *name) const
{
vk::DebugMarkerObjectNameInfoEXT name_info{.objectType = vk::debugReportObjectType(object_type), .object = object_handle, .pObjectName = name};
device.debugMarkerSetObjectNameEXT(name_info);
}
void HPPDebugMarkerExtDebugUtils::set_debug_tag(
vk::Device device, vk::ObjectType object_type, uint64_t object_handle, uint64_t tag_name, const void *tag_data, size_t tag_data_size) const
{
vk::DebugMarkerObjectTagInfoEXT tag_info{
.objectType = vk::debugReportObjectType(object_type), .object = object_handle, .tagName = tag_name, .tagSize = tag_data_size, .pTag = tag_data};
device.debugMarkerSetObjectTagEXT(tag_info);
}
void HPPDebugMarkerExtDebugUtils::cmd_begin_label(vk::CommandBuffer command_buffer, const char *name, glm::vec4 const color) const
{
vk::DebugMarkerMarkerInfoEXT marker_info{.pMarkerName = name, .color = reinterpret_cast<std::array<float, 4> const &>(*&color[0])};
command_buffer.debugMarkerBeginEXT(marker_info);
}
void HPPDebugMarkerExtDebugUtils::cmd_end_label(vk::CommandBuffer command_buffer) const
{
command_buffer.debugMarkerEndEXT();
}
void HPPDebugMarkerExtDebugUtils::cmd_insert_label(vk::CommandBuffer command_buffer, const char *name, glm::vec4 const color) const
{
vk::DebugMarkerMarkerInfoEXT marker_info{.pMarkerName = name, .color = reinterpret_cast<std::array<float, 4> const &>(*&color[0])};
command_buffer.debugMarkerInsertEXT(marker_info);
}
HPPScopedDebugLabel::HPPScopedDebugLabel(const HPPDebugUtils &debug_utils,
vk::CommandBuffer command_buffer,
std::string const &name,
glm::vec4 const color) :
debug_utils{&debug_utils}, command_buffer{VK_NULL_HANDLE}
{
if (!name.empty())
{
assert(command_buffer);
this->command_buffer = command_buffer;
debug_utils.cmd_begin_label(command_buffer, name.c_str(), color);
}
}
HPPScopedDebugLabel::HPPScopedDebugLabel(const vkb::core::CommandBufferCpp &command_buffer,
std::string const &name,
glm::vec4 const color) :
HPPScopedDebugLabel{command_buffer.get_device().get_debug_utils(), command_buffer.get_handle(), name, color}
{
}
HPPScopedDebugLabel::~HPPScopedDebugLabel()
{
if (command_buffer)
{
debug_utils->cmd_end_label(command_buffer);
}
}
} // namespace core
} // namespace vkb