VulkanSwapChain.h

/*
* Class wrapping access to the swap chain
* 
* A swap chain is a collection of framebuffers used for rendering and presentation to the windowing system
*
* Copyright (C) 2016-2024 by Sascha Willems - www.saschawillems.de
*
* This code is licensed under the MIT license (MIT) (http://opensource.org/licenses/MIT)
*/
 
#pragma once
 
#include <stdlib.h>
#include <string>
#include <assert.h>
#include <stdio.h>
#include <vector>
 
#include <vulkan/vulkan.h>
#include "Context.h"
#include "VulkanTools.h"
 
#ifdef __ANDROID__
#include "VulkanAndroid.h"
#endif
 
#ifdef __APPLE__
#include <sys/utsname.h>
#endif
 
typedef struct _SwapChainBuffers {
    VkImage image;
    VkImageView view;
} SwapChainBuffer;
 
class VulkanSwapChain
{
private:
    vks::Context *_context {nullptr};
    VkSurfaceKHR surface;
public:
    VkExtent2D extent{0, 0};
    VkFormat colorFormat;
    VkColorSpaceKHR colorSpace;
    VkSwapchainKHR swapChain = VK_NULL_HANDLE;    
    uint32_t imageCount;
    std::vector<VkImage> images;
    std::vector<SwapChainBuffer> buffers;
    uint32_t queueNodeIndex = UINT32_MAX;
 
#if defined(VK_USE_PLATFORM_WIN32_KHR)
    void initSurface(void* platformHandle, void* platformWindow);
#elif defined(VK_USE_PLATFORM_ANDROID_KHR)
    void initSurface(ANativeWindow* window);
#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
    void initSurface(IDirectFB* dfb, IDirectFBSurface* window);
#elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
    void initSurface(wl_display* display, wl_surface* window);
#elif defined(VK_USE_PLATFORM_XCB_KHR)
    void initSurface(xcb_connection_t* connection, xcb_window_t window);
#elif (defined(VK_USE_PLATFORM_IOS_MVK) || defined(VK_USE_PLATFORM_MACOS_MVK))
    void initSurface(void* view);
#elif defined(VK_USE_PLATFORM_METAL_EXT)
    void initSurface(CAMetalLayer* metalLayer);
#elif (defined(_DIRECT2DISPLAY) || defined(VK_USE_PLATFORM_HEADLESS_EXT))
    void initSurface(uint32_t width, uint32_t height);
#if defined(_DIRECT2DISPLAY)
    void createDirect2DisplaySurface(uint32_t width, uint32_t height);
#endif
#elif defined(VK_USE_PLATFORM_SCREEN_QNX)
    void initSurface(screen_context_t screen_context, screen_window_t screen_window);
#endif
    /* Set the Vulkan objects required for swapchain creation and management, must be called before swapchain creation */
    void setContext(vks::Context *context);
    void create(uint32_t* width, uint32_t* height, bool vsync = false, bool fullscreen = false);
    VkResult acquireNextImage(VkSemaphore presentCompleteSemaphore, uint32_t* imageIndex);
    VkResult queuePresent(VkQueue queue, uint32_t imageIndex, VkSemaphore waitSemaphore = VK_NULL_HANDLE);
    /* Free all Vulkan resources acquired by the swapchain */
    void cleanup();
};