wsi.hpp

/* Copyright (c) 2016-2017, ARM Limited and Contributors
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge,
 * to any person obtaining a copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef PLATFORM_WSI_HPP
#define PLATFORM_WSI_HPP

#include "framework/semaphore_manager.hpp"
#include "libvulkan-stub.h"
#include "platform.hpp"

namespace MaliSDK
{

class WSIPlatform : public Platform
{
public:
        virtual ~WSIPlatform();

        virtual Result initialize() override;

        virtual void getCurrentSwapchain(std::vector<VkImage> *images, SwapchainDimensions *swapchain) override;

        virtual unsigned getNumSwapchainImages() const override;

        virtual Result acquireNextImage(unsigned *index) override;

        virtual Result presentImage(unsigned index) override;

        void terminate() override;

protected:
        Result initVulkan(const SwapchainDimensions &swapchain, const std::vector<const char *> &instanceExtensions,
                          const std::vector<const char *> &deviceExtensions);

        Result initSwapchain(const SwapchainDimensions &swapchain);

        void destroySwapchain();

private:
        SemaphoreManager *semaphoreManager = nullptr;

        VkSurfaceKHR surface = VK_NULL_HANDLE;
        VkSwapchainKHR swapchain = VK_NULL_HANDLE;
        SwapchainDimensions swapchainDimensions;
        std::vector<VkImage> swapchainImages;

        virtual VkSurfaceKHR createSurface() = 0;
        Result loadDeviceSymbols();
        Result loadInstanceSymbols();

        bool validateExtensions(const std::vector<const char *> &required,
                                const std::vector<VkExtensionProperties> &available);

        VkDebugReportCallbackEXT debug_callback = VK_NULL_HANDLE;
};
}

#endif