VulkanWindow.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* ngscopeclient                                                                                                        *
*                                                                                                                      *
* Copyright (c) 2012-2026 Andrew D. Zonenberg and contributors                                                         *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the       *
*      following disclaimer in the documentation and/or other materials provided with the distribution.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   *
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES        *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR       *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE       *
* POSSIBILITY OF SUCH DAMAGE.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/
 
#ifndef VulkanWindow_h
#define VulkanWindow_h
 
class Texture;
 
class VulkanWindow
{
public:
    VulkanWindow(const std::string& title, std::shared_ptr<QueueHandle> queue, bool noMaximize, bool noRestore);
    virtual ~VulkanWindow();
 
    GLFWwindow* GetWindow()
    { return m_window; }
 
    // Return a DPI 'scale' value where 1 ~= 96DPI
    // Akin to uses of `get_pango_context()->get_resolution() / 96` in glscopeclient
    float GetContentScale();
 
    virtual void Render();
 
    std::shared_ptr<QueueHandle> GetRenderQueue()
    { return m_renderQueue; }
 
    void AddTextureUsedThisFrame(std::shared_ptr<Texture> tex)
    { m_texturesUsedThisFrame[m_frameIndex].emplace(tex); }
 
    bool IsFullscreen()
    { return m_fullscreen; }
 
    void SaveWindowPositionAndSize();
 
protected:
    bool UpdateFramebuffer();
    void SetFullscreen(bool fullscreen);
    GLFWmonitor* GetCurrentMonitor();
    bool IsPositionValid(
        const std::string& monitorName,
        int monitorWidth,
        int monitorHeight,
        int windowXPos,
        int windowYPos);
 
    virtual void DoRender(vk::raii::CommandBuffer& cmdBuf);
    virtual void RenderUI();
 
    GLFWwindow* m_window;
 
    ImGuiContext* m_context;
 
    std::shared_ptr<vk::raii::SurfaceKHR> m_surface;
 
    std::shared_ptr<vk::raii::DescriptorPool> m_imguiDescriptorPool;
 
    std::shared_ptr<QueueHandle> m_renderQueue;
 
    bool m_resizeEventPending;
 
    bool m_softwareResizeRequested;
 
    int m_pendingWidth;
 
    int m_pendingHeight;
 
    std::unique_ptr<vk::raii::CommandPool> m_cmdPool;
 
    std::vector<std::unique_ptr<vk::raii::CommandBuffer> > m_cmdBuffers;
 
    std::vector<std::unique_ptr<vk::raii::Semaphore> > m_imageAcquiredSemaphores;
 
    std::vector<std::unique_ptr<vk::raii::Semaphore> > m_renderCompleteSemaphores;
 
    uint32_t m_semaphoreIndex;
 
    uint32_t m_frameIndex;
 
    uint32_t m_lastFrameIndex;
 
    std::vector<std::unique_ptr<vk::raii::Fence> > m_fences;
 
    std::vector<std::unique_ptr<vk::raii::ImageView> > m_backBufferViews;
 
    std::vector<std::unique_ptr<vk::raii::Framebuffer> > m_framebuffers;
 
    std::unique_ptr<vk::raii::RenderPass> m_renderPass;
 
    std::unique_ptr<vk::raii::SwapchainKHR> m_swapchain;
 
    #if VK_HEADER_VERSION >= 229
        std::vector<vk::Image> m_backBuffers;
    #else
        std::vector<VkImage> m_backBuffers;
    #endif
 
    int m_minImageCount;
 
    int m_width;
 
    int m_height;
 
    bool m_fullscreen;
 
    bool m_restore;
 
    bool m_forceDPIScaling;
 
    float m_forcedFontScale = 1.0f;
 
    float m_forcedUIScale = 1.0f;
 
    int m_windowedX;
 
    int m_windowedY;
 
    int m_windowedWidth;
 
    int m_windowedHeight;
 
    std::vector< std::set<std::shared_ptr<Texture> > > m_texturesUsedThisFrame;
 
    std::string m_title;
};
 
#endif