Program Listing for File Utilities.hpp

↰ Return to documentation for file (Src/GraphicsEngineVulkan/common/Utilities.hpp)

#pragma once

#include <cstdlib>

#include "host_device_shared_vars.hpp"
#include <spdlog/spdlog.h>

namespace Kataglyphis {
// Error checking on vulkan function calls. The project builds with
// exceptions disabled (/EHs-, VULKAN_HPP_NO_EXCEPTIONS), so the fail-fast
// primitive is abort(): a failed creation call must not continue into a
// null-handle dereference. Also used on a handful of query calls whose
// result feeds a decision with no safe fallback (e.g. surface capabilities
// sizing a swapchain) - none of those tolerate non-success either.
// Wrapped in do/while(false) and binding val to a local so the macro is a
// single statement, evaluated exactly once, even for side-effecting
// arguments (e.g. vmaCreateBuffer) and regardless of how the body grows.
#define ASSERT_VULKAN(val, error_string) \
    do { \
        const vk::Result assert_vulkan_result_ = static_cast<vk::Result>(val); \
        if (assert_vulkan_result_ != vk::Result::eSuccess) { \
            spdlog::critical(error_string); \
            std::abort(); \
        } \
    } while (false)

#ifdef NDEBUG
const bool ENABLE_VALIDATION_LAYERS = false;
#else
const bool ENABLE_VALIDATION_LAYERS = true;
#endif
}// namespace Kataglyphis