Crafter.Graphics/interfaces/Crafter.Graphics-WindowWaylandVulkan.cppm

/*
Crafter®.Graphics
Copyright (C) 2025 Catcrafts®
Catcrafts.net

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 3.0 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
*/

module;

#include <vulkan/vulkan.h>
#include <vulkan/vulkan_wayland.h>

export module Crafter.Graphics:WindowWaylandVulkan;
import std;
import Crafter.Event;
import :WindowWayland;

namespace Crafter {
    struct DepthStencil {
        VkImage image;
        VkDeviceMemory memory;
        VkImageView view;
    };

    struct Semaphores {
		// Swap chain image presentation
		VkSemaphore presentComplete;
		// Command buffer submission and execution
		VkSemaphore renderComplete;
	};

    /**
    * @class WindowWaylandVulkan
    * @brief A Wayland window specialized for Vulkan rendering.
    * 
    * This class extends the WindowWayland base class to support Vulkan graphics
    * integration within a Wayland environment. It provides methods for initializing
    * Vulkan command buffers and managing drawing operations either synchronously or asynchronously.
    * 
    * The class exposes an event `onDraw` which is called for every frame.
    * @pre VulkanDevice::CreateDevice() must be called before creating or using this class.
    */
    export class WindowWaylandVulkan : public WindowWayland {
        public:
        Event<VkCommandBuffer> onDraw;
        /**
        * @brief Constructs a WindowWaylandVulkan instance.
        * 
        * @param name The title of the window.
        * @param width The width of the window in pixels.
        * @param height The height of the window in pixels.
        */
        WindowWaylandVulkan(std::string name, std::uint32_t width, std::uint32_t height);
        /**
        * @brief Destructor for the WindowWaylandVulkan.
        * 
        * Cleans up Vulkan and Wayland resources associated with this window.
        */
        ~WindowWaylandVulkan();
        /**
        * @brief Starts Vulkan initialization and returns a command buffer.
        * 
        * This command buffer can be used to record Vulkan setup commands.
        * 
        * @return VkCommandBuffer A Vulkan command buffer for recording initialization commands.
        */
        VkCommandBuffer StartInit();
        /**
        * @brief Completes Vulkan initialization.
        * 
        * Finalizes any remaining setup required after recording commands returned by StartInit().
        */
        void FinishInit();
        /**
        * @brief Starts the event loop asynchronously.
        * 
        * This method triggers rendering without blocking the caller.
        */
        void StartAsync();
        /**
        * @brief Starts the  event loop synchronously.
        * 
        * This method blocks the caller until the event loop stops.
        */
        void StartSync();
        private:
        void CreateSwapchain();
        VkSurfaceKHR vulkanSurface = VK_NULL_HANDLE;
        VkSwapchainKHR swapChain = VK_NULL_HANDLE;
        VkFormat colorFormat;
        VkColorSpaceKHR colorSpace;
        std::vector<VkImage> images;
        std::vector<VkImageView> imageViews;
        std::thread thread;
        std::vector<VkCommandBuffer> drawCmdBuffers;
        std::vector<VkFramebuffer> frameBuffers;
        VkSubmitInfo submitInfo;
        DepthStencil depthStencil;
        Semaphores semaphores;
        uint32_t currentBuffer = 0;
        VkPipelineStageFlags submitPipelineStages = VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT;
        VkRenderPass renderPass = VK_NULL_HANDLE;
    };
}