includes/Core/e_debuger.h - master - Zamar_Terrier/TigorEngine

includes/Core/e_debuger.h
49 строк3 KB
Zamar_Terrier
Доработка + нововведения
06 июл 2026, 16:26
06 июл 2026, 16:260d4ab95
/**
 * @file e_debuger.h
 * @brief Управление отладочными мессенджерами Vulkan и утилиты отладки
 * @details Предоставляет функции для создания, настройки и уничтожения отладочных мессенджеров Vulkan
 * для отладки вызовов и сообщений Vulkan API. Модуль обеспечивает интеграцию с отладочными
 * инструментами Vulkan и помогает выявлять ошибки на этапе разработки.
 */

#ifndef DEBUGGER_H
#define DEBUGGER_H

#include "Variabels/engine_includes.h"

/**
 * @brief Уничтожает отладочный мессенджер Vulkan
 * @details Удаляет отладочный мессенджер и освобождает связанные с ним ресурсы.
 * 
 * @param instance [in] Дескриптор экземпляра Vulkan
 * @param debugMessenger [in] Объект отладочного мессенджера для уничтожения
 * @param pAllocator [in] Опциональные колбэки аллокатора для пользовательского управления памятью
 * @note Функция должна вызываться перед уничтожением Vulkan instance
 * @see setupDebugMessenger, populateDebugMessengerCreateInfo
 */
void DestroyDebugUtilsMessengerEXT(void *instance, VkDebugUtilsMessengerEXT debugMessenger, const VkAllocationCallbacks *pAllocator);

/**
 * @brief Заполняет структуру create info для отладочного мессенджера
 * @details Настраивает отладочный мессенджер с параметрами по умолчанию для сообщений об ошибках,
 * предупреждениях и информационных сообщениях. Структура заполняется значениями,
 * подходящими для большинства случаев отладки.
 * 
 * @param createInfo [out] Указатель на структуру create info для заполнения
 * @note Структура будет содержать флаги для отладочных сообщений всех уровней
 * @see DestroyDebugUtilsMessengerEXT, setupDebugMessenger
 */
void populateDebugMessengerCreateInfo(VkDebugUtilsMessengerCreateInfoEXT *createInfo);

/**
 * @brief Инициализирует отладочный мессенджер для экземпляра Vulkan
 * @details Создает и настраивает отладочный мессенджер Vulkan с использованием конфигурации
 * по умолчанию. Функция вызывает populateDebugMessengerCreateInfo для заполнения
 * структуры и затем создает мессенджер через Vulkan API.
 * 
 * @note Должна вызываться после создания Vulkan instance и до начала рендеринга
 * @see DestroyDebugUtilsMessengerEXT, populateDebugMessengerCreateInfo
 */
void setupDebugMessenger(void);

#endif // DEBUGGER_H