foray_vulkandevice.hpp

Go to the documentation of this file.

#pragma once
#include "../foray_basics.hpp"
#include "../foray_vkb.hpp"
#include <functional>
 
namespace foray::base {
    class VulkanDevice
    {
      public:
        using BeforePhysicalDeviceSelectFunctionPointer = std::function<void(vkb::PhysicalDeviceSelector&)>;
        using BeforeDeviceBuildFunctionPointer = std::function<void(vkb::DeviceBuilder&)>;
 
        VulkanDevice() = default;
        inline VulkanDevice(core::Context* context, BeforePhysicalDeviceSelectFunctionPointer beforePhysicalDeviceSelectFunc, BeforeDeviceBuildFunctionPointer beforeDeviceBuildFunc)
            : mBeforePhysicalDeviceSelectFunc{beforePhysicalDeviceSelectFunc}, mBeforeDeviceBuildFunc{beforeDeviceBuildFunc}, mContext{context}
        {
        }
 
        inline operator bool() const { return !!mDevice.device; }
        inline operator VkDevice() const { return mDevice.device; }
        inline operator VkPhysicalDevice() const { return mPhysicalDevice.physical_device; }
        inline operator vkb::Device&() { return mDevice; }
        inline operator const vkb::Device&() const { return mDevice; }
 
        VulkanDevice& SetBeforePhysicalDeviceSelectFunc(BeforePhysicalDeviceSelectFunctionPointer beforePhysicalDeviceSelectFunc);
        VulkanDevice& SetBeforeDeviceBuildFunc(BeforeDeviceBuildFunctionPointer beforeDeviceBuildFunc);
 
        FORAY_PROPERTY_V(SetDefaultCapabilitiesToDeviceSelector)
        FORAY_PROPERTY_V(EnableDefaultDeviceFeatures)
        FORAY_PROPERTY_V(EnableDefaultPhysicalDeviceFeatures)
        FORAY_PROPERTY_V(ShowConsoleDeviceSelectionPrompt)
        FORAY_PROPERTY_R(PhysicalDeviceFeatures)
        FORAY_PROPERTY_R(PhysicalDevice)
        FORAY_PROPERTY_R(Device)
        FORAY_PROPERTY_R(DispatchTable)
        FORAY_PROPERTY_V(Context)
 
        
        void Create();
        void SelectPhysicalDevice();
        void        BuildDevice();
        inline bool Exists() const { return !!mDevice.device; }
        void        Destroy();
 
        ~VulkanDevice();
 
      protected:
        BeforePhysicalDeviceSelectFunctionPointer mBeforePhysicalDeviceSelectFunc = nullptr;
        BeforeDeviceBuildFunctionPointer          mBeforeDeviceBuildFunc          = nullptr;
 
        bool mSetDefaultCapabilitiesToDeviceSelector = true;
        bool mEnableDefaultDeviceFeatures = true;
        bool mEnableDefaultPhysicalDeviceFeatures = true;
 
        bool mShowConsoleDeviceSelectionPrompt = false;
 
        core::Context* mContext = nullptr;
 
        vkb::PhysicalDevice mPhysicalDevice;
        vkb::Device         mDevice;
        vkb::DispatchTable  mDispatchTable;
 
        struct DefaultFeatures
        {
            VkPhysicalDeviceBufferDeviceAddressFeatures      BufferDeviceAdressFeatures    = {};
            VkPhysicalDeviceRayTracingPipelineFeaturesKHR    RayTracingPipelineFeatures    = {};
            VkPhysicalDeviceAccelerationStructureFeaturesKHR AccelerationStructureFeatures = {};
            VkPhysicalDeviceDescriptorIndexingFeaturesEXT    DescriptorIndexingFeatures    = {};
            VkPhysicalDeviceSynchronization2Features         Sync2FEatures                 = {};
        } mDefaultFeatures = {};
 
        VkPhysicalDeviceFeatures mPhysicalDeviceFeatures{};
    };
}  // namespace foray::base