render_thread_window_state.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef RHI_RENDER_THREAD_WINDOW_STATE_H
#define RHI_RENDER_THREAD_WINDOW_STATE_H
 
#include <rhi/rhi_control_commands.h>
#include <rhi/rhi_handle.h>
#include <rhi/rhi_surface.h>
#include <rhi/frame_mailbox.h>
#include <rhi/frame_packet.h>
#include <rhi/rhi_static_margin.h>
#include <rhi/rhi_present_mode.h>
 
#include <chrono>
#include <cstdint>
#include <optional>
 
 
namespace KIGFX
{

struct WINDOW_STATE
{
    RHI_WINDOW_ID            windowId   = 0;
    RHI_NATIVE_WINDOW_HANDLE nativeHandle;
 
    RHI_SurfaceHandle   surface;
    RHI_SwapchainHandle swapchain;
 
    uint32_t width    = 0;
    uint32_t height   = 0;
    float    dpiScale = 1.0f;
 
    uint32_t backingWidth  = 0;
    uint32_t backingHeight = 0;

    uint32_t supersampleFactor = 1;
 
    uint32_t RenderWidth() const { return backingWidth * supersampleFactor; }
    uint32_t RenderHeight() const { return backingHeight * supersampleFactor; }
 
    RHI_FramebufferHandle staticFBO;
    RHI_FramebufferHandle dynamicFBO;

    uint32_t staticMargin = 0;

    RHI_FramebufferHandle staticTempFBO;

    RHI_FramebufferHandle staticViewFBO;
    bool                  staticInMargin = true;    
 
    RHI_FramebufferHandle ShownStaticFBO() const
    {
        return staticInMargin || !staticViewFBO ? staticFBO : staticViewFBO;
    }

    int32_t ShownStaticX() const
    {
        return staticInMargin ? ( static_cast<int32_t>( staticMargin ) - staticShift.x )
                                        * static_cast<int32_t>( supersampleFactor )
                              : 0;
    }
 
    int32_t ShownStaticY() const
    {
        return staticInMargin ? ( static_cast<int32_t>( staticMargin ) - staticShift.y )
                                        * static_cast<int32_t>( supersampleFactor )
                              : 0;
    }

    RHI_VIEW_SHIFT staticShift;

    RHI_VIEW_SHIFT overlayShift;
 
    uint32_t StaticWidth() const { return RenderWidth() + 2 * staticMargin * supersampleFactor; }
    uint32_t StaticHeight() const { return RenderHeight() + 2 * staticMargin * supersampleFactor; }
    RHI_FramebufferHandle tempFBO;

    RHI_FramebufferHandle diffBelowFBO;
    RHI_FramebufferHandle staticDiffBelowFBO;

    RHI_FramebufferHandle overlayGeometryFBO;
    bool                  overlayGeometryDrawn = false;

    RHI_FramebufferHandle overlayMarginFBO;
    bool                  overlayInMargin = false;

    bool dynamicGeometryDrawn = true;

    RHI_FramebufferHandle accumulationFBO;

    struct PASS_UNIFORMS
    {
        RHI_BufferHandle    frameUBO;
        RHI_BindGroupHandle frameBG;
        RHI_BufferHandle    gridUBO;
        RHI_BindGroupHandle gridBG;
    };

    struct FRAME_UNIFORMS
    {
        PASS_UNIFORMS       staticUniforms;
        PASS_UNIFORMS       dynamicUniforms;
        PASS_UNIFORMS       overlayUniforms;
        RHI_BufferHandle    cursorUBO;
        RHI_BindGroupHandle cursorBG;
    };

    static constexpr size_t UNIFORM_GENERATIONS = 3;
 
    FRAME_UNIFORMS uniformSets[UNIFORM_GENERATIONS];
    size_t         uniformGeneration = 0;
 
    FRAME_UNIFORMS& Uniforms() { return uniformSets[uniformGeneration]; }
 
    FRAME_DRAW_DESC drawDesc;

    FRAME_DRAW_DESC staticDrawDesc;
    FRAME_DRAW_DESC dynamicDrawDesc;
    bool            staticChanged  = true;
    bool            dynamicChanged = true;
 
    uint64_t staticEpoch  = 0;
    uint64_t dynamicEpoch = 0;

    struct RENDERED_CONTENT
    {
        bool           valid = false;
        uint64_t       epoch = 0;
        bool           drawGrid = false;
        FRAME_UBO_DATA frameUBO;
        GRID_UBO_DATA  gridUBO;
        uint32_t       margin = 0;      
    };
 
    RENDERED_CONTENT renderedStatic;
    RENDERED_CONTENT renderedDynamic;
    RENDERED_CONTENT renderedOverlay;   
 
    uint64_t staticPasses  = 0;     
    uint64_t geometryRenderPasses = 0;  
    uint64_t dynamicPasses = 0;     
 
    uint64_t requestedGeneration    = 0;
    uint64_t lastRenderedGeneration = 0;
 
    bool     needsStaticInvalidate = false;
    bool     active = false;
    bool     frameResultPending = false;
 
    uint64_t framesProcessed = 0;
 
    using Clock = std::chrono::steady_clock;
    Clock::time_point lastActivityTime;
    Clock::time_point lastFrameRequestTime;
    Clock::time_point lastRenderStartTime;
    Clock::time_point lastRenderCompleteTime;
    Clock::time_point lastPresentAttemptTime;
    Clock::time_point lastPresentSuccessTime;
    Clock::time_point lastPresentFailureTime;
    Clock::time_point nextPresentRetryAt;
    Clock::time_point lastSwapchainCreateAttemptTime;
    Clock::time_point lastLagLogTime;

    float             refreshHz = 0.0f;     
    Clock::time_point nextFrameAt;          
    uint64_t          drawnInputSerial = 0; 
 
    uint64_t          presentSuccessCount = 0;
    uint64_t          presentFailureCount = 0;
    uint32_t          consecutivePresentFailures = 0;
    uint64_t          swapchainCreateAttempts = 0;
    uint64_t          lastPresentedGeneration = 0;

    FRAME_MAILBOX* mailbox = nullptr;
};
 
 
} // namespace KIGFX
 
 
#endif // RHI_RENDER_THREAD_WINDOW_STATE_H