wsi/surface.hpp

   1 /*
   2  * Copyright (c) 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
  27  * @brief Vulkan WSI surface interfaces.
  28  */
  29
  30 #pragma once
  31
  32 #include <vulkan/vulkan.h>
  33 #include "surface_properties.hpp"
  34 #include "swapchain_base.hpp"
  35
  36 namespace wsi
  37 {
  38
  39 /**
  40  * @brief A generic WSI representation of a VkSurface.
  41  *
  42  * The association between these objects and VkSurfaces is kept in the VkInstance private data.
  43  */
  44 class surface
  45 {
  46 public:
  47    virtual ~surface() = default;
  48
  49    /**
  50     * @brief Returns a @ref surface_properties implementation that can be specific to the VkSurface represented.
  51     */
  52    virtual surface_properties &get_properties() = 0;
  53
  54    /**
  55     * @brief Allocates a swapchain for the VkSurface type represented.
  56     *
  57     * @param dev_data  The VkDevice associated private date.
  58     * @param allocator Allocation callbacks to use for host memory.
  59     *
  60     * @return nullptr on failure otherwise a constructed swapchain.
  61     */
  62    virtual util::unique_ptr<swapchain_base> allocate_swapchain(layer::device_private_data &dev_data,
  63                                                                const VkAllocationCallbacks *allocator) = 0;
  64 };
  65
  66 } /* namespace wsi */