VKFramebuffer.h

//
//  Created by Bradley Austin Davis on 2016/08/07
//  Adapted for Vulkan in 2022-2025 by dr Karol Suprynowicz.
//  Copyright 2013-2018 High Fidelity, Inc.
//  Copyright 2023-2025 Overte e.V.
//
//  Distributed under the Apache License, Version 2.0.
//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//  SPDX-License-Identifier: Apache-2.0
//
//  Contains parts of Vulkan Samples, Copyright (c) 2018, Sascha Willems, distributed on MIT License.
 
#ifndef hifi_gpu_vk_VKFramebuffer_h
#define hifi_gpu_vk_VKFramebuffer_h
 
#include "VKShared.h"
#include "VKBackend.h"
 
namespace gpu { namespace vk {
 
class VKFramebuffer : public vk::VKObject<Framebuffer> {
public:
    VkRenderPass vkRenderPass {VK_NULL_HANDLE};
    VkFramebuffer vkFramebuffer {VK_NULL_HANDLE};
 
    static VKFramebuffer* sync(vk::VKBackend& backend, const Framebuffer& framebuffer) {
        VKFramebuffer* object = Backend::getGPUObject<VKFramebuffer>(framebuffer);
 
        bool needsUpdate{ false };
        if (!object ||
            framebuffer.getDepthStamp() != object->_depthStamp ||
            framebuffer.getColorStamps() != object->_colorStamps) {
            needsUpdate = true;
        }
 
        // If GPU object already created and in sync
        if (!needsUpdate) {
            return object;
        } else if (framebuffer.isEmpty()) {
            // NO framebuffer definition yet so let's avoid thinking
            return nullptr;
        }
 
        // need to have a gpu object?
        if (!object) {
            // All is green, assign the gpuobject to the Framebuffer
            object = new VKFramebuffer(backend.shared_from_this(), framebuffer);
            Backend::setGPUObject(framebuffer, object);
        }
 
        object->update();
        return object;
    }
 
    Stamp _depthStamp { 0 };
    std::vector<Stamp> _colorStamps;
 
    // From VKS
    struct FramebufferAttachment
    {
        VkImage image;
        VkDeviceMemory memory;
        VkImageView view;
        VkFormat format;
        VkImageSubresourceRange subresourceRange;
        VkAttachmentDescription description;
 
        bool hasDepth()
        {
            std::vector<VkFormat> formats =
                {
                    VK_FORMAT_D16_UNORM,
                    VK_FORMAT_X8_D24_UNORM_PACK32,
                    VK_FORMAT_D32_SFLOAT,
                    VK_FORMAT_D16_UNORM_S8_UINT,
                    VK_FORMAT_D24_UNORM_S8_UINT,
                    VK_FORMAT_D32_SFLOAT_S8_UINT,
                };
            return std::find(formats.begin(), formats.end(), format) != std::end(formats);
        }
 
        bool hasStencil()
        {
            std::vector<VkFormat> formats =
                {
                    VK_FORMAT_S8_UINT,
                    VK_FORMAT_D16_UNORM_S8_UINT,
                    VK_FORMAT_D24_UNORM_S8_UINT,
                    VK_FORMAT_D32_SFLOAT_S8_UINT,
                };
            return std::find(formats.begin(), formats.end(), format) != std::end(formats);
        }
 
        bool isDepthStencil()
        {
            return(hasDepth() || hasStencil());
        }
 
    };
 
    // VKTODO: this can be removed in the future, it's redundant
    std::vector<FramebufferAttachment> attachments;
 
protected:
 
    virtual void update();
    //bool checkStatus(FramebufferStatus target) const;
    VkResult createFramebuffer();
    struct VKAttachmentCreateInfo
    {
        uint32_t width, height;
        uint32_t layerCount;
        VkFormat format;
        VkImageUsageFlags usage;
        VkSampleCountFlagBits imageSampleCount = VK_SAMPLE_COUNT_1_BIT;
    };
    uint32_t addAttachment(VKAttachmentCreateInfo createinfo, VKTexture *texture);
 
    // VKTODO: We need a check on backend.lock(), or to pass backend reference instead
    VKFramebuffer(const std::weak_ptr<vk::VKBackend>& backend, const Framebuffer& framebuffer) : VKObject(*backend.lock(), framebuffer) {}
    // VKTODO: Do we need virtual destructor here?
    ~VKFramebuffer() override;
 
};
 
} }
 
 
#endif