CanvasVulkan.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_CANVAS_VULKAN_HPP
#define TGUI_CANVAS_VULKAN_HPP
 
#include <TGUI/Backend/Renderer/BackendRenderTarget.hpp>
#include <TGUI/Backend/Renderer/Vulkan/BackendTextureVulkan.hpp>
 
#include <TGUI/Widgets/CanvasBase.hpp>

 
namespace tgui
{
    class TGUI_API CanvasVulkan : public CanvasBase
    {
    public:
        using Ptr = std::shared_ptr<CanvasVulkan>;            
        using ConstPtr = std::shared_ptr<const CanvasVulkan>; 
 
        static constexpr char StaticWidgetType[] = "CanvasVulkan"; 

        explicit CanvasVulkan(const char* typeName = StaticWidgetType, bool initRenderer = true);

        CanvasVulkan(const CanvasVulkan& copy);

        CanvasVulkan(CanvasVulkan&& copy) = default;

        CanvasVulkan& operator=(const CanvasVulkan& right);

        CanvasVulkan& operator=(CanvasVulkan&& right) = default;

        [[nodiscard]] static CanvasVulkan::Ptr create(const Layout2d& size = {"100%", "100%"});

        [[nodiscard]] static CanvasVulkan::Ptr copy(const CanvasVulkan::ConstPtr& canvas);

        void setSize(const Layout2d& size) override;
        using Widget::setSize;

        void draw(BackendRenderTarget& target, RenderStates states) const override;

        [[nodiscard]] VkImage getImage() const
        {
            return m_backendTexture->getInternalImage();
        }

        [[nodiscard]] VkImageView getImageView() const
        {
            return m_backendTexture->getInternalImageView();
        }

 
    protected:
        // Makes a copy of the widget
        [[nodiscard]] Widget::Ptr clone() const override;

 
    protected:
        Vector2u m_textureSize;
        std::shared_ptr<BackendTextureVulkan> m_backendTexture;
    };
} // namespace tgui
 
#endif // TGUI_CANVAS_VULKAN_HPP