src/dawn/native/vulkan/SwapChainVk.h

// Copyright 2018 The Dawn Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef SRC_DAWN_NATIVE_VULKAN_SWAPCHAINVK_H_
#define SRC_DAWN_NATIVE_VULKAN_SWAPCHAINVK_H_

#include <vector>

#include "dawn/native/SwapChain.h"

#include "dawn/common/vulkan_platform.h"

namespace dawn::native::vulkan {

class Device;
class Texture;
struct VulkanSurfaceInfo;

class SwapChain : public SwapChainBase {
  public:
    static ResultOrError<Ref<SwapChain>> Create(Device* device,
                                                Surface* surface,
                                                SwapChainBase* previousSwapChain,
                                                const SwapChainDescriptor* descriptor);

    static ResultOrError<wgpu::TextureUsage> GetSupportedSurfaceUsage(const Device* device,
                                                                      const Surface* surface);

    ~SwapChain() override;

  private:
    using SwapChainBase::SwapChainBase;
    MaybeError Initialize(SwapChainBase* previousSwapChain);
    void DestroyImpl() override;

    struct Config {
        // Information that's passed to vulkan swapchain creation.
        VkPresentModeKHR presentMode;
        VkExtent2D extent;
        VkImageUsageFlags usage;
        VkFormat format;
        VkColorSpaceKHR colorSpace;
        uint32_t targetImageCount;
        VkSurfaceTransformFlagBitsKHR transform;
        VkCompositeAlphaFlagBitsKHR alphaMode;

        // Redundant information but as WebGPU enums to create the wgpu::Texture that
        // encapsulates the native swapchain texture.
        wgpu::TextureUsage wgpuUsage;
        wgpu::TextureFormat wgpuFormat;

        // Information about the blit workarounds we need to do (if any)
        bool needsBlit = false;
    };
    ResultOrError<Config> ChooseConfig(const VulkanSurfaceInfo& surfaceInfo) const;
    ResultOrError<Ref<TextureBase>> GetCurrentTextureInternal(bool isReentrant = false);

    // SwapChainBase implementation
    MaybeError PresentImpl() override;
    ResultOrError<Ref<TextureBase>> GetCurrentTextureImpl() override;
    void DetachFromSurfaceImpl() override;

    Config mConfig;

    VkSurfaceKHR mVkSurface = VK_NULL_HANDLE;
    VkSwapchainKHR mSwapChain = VK_NULL_HANDLE;
    std::vector<VkImage> mSwapChainImages;
    std::vector<VkSemaphore> mSwapChainSemaphores;
    uint32_t mLastImageIndex = 0;

    Ref<Texture> mBlitTexture;
    Ref<Texture> mTexture;
};

}  // namespace dawn::native::vulkan

#endif  // SRC_DAWN_NATIVE_VULKAN_SWAPCHAINVK_H_