wsi/surface_properties.hpp

   1 /*
   2  * Copyright (c) 2017-2019, 2021 Arm Limited.
   3  *
   4  * SPDX-License-Identifier: MIT
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to
   8  * deal in the Software without restriction, including without limitation the
   9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  10  * sell copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in all
  14  * copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24
  25 /**
  26  * @file surface_properties.hpp
  27  *
  28  * @brief Vulkan WSI surface query interfaces.
  29  */
  30
  31 #pragma once
  32
  33 #include <vulkan/vulkan.h>
  34 #include <util/extension_list.hpp>
  35
  36 namespace wsi
  37 {
  38
  39 /**
  40  * @brief The base surface property query interface.
  41  */
  42 class surface_properties
  43 {
  44 public:
  45    /**
  46     * @brief Implementation of vkGetPhysicalDeviceSurfaceCapabilitiesKHR for the specific VkSurface type.
  47     */
  48    virtual VkResult get_surface_capabilities(VkPhysicalDevice physical_device, VkSurfaceKHR surface,
  49                                              VkSurfaceCapabilitiesKHR *surface_capabilities) = 0;
  50
  51    /**
  52     * @brief Implementation of vkGetPhysicalDeviceSurfaceFormatsKHR for the specific VkSurface type.
  53     */
  54    virtual VkResult get_surface_formats(VkPhysicalDevice physical_device, VkSurfaceKHR surface,
  55                                         uint32_t *surface_format_count, VkSurfaceFormatKHR *surface_formats) = 0;
  56
  57    /**
  58     * @brief Implementation of vkGetPhysicalDeviceSurfacePresentModesKHR for the specific VkSurface type.
  59     */
  60    virtual VkResult get_surface_present_modes(VkPhysicalDevice physical_device, VkSurfaceKHR surface,
  61                                               uint32_t *present_mode_count, VkPresentModeKHR *present_modes) = 0;
  62
  63    /**
  64     * @brief Return the device extensions that this surface_properties implementation needs.
  65     */
  66    virtual const util::extension_list &get_required_device_extensions()
  67    {
  68       static const util::extension_list empty{util::allocator::get_generic()};
  69       return empty;
  70    }
  71 };
  72
  73 } /* namespace wsi */