VulkanDevice.h

Go to the documentation of this file.

#pragma once
#include "VulkanGraphics/Headers/VulkanInstance.h"
#include "NDEVRGraphics/Headers/GraphicsDevice.h"
struct VkDeviceCreateInfo;
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief A GraphicsDevice for managing Vulkan limitations and actions. See:
        https://docs.vulkan.org/spec/latest/chapters/devsandqueues.html
    **/
    class VulkanDevice : public GraphicsDevice
    {
    public:
        VulkanDevice(VkPhysicalDevice physical_device, const DynamicPointer<VulkanInstance>& instance);
        VulkanDevice(const DynamicPointer<VulkanInstance>& instance);
        VulkanDevice(VulkanDevice&& instance) noexcept;
        virtual ~VulkanDevice(){};
        static DynamicPointer<VulkanDevice>& DefaultVulkanDevice();
        void setDeviceLost();
        UUID id() const override { return m_id; };
 
        void init() override;
        void cleanup();
        bool isInitialized() const override { return m_is_init; }
        bool isValid() const override;
        void destroyImageView(VkImageView image_view);
        VkCommandPool getCommandPool(uint04 id = Constant<uint04>::Invalid) const;
        void destroyCommandPool(uint04 id);
        VkQueue graphicsQueue(uint04 id = Constant<uint04>::Invalid) const;
        VkQueue presentQueue(uint04 id = Constant<uint04>::Invalid) const;
        VkCommandBuffer beginSingleTimeCommands(uint04 id = Constant<uint04>::Invalid) const;
        void endSingleTimeCommands(VkCommandBuffer commandBuffer, bool wait_for_completion, uint04 id = Constant<uint04>::Invalid) const;
        uint04 checkoutID() const;
        void checkoutID(uint04 id) const;
        void returnID(uint04 id = Constant<uint04>::Invalid) const;
        uint04 maxSupportedSamples() const override;
        virtual uint04 getThreadedID() const;
        bool isSoftwareRendered() const; 
        virtual bool canServiceCaptureRequests() const final override;
    #ifdef ANDROID
        virtual bool supportsMultiThreading() const override { return false; }
    #else
        virtual bool supportsMultiThreading() const override { return true; }
    #endif
        virtual void waitForGraphicsQueue(uint04 id = Constant<uint04>::Invalid) const;
        void logPhysicalDevice();
        const VkPhysicalDeviceProperties& physicalProperties() const;
        const VkPhysicalDeviceFeatures& physicalFeatures() const;
        const VkPhysicalDeviceFeatures& enabledFeatures() const;
        const void* initLockPtr() const override;//To initialize, must hold write lock, to use must hold read lock
        VkPresentModeKHR chooseSwapPresentMode(const Buffer<VkPresentModeKHR>& availablePresentModes);
        void addSurface(VkSurfaceKHR surface);
        void removeSurface(VkSurfaceKHR surface);
    
        VkFormat findDepthFormat() const;
        DynamicPointer<VulkanInstance> instance() const;
        VkInstance vkInstance() const { lib_assert(!m_instance.isNull(), "Instance not yet created, but access is attempted"); return m_instance->vkInstance(); }
        VkDevice device() const { return m_device; }
        const VkPhysicalDevice& physicalDevice() const { return m_physical_device; }
 
        void setLog(ProgressInfo* log);
        ProgressInfo* log() { return m_log; }
        bool supportsTriangleFan() const {return m_instance->supportsTriangleFan();}
        uint04 findMemoryType(uint04 typeFilter, uint04 properties) const;
    protected:
        void setQueueFamilies();
        void setupLogicalDevice();
        bool checkDeviceExtensionSupport(VkPhysicalDevice device);
        void createCommandPool(uint04 thread) const;
        virtual VkResult createLogicalDevice(const VkDeviceCreateInfo& create_info);
        virtual void autoChoosePhysicalDevice();
    protected:
        ProgressInfo* m_log;
        DynamicPointer<VulkanInstance> m_instance;
        VkDevice         m_device;//Virtual device for rendering
        VkPhysicalDevice m_physical_device;//Best device for rendering
        Buffer<String> m_device_extensions;
        Buffer<String> m_device_layers;
        Buffer<VkSurfaceKHR> m_surfaces;
        UUID m_id;
        Buffer<VkQueueFamilyProperties, uint04, ObjectAllocator<true>> m_queue_families;
        mutable VkPhysicalDeviceProperties* m_physical_properties;
        mutable VkPhysicalDeviceFeatures* m_physical_features;
        mutable VkPhysicalDeviceFeatures* m_enabled_features;
        uint04 m_graphics_family_index;
        uint04 m_present_family_index;
        Time m_creation_time;
 
        mutable Dictionary<uint04, VkCommandPool> m_command_pools;//A command pool for each thread
 
        mutable Dictionary<uint04, VkQueue> m_present_queue;
        mutable Dictionary<uint04, VkQueue> m_graphics_queue;
        mutable Dictionary<uint04, uint04> m_graphics_queue_index;
        mutable Buffer<uint04> m_checkouts;
        mutable Dictionary<uint04, uint04> m_thread_checkouts;
        bool m_is_software_rendered;
 
        bool m_is_init;
    };
}