foray_vulkaninstance.hpp

Go to the documentation of this file.

#pragma once
#include "../foray_basics.hpp"
#include "../foray_vkb.hpp"
#include <functional>
 
namespace foray::base {
    class VulkanInstance
    {
      public:
        using BeforeInstanceBuildFunctionPointer = std::function<void(vkb::InstanceBuilder&)>;
 
        VulkanInstance() = default;
        inline VulkanInstance(core::Context* context, BeforeInstanceBuildFunctionPointer beforeInstanceBuildFunc, bool enableDebugLayersAndCallbacks)
            : mBeforeInstanceBuildFunc{beforeInstanceBuildFunc}, mEnableDebugLayersAndCallbacks{enableDebugLayersAndCallbacks}, mContext{context}
        {
        }
 
        FORAY_SETTER_V(BeforeInstanceBuildFunc);
        FORAY_SETTER_V(DebugMessengerFunc);
        FORAY_SETTER_V(DebugReportFunc);
 
        FORAY_PROPERTY_V(DebugUserData)
        FORAY_PROPERTY_V(EnableDebugLayersAndCallbacks)
        FORAY_PROPERTY_V(EnableDebugReport)
        FORAY_PROPERTY_R(Instance)
        FORAY_PROPERTY_V(Context)
 
        inline operator bool() const { return !!mInstance.instance; }
        inline operator VkInstance() const { return mInstance.instance; }
 
        void        Create();
        inline bool Exists() const { return !!mInstance.instance; }
        void        Destroy();
 
        ~VulkanInstance();
 
      protected:
        static VkBool32 DefaultDebugMessengerCallback(VkDebugUtilsMessageSeverityFlagBitsEXT      messageSeverity,
                                                      VkDebugUtilsMessageTypeFlagsEXT             messageTypes,
                                                      const VkDebugUtilsMessengerCallbackDataEXT* pCallbackData,
                                                      void*                                       pUserData);
 
        static VkBool32 DefaultDebugReportCallback(VkDebugReportFlagsEXT      flags,
                                                   VkDebugReportObjectTypeEXT objectType,
                                                   uint64_t                   object,
                                                   size_t                     location,
                                                   int32_t                    messageCode,
                                                   const char*                pLayerPrefix,
                                                   const char*                pMessage,
                                                   void*                      pUserData);
 
        BeforeInstanceBuildFunctionPointer   mBeforeInstanceBuildFunc   = nullptr;
        PFN_vkDebugUtilsMessengerCallbackEXT mDebugMessengerFunc        = &DefaultDebugMessengerCallback;
        void*                                mDebugUserData             = nullptr;
        PFN_vkDebugReportCallbackEXT         mDebugReportFunc           = &DefaultDebugReportCallback;
        VkDebugReportCallbackEXT             mDebugReportCallbackHandle = nullptr;
 
        bool mEnableDebugLayersAndCallbacks = true;
 
        bool mEnableDebugReport = false;
 
        core::Context* mContext = nullptr;
 
        vkb::Instance mInstance;
    };
}  // namespace foray::base