layer: improve how layer handles Vulkan extensions

[platform/core/uifw/vulkan-wsi-tizen.git] / wsi / wsi_factory.hpp

diff --git a/wsi/wsi_factory.hpp b/wsi/wsi_factory.hpp
index 8f85b94..208074c 100644 (file)
--- a/wsi/wsi_factory.hpp
+++ b/wsi/wsi_factory.hpp
@@ -1,6 +1,5 @@
-
 /*
- * Copyright (c) 2019 Arm Limited.
+ * Copyright (c) 2019, 2021 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -27,17 +26,20 @@
  * @file
  * @brief Contains the factory methods for obtaining the specific surface and swapchain implementations.
  */
+
 #pragma once
 
 #include "swapchain_base.hpp"
 #include "surface_properties.hpp"
-#include <layer/private_data.hpp>
+#include "util/platform_set.hpp"
+
+#include <unordered_map>
 
 namespace wsi
 {
 
 /**
- * Obtains the surface properties for the specific surface type.
+ * @brief Obtains the surface properties for the specific surface type.
  *
  * @param surface The surface for which to get the properties.
  *
@@ -46,7 +48,7 @@ namespace wsi
 surface_properties *get_surface_properties(VkSurfaceKHR surface);
 
 /**
- * Allocates a surface specific swapchain.
+ * @brief Allocates a surface specific swapchain.
  *
  * @param surface    The surface for which a swapchain is allocated.
  * @param dev_data   The device specific data.
@@ -58,11 +60,39 @@ swapchain_base *allocate_surface_swapchain(VkSurfaceKHR surface, layer::device_p
                                            const VkAllocationCallbacks *pAllocator);
 
 /**
- * Destroys a swapchain and frees memory. Used with @ref allocate_surface_swapchain.
+ * @brief Destroys a swapchain and frees memory. Used with @ref allocate_surface_swapchain.
  *
  * @param swapchain  Pointer to the swapchain to destroy.
  * @param pAllocator The allocator to use for freeing memory.
  */
 void destroy_surface_swapchain(swapchain_base *swapchain, const VkAllocationCallbacks *pAllocator);
 
+/**
+ * @brief Return which platforms the layer can handle for an instance constructed in the specified way.
+ *
+ * @details This function looks at the extensions specified in @p pCreateInfo and based on this returns a list of
+ * platforms that the layer can support. For example, if the @c pCreateInfo.ppEnabledExtensionNames contains the string
+ * "VK_EXT_headless_surface" then the returned platform set will contain @c VK_ICD_WSI_PLATFORM_HEADLESS.
+ *
+ * @param pCreateInfo Structure used when creating the instance in vkCreateInstance().
+ *
+ * @return A list of WS platforms supported by the layer.
+ */
+util::wsi_platform_set find_enabled_layer_platforms(const VkInstanceCreateInfo *pCreateInfo);
+
+/**
+ * @brief Add extra extensions that the layer requires to support the specified list of enabled platforms.
+ *
+ * @details Check whether @p phys_dev has support for the extensions required by the layer in order to support the
+ * platforms it implements. The extensions that the layer requires to operate are added to @p extensions_to_enable.
+ *
+ * @param[in] phys_dev The physical device to check.
+ * @param[in] enabled_platforms All the platforms that the layer must enable for @p phys_dev.
+ * @param[in,out] extensions_to_enable All the extensions required by the layer are added to this list.
+ *
+ * @retval @c VK_SUCCESS if the operation was successful.
+ */
+VkResult add_extensions_required_by_layer(VkPhysicalDevice phys_dev, const util::wsi_platform_set enabled_platforms,
+                                          util::extension_list &extensions_to_enable);
+
 } // namespace wsi
\ No newline at end of file