BansheeEngine/Source/BansheeVulkanRenderAPI/BsVulkanDevice.h

//********************************** Banshee Engine (www.banshee3d.com) **************************************************//
//**************** Copyright (c) 2016 Marko Pintera ([email protected]). All rights reserved. **********************//
#pragma once

#include "BsVulkanPrerequisites.h"
#include "RenderAPI/BsRenderAPI.h"
#include "Managers/BsVulkanDescriptorManager.h"

namespace bs { namespace ct
{
	/** @addtogroup Vulkan
	 *  @{
	 */

	/** Contains format describing a Vulkan surface. */
	struct SurfaceFormat
	{
		VkFormat colorFormat;
		VkFormat depthFormat;
		VkColorSpaceKHR colorSpace;
	};

	/** Represents a single GPU device usable by Vulkan. */
	class VulkanDevice
	{
	public:
		VulkanDevice(VkPhysicalDevice device, UINT32 deviceIdx);
		~VulkanDevice();

		/** Returns an object describing the physical properties of the device. */
		VkPhysicalDevice getPhysical() const { return mPhysicalDevice; }

		/** Returns an object describing the logical properties of the device. */
		VkDevice getLogical() const { return mLogicalDevice; }

		/** Returns true if the device is one of the primary GPU's. */
		bool isPrimary() const { return mIsPrimary; }

		/** Returns the unique index of the device. */
		UINT32 getIndex() const { return mDeviceIdx; }

		/** Blocks the calling thread until all operations on the device finish. */
		void waitIdle() const;

		/** Returns a set of properties describing the physical device. */
		const VkPhysicalDeviceProperties& getDeviceProperties() const { return mDeviceProperties; }

		/** Returns a set of features that the application can use to check if a specific feature is supported. */
		const VkPhysicalDeviceFeatures& getDeviceFeatures() const { return mDeviceFeatures; }

		/** Returns a set of properties describing the memory of the physical device. */
		const VkPhysicalDeviceMemoryProperties& getMemoryProperties() const { return mMemoryProperties; }

		/** Returns the number of queue supported on the device, per type. */
		UINT32 getNumQueues(GpuQueueType type) const { return (UINT32)mQueueInfos[(int)type].queues.size(); }

		/** Returns queue of the specified type at the specified index. Index must be in range [0, getNumQueues()). */
		VulkanQueue* getQueue(GpuQueueType type, UINT32 idx) const { return mQueueInfos[(int)type].queues[idx]; }

		/** 
		 * Returns index of the queue family for the specified queue type. Returns -1 if no queues for the specified type 
		 * exist. There will always be a queue family for the graphics type.
		 */
		UINT32 getQueueFamily(GpuQueueType type) const { return mQueueInfos[(int)type].familyIdx; }

		/** 
		 * Fills out a mask that has bits set for every queue index that maps to the same physical queue as the provided 
		 * index. This is useful as different queue indices will sometimes map to the same physical queue.
		 */
		UINT32 getQueueMask(GpuQueueType type, UINT32 queueIdx) const;

		/** Returns the best matching surface format according to the provided parameters. */
		SurfaceFormat getSurfaceFormat(const VkSurfaceKHR& surface, bool gamma) const;

		/** Returns a pool that can be used for allocating command buffers for all queues on this device. */
		VulkanCmdBufferPool& getCmdBufferPool() const { return *mCommandBufferPool; }

		/** Returns a pool that can be used for allocating queries on this device. */
		VulkanQueryPool& getQueryPool() const { return *mQueryPool; }

		/** Returns a manager that can be used for allocating descriptor layouts and sets. */
		VulkanDescriptorManager& getDescriptorManager() const { return *mDescriptorManager; }

		/** Returns a manager that can be used for allocating Vulkan objects wrapped as managed resources. */
		VulkanResourceManager& getResourceManager() const { return *mResourceManager; }

		/** 
		 * Allocates memory for the provided image, and binds it to the image. Returns null if it cannot find memory
		 * with the specified flags.
		 */
		VkDeviceMemory allocateMemory(VkImage image, VkMemoryPropertyFlags flags);

		/** 
		 * Allocates memory for the provided buffer, and binds it to the buffer. Returns null if it cannot find memory
		 * with the specified flags.
		 */
		VkDeviceMemory allocateMemory(VkBuffer buffer, VkMemoryPropertyFlags flags);

		/** 
		 * Allocates a block of memory according to the provided memory requirements. Returns null if it cannot find memory
		 * with the specified flags. 
		 */
		VkDeviceMemory allocateMemory(const VkMemoryRequirements& reqs, VkMemoryPropertyFlags flags);

		/** Frees a previously allocated block of memory. */
		void freeMemory(VkDeviceMemory memory);

	private:
		friend class VulkanRenderAPI;

		/** Attempts to find a memory type that matches the requirements bits and the requested flags. */
		uint32_t findMemoryType(uint32_t requirementBits, VkMemoryPropertyFlags wantedFlags);

		/** Marks the device as a primary device. */
		void setIsPrimary() { mIsPrimary = true; }

		VkPhysicalDevice mPhysicalDevice;
		VkDevice mLogicalDevice;
		bool mIsPrimary;
		UINT32 mDeviceIdx;

		VulkanCmdBufferPool* mCommandBufferPool;
		VulkanQueryPool* mQueryPool;
		VulkanDescriptorManager* mDescriptorManager;
		VulkanResourceManager* mResourceManager;

		VkPhysicalDeviceProperties mDeviceProperties;
		VkPhysicalDeviceFeatures mDeviceFeatures;
		VkPhysicalDeviceMemoryProperties mMemoryProperties;

		/** Contains data about a set of queues of a specific type. */
		struct QueueInfo
		{
			UINT32 familyIdx;
			Vector<VulkanQueue*> queues;
		};

		QueueInfo mQueueInfos[GQT_COUNT];

	};

	/** @} */
}}