BackendTextureVulkan.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2026 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef TGUI_BACKEND_TEXTURE_VULKAN_HPP
#define TGUI_BACKEND_TEXTURE_VULKAN_HPP
 
#include <TGUI/Backend/Renderer/BackendTexture.hpp>
 
#include <vulkan/vulkan.h>

 
namespace tgui
{
    class BackendRendererVulkan;

    class TGUI_API BackendTextureVulkan : public BackendTexture
    {
    public:
        struct ImageResources
        {
            ImageResources(std::shared_ptr<BackendRendererVulkan> renderer);
            ~ImageResources();
 
            ImageResources(const ImageResources&) = delete;
            ImageResources& operator=(const ImageResources&) = delete;
 
            std::shared_ptr<BackendRendererVulkan> renderer;
            VkImage image = VK_NULL_HANDLE;
            VkDeviceMemory memory = VK_NULL_HANDLE;
            VkImageView imageView = VK_NULL_HANDLE;
            VkDescriptorSet descriptorSet = VK_NULL_HANDLE;
            VkDescriptorPool descriptorPool = VK_NULL_HANDLE;
            std::uint64_t uploadId = 0; // Last upload to the image, the destructor waits for it to finish
        };

        BackendTextureVulkan(std::shared_ptr<BackendRendererVulkan> renderer, VkImageUsageFlags additionalUsageFlags = 0);

        bool loadTextureOnly(Vector2u size, const std::uint8_t* pixels, bool smooth) override;

        [[nodiscard]] VkImage getInternalImage() const;

        [[nodiscard]] VkImageView getInternalImageView() const;

        [[nodiscard]] const std::shared_ptr<ImageResources>& getImageResources() const
        {
            return m_imageResources;
        }

 
    protected:
        // Creates the image, its memory, the image view and the descriptor set
        [[nodiscard]] std::shared_ptr<ImageResources> createImageResources(Vector2u size) const;

 
    protected:
        std::shared_ptr<BackendRendererVulkan> m_renderer;
        VkImageUsageFlags m_usageFlags;
        std::shared_ptr<ImageResources> m_imageResources;
    };
} // namespace tgui
 
#endif // TGUI_BACKEND_TEXTURE_VULKAN_HPP