foray/foray__vulkan_8hpp_source.html

#pragma once

#include "core/foray_core_declares.hpp"

#include "foray_basics.hpp"

#include "foray_exception.hpp"

#include <vulkan/vulkan.h>

#if defined(WIN32) || defined(_WIN32) || defined(__WIN32__)

#define WIN32_LEAN_AND_MEAN

#include <Windows.h>

#include <vulkan/vulkan_win32.h>

#undef max // Windows headers included hide std::max

#undef min // Windows headers included hide std::max

#undef CreateWindow //

#endif


namespace foray {

    std::string PrintVkResult(VkResult result);


    inline void AssertVkResult(VkResult result, const source_location location = source_location::current())

    {

        if(result != VK_SUCCESS)

        {

            Exception::Throw(location, "VkResult Assertion Failed: VkResult::{}", PrintVkResult(result));

        }

    }


    void SetVulkanObjectName(core::Context* context, VkObjectType objectType, const void* objectHandle, std::string_view name);


}  // namespace foray

foray::Exception::Throw
static void Throw(std::string_view reason, const source_location location=source_location::current())
Throws an exception.

foray_basics.hpp

foray_core_declares.hpp

foray_exception.hpp

source_location
std::source_location source_location
Definition foray_exception.hpp:8

foray
Definition foray_api.hpp:19

foray::PrintVkResult
std::string PrintVkResult(VkResult result)
Prints a VkResult. If outside of NAMEF_ENUM_RANGE_MAX, will only print number.

foray::SetVulkanObjectName
void SetVulkanObjectName(core::Context *context, VkObjectType objectType, const void *objectHandle, std::string_view name)
Set a vulkan object name (Will show up in validation errors, NSight, RenderDoc, .....

foray::AssertVkResult
void AssertVkResult(VkResult result, const source_location location=source_location::current())
Asserts a VkResult (Fails if not VK_SUCCESS)
Definition foray_vulkan.hpp:20

foray::core::Context
Non owning context object.
Definition foray_context.hpp:16