draw_panel_gal.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013-2017 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Tomasz Wlostowski <[email protected]>
 * @author Maciej Suminski <[email protected]>
 *
 * 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 2
 * 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 <https://www.gnu.org/licenses/>.
 */
#include <eda_draw_frame.h>
#include <kiface_base.h>
#include <macros.h>
#include <scoped_set_reset.h>
#include <settings/app_settings.h>
#include <trace_helpers.h>
 
#include <class_draw_panel_gal.h>
#include <view/view.h>
#include <view/wx_view_controls.h>
#include <gal/painter.h>
#include <base_screen.h>
#include <gal/cursors.h>
#include <gal/graphics_abstraction_layer.h>
#include <gal/opengl/opengl_gal.h>
#include <gal/opengl/gpu_oom_error.h>
#include <gal/cairo/cairo_gal.h>
#include <math/vector2wx.h>
 
 
#include <tool/tool_dispatcher.h>
#include <tool/tool_manager.h>
 
#include <widgets/wx_infobar.h>
 
#include <kiplatform/touchpad.h>
#include <kiplatform/ui.h>
 
#include <stdexcept>
 
#include <core/profile.h>
 
#include <wx/display.h>
 
#include <pgm_base.h>
#include <confirm.h>
 

static const wxChar traceDrawPanel[] = wxT( "KICAD_DRAW_PANEL" );
 
 
EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId,
                                        const wxPoint& aPosition, const wxSize& aSize,
                                        KIGFX::GAL_DISPLAY_OPTIONS& aOptions, GAL_TYPE aGalType ) :
        wxScrolledCanvas( aParentWindow, aWindowId, aPosition, aSize ),
        m_MouseCapturedLost( false ),
        m_parent( aParentWindow ),
        m_edaFrame( nullptr ),
        m_drawing( false ),
        m_drawingEnabled( false ),
        m_needIdleRefresh( false ),
        m_gal( nullptr ),
        m_view( nullptr ),
        m_painter( nullptr ),
        m_viewControls( nullptr ),
        m_backend( GAL_TYPE_NONE ),
        m_options( aOptions ),
        m_eventDispatcher( nullptr ),
        m_lostFocus( false ),
        m_glRecoveryAttempted( false ),
        m_contextBindFailures( 0 ),
        m_rebuiltAfterReset( false ),
        m_pendingResize( false ),
        m_stealsFocus( true ),
        m_statusPopup( nullptr )
{
#ifdef _WIN32
    // need to fix broken cairo rendering on Windows with wx 3.3
    SetDoubleBuffered( false );
#endif
    m_PaintEventCounter = std::make_unique<PROF_COUNTER>( "Draw panel paint events" );
 
    if( Pgm().GetCommonSettings()->m_Appearance.show_scrollbars )
        ShowScrollbars( wxSHOW_SB_ALWAYS, wxSHOW_SB_ALWAYS );
    else
        ShowScrollbars( wxSHOW_SB_NEVER, wxSHOW_SB_NEVER );
 
    SetLayoutDirection( wxLayout_LeftToRight );
 
    m_edaFrame = dynamic_cast<EDA_DRAW_FRAME*>( m_parent );
 
    // If we're in a dialog, we have to go looking for our parent frame
    if( !m_edaFrame )
    {
        wxWindow* ancestor = aParentWindow->GetParent();
 
        while( ancestor && !dynamic_cast<EDA_DRAW_FRAME*>( ancestor ) )
            ancestor = ancestor->GetParent();
 
        if( ancestor )
            m_edaFrame = dynamic_cast<EDA_DRAW_FRAME*>( ancestor );
    }
 
    SwitchBackend( aGalType );
    SetBackgroundStyle( wxBG_STYLE_CUSTOM );
 
    EnableScrolling( false, false ); // otherwise Zoom Auto disables GAL canvas
    KIPLATFORM::UI::SetOverlayScrolling( this, false ); // Prevent excessive repaint on GTK
    KIPLATFORM::UI::ImmControl( this, false ); // Ensure our panel can't suck in IME events
 
    Connect( wxEVT_SIZE, wxSizeEventHandler( EDA_DRAW_PANEL_GAL::onSize ), nullptr, this );
    Connect( wxEVT_ENTER_WINDOW, wxMouseEventHandler( EDA_DRAW_PANEL_GAL::onEnter ), nullptr, this );
    Connect( wxEVT_KILL_FOCUS, wxFocusEventHandler( EDA_DRAW_PANEL_GAL::onLostFocus ), nullptr, this );
 
    const wxEventType events[] = {
        // Binding both EVT_CHAR and EVT_CHAR_HOOK ensures that all key events,
        // especially special key like arrow keys, are handled by the GAL event dispatcher,
        // and not sent to GUI without filtering, because they have a default action (scroll)
        // that must not be called.
        wxEVT_LEFT_UP,
        wxEVT_LEFT_DOWN,
        wxEVT_LEFT_DCLICK,
        wxEVT_RIGHT_UP,
        wxEVT_RIGHT_DOWN,
        wxEVT_RIGHT_DCLICK,
        wxEVT_MIDDLE_UP,
        wxEVT_MIDDLE_DOWN,
        wxEVT_MIDDLE_DCLICK,
        wxEVT_AUX1_UP,
        wxEVT_AUX1_DOWN,
        wxEVT_AUX1_DCLICK,
        wxEVT_AUX2_UP,
        wxEVT_AUX2_DOWN,
        wxEVT_AUX2_DCLICK,
        wxEVT_MOTION,
        wxEVT_MOUSEWHEEL,
        wxEVT_CHAR,
        wxEVT_CHAR_HOOK,
        wxEVT_MAGNIFY,
        KIGFX::WX_VIEW_CONTROLS::EVT_REFRESH_MOUSE
    };
 
    for( wxEventType eventType : events )
        Connect( eventType, wxEventHandler( EDA_DRAW_PANEL_GAL::OnEvent ), nullptr, m_eventDispatcher );
 
    // Set up timer to detect when drawing starts
    m_refreshTimer.SetOwner( this );
    Connect( m_refreshTimer.GetId(), wxEVT_TIMER, wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onRefreshTimer ),
             nullptr, this );
 
    Connect( wxEVT_SHOW, wxShowEventHandler( EDA_DRAW_PANEL_GAL::onShowEvent ), nullptr, this );
}
 
 
EDA_DRAW_PANEL_GAL::~EDA_DRAW_PANEL_GAL()
{
    m_touchpadGestureHandler.reset();
 
    // Ensure EDA_DRAW_PANEL_GAL::onShowEvent is not fired during Dtor process
    Disconnect( wxEVT_SHOW, wxShowEventHandler( EDA_DRAW_PANEL_GAL::onShowEvent ) );
    StopDrawing();
 
    wxASSERT( !m_drawing );
 
    delete m_viewControls;
    delete m_view;
    delete m_gal;
    m_gal = nullptr;    // Ensure OnShow is not called
}
 
 
void EDA_DRAW_PANEL_GAL::SetFocus()
{
    KIPLATFORM::UI::ImeNotifyCancelComposition( this );
    wxScrolledCanvas::SetFocus();
    m_lostFocus = false;
}
 
 
void EDA_DRAW_PANEL_GAL::onPaint( wxPaintEvent& WXUNUSED( aEvent ) )
{
    DoRePaint( false );
}
 
 
bool EDA_DRAW_PANEL_GAL::recoverFromGalError( const std::exception& aError )
{
    // A predicted GPU out-of-memory cannot be cured by reinitializing OpenGL; it would just
    // hit the same VRAM ceiling. Skip straight to the software fallback.
    const bool gpuOutOfMemory = dynamic_cast<const KIGFX::GPU_OOM_ERROR*>( &aError ) != nullptr;
 
    try
    {
        // Reset detection only runs inside LockContext, and this frame's lock came before the reset
        if( m_gal && !m_gal->IsContextLocked() )
            KIGFX::GAL_CONTEXT_LOCKER probe( m_gal );
 
        // A reset seen mid-frame surfaces as a GL error; rebuild rather than spend the one-shot recovery
        if( handleContextLoss() )
            return true;
 
        // Sleep/wake and GPU resets can invalidate the entire GL context.
        // Try a full reinit of the current backend before falling back.
        if( !gpuOutOfMemory && !m_glRecoveryAttempted )
        {
            m_glRecoveryAttempted = true;
            GAL_TYPE prevBackend = m_backend;
            m_backend = GAL_TYPE_NONE;
 
            if( SwitchBackend( prevBackend ) )
            {
                StartDrawing();
                return true;
            }
        }
 
        if( GAL_FALLBACK_AVAILABLE && GAL_FALLBACK != m_backend )
        {
            m_glRecoveryAttempted = false;
            SwitchBackend( GAL_FALLBACK );
 
            if( m_rebuiltAfterReset )
            {
                // Some drivers refuse new framebuffers to a process for the rest of its life after a reset
                m_rebuiltAfterReset = false;
                EDA_DRAW_FRAME::SetOpenGLFailureOccurred();
                showMessageLater( _( "The graphics driver was reset and OpenGL could not be restored" ),
                                  _( "Restart KiCad to use accelerated graphics again." ), false );
            }
            else
            {
                showMessageLater( _( "Could not use OpenGL, falling back to software rendering" ),
                                  wxString( aError.what() ), false );
            }
 
            StartDrawing();
            return true;
        }
 
        showMessageLater( _( "Graphics error" ), wxString( aError.what() ), true );
    }
    catch( std::exception& recoveryErr )
    {
        showMessageLater( _( "Graphics error during recovery" ), wxString( recoveryErr.what() ), true );
    }
    catch( ... )
    {
        showMessageLater( _( "Graphics error during recovery" ), _( "Unknown exception during backend switch" ),
                          true );
    }
 
    return false;
}
 
 
bool EDA_DRAW_PANEL_GAL::handleContextLoss()
{
    KIGFX::GAL_CONTEXT_LOSS loss = m_gal ? m_gal->GetContextLoss() : KIGFX::GAL_CONTEXT_LOSS::NONE;
 
    if( loss == KIGFX::GAL_CONTEXT_LOSS::NONE )
        return false;
 
    // Deleting a GAL that someone still holds locked would leave them unlocking freed memory
    if( m_gal->IsContextLocked() )
        return true;
 
    // Hidden canvases rebuild when next shown, since a new GAL cannot initialize off screen
    if( !IsShownOnScreen() )
        return true;
 
    // Rebuilding while the driver is still resetting can fail or hang, so poll until it finishes
    if( !m_gal->IsResetSettled() )
    {
        m_refreshTimer.StartOnce( 20 );
        return true;
    }
 
    wxLogTrace( traceGalContext, wxS( "Rebuilding canvas %p after GPU reset, repeated %d" ), this,
                loss == KIGFX::GAL_CONTEXT_LOSS::REPEATED ? 1 : 0 );
 
    bool rebuilt = false;
 
    if( loss == KIGFX::GAL_CONTEXT_LOSS::RECOVERABLE || !GAL_FALLBACK_AVAILABLE )
    {
        GAL_TYPE backend = m_backend;
 
        // Forces SwitchBackend to build a new GAL of the same type
        m_backend = GAL_TYPE_NONE;
        rebuilt = SwitchBackend( backend );
        m_rebuiltAfterReset = rebuilt;
    }
 
    // SwitchBackend already reported a failed rebuild, so only a repeated loss needs the notice
    if( !rebuilt && GAL_FALLBACK_AVAILABLE )
    {
        static bool s_notified = false;
 
        wxLogTrace( traceGalContext, wxS( "Canvas %p falling back to software rendering" ), this );
        EDA_DRAW_FRAME::SetOpenGLFailureOccurred();
        SwitchBackend( GAL_FALLBACK );
 
        if( loss == KIGFX::GAL_CONTEXT_LOSS::REPEATED && !s_notified )
        {
            s_notified = true;
            showMessageLater( _( "The graphics driver keeps resetting, falling back to software rendering" ),
                              wxEmptyString, false );
        }
    }
 
    StartDrawing();
    return true;
}
 
 
void EDA_DRAW_PANEL_GAL::showMessageLater( const wxString& aTitle, const wxString& aDetail, bool aError )
{
    wxWindow* parent = m_parent;
 
    CallAfter(
            [parent, aTitle, aDetail, aError]()
            {
                if( aError )
                    DisplayErrorMessage( parent, aTitle, aDetail );
                else
                    DisplayInfoMessage( parent, aTitle, aDetail );
            } );
}
 

static constexpr int MAX_CONTEXT_BIND_RETRIES = 2;
 
 
bool EDA_DRAW_PANEL_GAL::DoRePaint( bool aAllowSkip )
{
    if( !m_refreshMutex.try_lock() )
        return false;
 
    std::lock_guard<std::mutex> lock( m_refreshMutex, std::adopt_lock );
 
    if( !m_drawingEnabled )
        return false;
 
    if( handleContextLoss() )
        return false;
 
    if( !m_gal->IsInitialized() || !m_gal->IsVisible() || m_gal->IsContextLocked() )
        return false;
 
    if( m_drawing )
        return false;
 
    // The context may have become current since the size change was deferred
    if( m_pendingResize )
        ResizeGal();
 
    m_lastRepaintStart = std::chrono::steady_clock::now();
 
    // Repaint the canvas, and fix scrollbar cursors
    // Usually called by a OnPaint event, but because it does not use a wxPaintDC,
    // it can be called outside a wxPaintEvent.
 
    // Update current zoom settings if the canvas is managed by a EDA frame
    // (i.e. not by a preview panel in a dialog)
    if( !IsDialogPreview() && GetParentEDAFrame() && GetParentEDAFrame()->GetScreen() )
        GetParentEDAFrame()->GetScreen()->m_ScrollCenter = GetView()->GetCenter();
 
    if( Pgm().GetCommonSettings()->m_Appearance.show_scrollbars )
        m_viewControls->UpdateScrollbars();
 
#ifdef KICAD_GAL_PROFILE
    latencyProbeZoomToRender.Checkpoint("do-repaint-start");
#endif
 
    SCOPED_SET_RESET<bool> drawing( m_drawing, true );
 
    ( *m_PaintEventCounter )++;
 
    wxASSERT( m_painter );
 
    KIGFX::RENDER_SETTINGS* settings =
            static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
 
    PROF_TIMER cntUpd("view-upd-items", false);
    PROF_TIMER cntTotal("view-total", false);
    PROF_TIMER cntCtx("view-context-create", false);
    PROF_TIMER cntCtxDestroy("view-context-destroy", false);
    PROF_TIMER cntRedraw("view-redraw-rects", false);
 
    bool isDirty = false;
 
    cntTotal.Start();
 
    try
    {
        VECTOR2D cursorPos = m_viewControls->GetCursorPosition();
        bool viewDirty = m_view->IsDirty();
        bool cursorMoved = ( cursorPos != m_lastCursorPosition );
        bool hasPendingItemUpdates = m_view->HasPendingItemUpdates();
 
        // Skip all update work when nothing has changed since the previous frame.
        // Never skip when responding to a native paint event or explicit ForceRefresh
        // because the window content may have been invalidated by the OS.
        if( aAllowSkip && !viewDirty && !cursorMoved && !hasPendingItemUpdates )
        {
            m_lastRepaintEnd = std::chrono::steady_clock::now();
            return true;
        }
 
        if( hasPendingItemUpdates )
        {
            cntUpd.Start();
 
            try
            {
                m_view->UpdateItems();
            }
            catch( std::out_of_range& err )
            {
                // Don't do anything here but don't fail
                // This can happen when we don't catch `at()` calls
                wxLogTrace( traceDrawPanel, wxS( "Out of Range error: %s" ), err.what() );
            }
            catch( std::runtime_error& err )
            {
                // Handle GL errors (e.g. glMapBuffer failure) that surface during UpdateItems().
                // These can occur on macOS under memory pressure when embedding large 3D models.
                // Log and continue so the outer handler can decide whether to switch backends.
                wxLogTrace( traceDrawPanel, wxS( "Runtime error during UpdateItems: %s" ),
                            err.what() );
                throw;
            }
 
            cntUpd.Stop();
            viewDirty = m_view->IsDirty();
        }
 
        // After processing item updates, skip the GL cycle when neither the
        // view targets nor the cursor position have changed.
        if( aAllowSkip && !viewDirty && !cursorMoved )
        {
            m_lastRepaintEnd = std::chrono::steady_clock::now();
            return true;
        }
 
        m_lastCursorPosition = cursorPos;
 
        // GAL_DRAWING_CONTEXT can throw in the dtor, so we need to scope
        // the full lifetime inside the try block
        {
            cntCtx.Start();
            KIGFX::GAL_DRAWING_CONTEXT ctx( m_gal );
            cntCtx.Stop();
 
            if( !ctx.IsDrawing() )
            {
                // A canvas being torn down never reaches here; DoRePaint returns above once
                // the window stops being visible.  So repeated failures mean a live canvas
                // whose context is gone for good, and retrying forever would leave it blank
                if( ++m_contextBindFailures > MAX_CONTEXT_BIND_RETRIES )
                    throw std::runtime_error( "Could not make the OpenGL context current" );
 
                RequestRefresh();
                return false;
            }
 
            if( m_view->IsTargetDirty( KIGFX::TARGET_OVERLAY )
                && !m_gal->HasTarget( KIGFX::TARGET_OVERLAY ) )
            {
                m_view->MarkDirty();
            }
 
            m_gal->SetClearColor( settings->GetBackgroundColor() );
            m_gal->SetGridColor( settings->GetGridColor() );
            m_gal->SetCursorColor( settings->GetCursorColor() );
 
            // OpenGL double-buffering leaves the back buffer undefined after
            // SwapBuffers, so a full clear is always required before compositing.
            // Cairo only needs to clear when NONCACHED content changed.
            if( m_backend == GAL_TYPE_OPENGL )
                m_gal->ClearScreen();
 
            if( m_view->IsDirty() )
            {
                if( m_backend != GAL_TYPE_OPENGL  // Already called in opengl
                        && m_view->IsTargetDirty( KIGFX::TARGET_NONCACHED ) )
                {
                    m_gal->ClearScreen();
                }
 
                m_view->ClearTargets();
 
                // Grid has to be redrawn only when the NONCACHED target is redrawn
                if( m_view->IsTargetDirty( KIGFX::TARGET_NONCACHED ) )
                {
                    prepareGridSources();
                    m_gal->DrawGrid();
                }
 
                cntRedraw.Start();
                m_view->Redraw();
                cntRedraw.Stop();
                isDirty = true;
            }
 
            m_gal->DrawCursor( cursorPos );
 
        #ifdef KICAD_GAL_PROFILE
        latencyProbeZoomToRender.Checkpoint("do-repaint-pre-ctx-destroy");
        #endif
 
 
            cntCtxDestroy.Start();
        }
 
        // ctx goes out of scope here so destructor would be called
        cntCtxDestroy.Stop();
 
#ifdef KICAD_GAL_PROFILE
        latencyProbeZoomToRender.Checkpoint("do-repaint-ctx-done");
#endif
 
        // OpenGL frame completed successfully, allow future recovery attempts
        m_glRecoveryAttempted = false;
        m_contextBindFailures = 0;
        m_rebuiltAfterReset = false;
    }
    catch( std::exception& err )
    {
        wxLogTrace( traceDrawPanel, wxS( "DoRePaint exception: %s" ), err.what() );
 
        if( recoverFromGalError( err ) )
            return true;
 
        StopDrawing();
    }
    catch( ... )
    {
        showMessageLater( _( "Graphics error" ), _( "Unknown exception" ), true );
        StopDrawing();
    }
 
    if( isDirty )
    {
#ifdef KICAD_GAL_PROFILE
        wxLogTrace( traceGalProfile, "View timing: %s %s %s %s %s",
            cntTotal.to_string(),
            cntUpd.to_string(),
            cntRedraw.to_string(),
            cntCtx.to_string(),
            cntCtxDestroy.to_string()
        );
#endif
    }
 
    m_lastRepaintEnd = std::chrono::steady_clock::now();
 
#ifdef KICAD_GAL_PROFILE
    wxLogTrace( traceGalProfile, "%s", latencyProbeZoomToRender.to_string() );
    latencyProbeRepaintToMotion.Reset();
    latencyProbeRepaintToMotion.Checkpoint("repaint-done");
#endif    
 
    return true;
}
 
 
void EDA_DRAW_PANEL_GAL::onSize( wxSizeEvent& aEvent )
{
    ResizeGal();
}
 
 
void EDA_DRAW_PANEL_GAL::ResizeGal( bool aForce )
{
    // If we get a second wx update call before the first finishes, don't crash
    if( m_gal->IsContextLocked() )
        return;
 
    KIGFX::GAL_CONTEXT_LOCKER locker( m_gal );
 
    // Resizing reallocates the framebuffer, which only exists in this canvas' own context
    if( !m_gal->IsContextValid() )
    {
        // wx reports a given size once, so dropping it here would leave the canvas stuck at
        // whatever size the GAL was built with until something else resizes the window
        m_pendingResize = true;
        RequestRefresh();
        return;
    }
 
    m_pendingResize = false;
 
    wxSize clientSize = GetClientSize();
 
    if( !aForce && ToVECTOR2I( clientSize ) == m_gal->GetScreenPixelSize() )
        return;
 
    // Note: ( +1, +1 ) prevents an ugly black line on right and bottom on Mac
    clientSize.x = std::max( 10, clientSize.x + 1 );
    clientSize.y = std::max( 10, clientSize.y + 1 );
 
    m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
 
    if( m_view )
    {
        // ResizeScreen reallocates every compositor buffer, so nothing survives the resize
        m_view->MarkDirty();
    }
}
 
 
void EDA_DRAW_PANEL_GAL::UpdateOverlayExclusions()
{
    KIGFX::CAIRO_GAL* cairoGal = dynamic_cast<KIGFX::CAIRO_GAL*>( m_gal );
 
    // Only the Cairo backend presents frames outside the paint cycle
    if( !cairoGal )
        return;
 
    std::vector<wxRect> rects;
 
    for( wxWindow* child : GetChildren() )
    {
        if( dynamic_cast<WX_INFOBAR*>( child ) && child->IsShown() )
            rects.push_back( child->GetRect() );
    }
 
    cairoGal->SetOverlayExclusions( rects );
}
 
 
void EDA_DRAW_PANEL_GAL::RequestRefresh()
{
    m_needIdleRefresh = true;
}
 
 
void EDA_DRAW_PANEL_GAL::Refresh( bool aEraseBackground, const wxRect* aRect )
{
    auto now = std::chrono::steady_clock::now();
    auto delta = std::chrono::duration_cast<std::chrono::milliseconds>( now - m_lastRepaintStart ).count();
    bool galInitialized = m_gal && m_gal->IsInitialized();
 
    // When vsync is available the driver throttles SwapBuffers, so we only need
    // a small guard to avoid queueing work faster than the GPU can consume it.
    // Without vsync, cap the render rate at the monitor refresh rate so the
    // GPU is not saturated producing frames that will never be shown.
    int minPeriodMs = 3;
 
    if( galInitialized && m_gal->GetSwapInterval() == 0 )
    {
        // wxDisplay reports 0 on headless, some virtualized, and a few driver
        // combinations. Clamp to a plausible monitor range before trusting it
        // and fall back to 60 Hz otherwise.
        int refreshHz = 60;
        int reported = wxDisplay( this ).GetCurrentMode().refresh;
 
        if( reported >= 24 && reported <= 1000 )
            refreshHz = reported;
 
        refreshHz += 5; // Repaint slightly faster to avoid adding latency
 
        minPeriodMs = 1000 / refreshHz;
    }
 
    if( delta >= minPeriodMs )
    {
        if( !DoRePaint() )
            RequestRefresh();
    }
    else if( !m_refreshTimer.IsRunning() )
    {
        m_refreshTimer.StartOnce( static_cast<int>( minPeriodMs - delta ) );
    }
}
 
 
void EDA_DRAW_PANEL_GAL::ForceRefresh()
{
    if( !m_drawingEnabled )
    {
        if( m_gal && m_gal->IsInitialized() )
        {
            Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), nullptr, this );
            Connect( wxEVT_IDLE, wxIdleEventHandler( EDA_DRAW_PANEL_GAL::onIdle ), nullptr, this );
 
            m_drawingEnabled = true;
        }
        else
        {
            // Try again soon
            m_refreshTimer.StartOnce( 100 );
            return;
        }
    }
 
    DoRePaint( false );
}
 
 
bool EDA_DRAW_PANEL_GAL::GetScreenshot( wxImage& aDstImage )
{
    if( m_backend != GAL_TYPE_OPENGL || !m_gal )
        return false;
 
    DoRePaint( false );
 
    // The repaint may have replaced a GAL lost to a GPU reset
    if( m_backend != GAL_TYPE_OPENGL || !m_gal )
        return false;
 
    return static_cast<KIGFX::OPENGL_GAL*>( m_gal )->GetScreenshot( aDstImage );
}
 
 
void EDA_DRAW_PANEL_GAL::SetEventDispatcher( TOOL_DISPATCHER* aEventDispatcher )
{
    m_eventDispatcher = aEventDispatcher;
}
 
 
void EDA_DRAW_PANEL_GAL::StartDrawing()
{
    // Start querying GAL if it is ready
    m_refreshTimer.StartOnce( 100 );
}
 
 
void EDA_DRAW_PANEL_GAL::StopDrawing()
{
    m_refreshTimer.Stop();
    m_drawingEnabled = false;
 
    Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), nullptr, this );
    Disconnect( wxEVT_IDLE, wxIdleEventHandler( EDA_DRAW_PANEL_GAL::onIdle ), nullptr, this );
}
 
 
void EDA_DRAW_PANEL_GAL::SetHighContrastLayer( int aLayer )
{
    // Set display settings for high contrast mode
    KIGFX::RENDER_SETTINGS* rSettings = m_view->GetPainter()->GetSettings();
 
    SetTopLayer( aLayer );
 
    rSettings->ClearHighContrastLayers();
    rSettings->SetLayerIsHighContrast( aLayer );
 
    m_view->UpdateAllLayersColor();
}
 
 
void EDA_DRAW_PANEL_GAL::SetTopLayer( int aLayer )
{
    m_view->ClearTopLayers();
    m_view->SetTopLayer( aLayer );
    m_view->UpdateAllLayersOrder();
}
 
 
EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_PANEL_GAL::ResolveStoredCanvasType( int aStoredCanvasType )
{
    if( aStoredCanvasType == GAL_TYPE_CAIRO )
        return GAL_TYPE_CAIRO;
 
    // The retired wxDC canvas, and any value another KiCad version may have written, leave the
    // user with the accelerated canvas rather than the do-nothing stub GAL
    return GAL_TYPE_OPENGL;
}
 
 
bool EDA_DRAW_PANEL_GAL::SwitchBackend( GAL_TYPE aGalType )
{
    // Do not do anything if the currently used GAL is correct
    if( aGalType == m_backend && m_gal != nullptr )
        return true;
 
    VECTOR2D grid_size = m_gal ? m_gal->GetGridSize() : VECTOR2D();
    bool     grid_visibility = m_gal ? m_gal->GetGridVisibility() : true;
    bool     result = true; // assume everything will be fine
 
    // Prevent refreshing canvas during backend switch
    StopDrawing();
 
    m_contextBindFailures = 0;
    m_pendingResize = false;
 
    KIGFX::GAL* new_gal = nullptr;
 
    try
    {
        switch( aGalType )
        {
        case GAL_TYPE_OPENGL:
        {
            wxString errormsg = KIGFX::OPENGL_GAL::CheckFeatures( m_options );
 
            if( errormsg.empty() )
            {
                new_gal = new KIGFX::OPENGL_GAL( GetVcSettings(), m_options, this, this, this );
            }
            else
            {
                if( GAL_FALLBACK != aGalType )
                {
                    aGalType = GAL_FALLBACK;
                    showMessageLater( _( "Could not use OpenGL, falling back to software rendering" ), errormsg,
                                      false );
                    new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
                }
                else
                {
                    // We're well and truly banjaxed if we get here without a fallback.
                    showMessageLater( _( "Could not use OpenGL" ), errormsg, false );
                    new_gal = new KIGFX::GAL( m_options );
                    aGalType = GAL_TYPE_NONE;
                    result = false;
                }
            }
 
            break;
        }
 
        case GAL_TYPE_CAIRO:
            new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
            break;
 
        default:
            wxASSERT( false );
            KI_FALLTHROUGH;
            // warn about unhandled GAL canvas type, but continue with the fallback option
 
        case GAL_TYPE_NONE:
            // KIGFX::GAL is a stub - it actually does cannot display anything,
            // but prevents code relying on GAL canvas existence from crashing
            new_gal = new KIGFX::GAL( m_options );
            break;
        }
    }
    catch( std::runtime_error& err )
    {
        // A context the driver refuses to create would otherwise leave every frame on the blank stub
        if( aGalType == GAL_TYPE_OPENGL && GAL_FALLBACK_AVAILABLE )
        {
            try
            {
                new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
                aGalType = GAL_FALLBACK;
                EDA_DRAW_FRAME::SetOpenGLFailureOccurred();
                showMessageLater( _( "Could not use OpenGL, falling back to software rendering" ),
                                  wxString( err.what() ), false );
            }
            catch( std::runtime_error& )
            {
                new_gal = nullptr;
            }
        }
 
        if( !new_gal )
        {
            // Create a dummy GAL
            new_gal = new KIGFX::GAL( m_options );
            aGalType = GAL_TYPE_NONE;
            showMessageLater( _( "Error switching GAL backend" ), wxString( err.what() ), true );
            result = false;
        }
    }
 
    // trigger update of the gal options in case they differ from the defaults
    m_options.NotifyChanged();
 
    // The native touchpad hook is attached to the backend's child window.
    m_touchpadGestureHandler.reset();
 
    delete m_gal;
    m_gal = new_gal;
 
    wxSize clientSize = GetClientSize();
    clientSize.x = std::max( 10, clientSize.x );
    clientSize.y = std::max( 10, clientSize.y );
    m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
 
    if( grid_size.x > 0 && grid_size.y > 0 )
        m_gal->SetGridSize( grid_size );
 
    m_gal->SetGridVisibility( grid_visibility );
 
    // Make sure the cursor is set on the new canvas
    SetCurrentCursor( KICURSOR::ARROW );
 
    if( m_painter )
        m_painter->SetGAL( m_gal );
 
    if( m_view )
    {
        m_view->SetGAL( m_gal );
        // Note: OpenGL requires reverse draw order when draw priority is enabled
        m_view->ReverseDrawOrder( aGalType == GAL_TYPE_OPENGL );
    }
 
    m_backend = aGalType;
 
    // A shown backend window raises itself, which would bury an infobar overlaid on this canvas
    for( wxWindow* child : GetChildren() )
    {
        if( dynamic_cast<WX_INFOBAR*>( child ) )
            child->Raise();
    }
 
    UpdateOverlayExclusions();
 
    UpdateTouchpadGestureHandler();
 
    return result;
}
 
 
void EDA_DRAW_PANEL_GAL::UpdateTouchpadGestureHandler()
{
    m_touchpadGestureHandler.reset();
 
    if( Pgm().GetCommonSettings()->m_Input.touchpad_mode != TOUCHPAD_MODE::NATIVE_GESTURES )
        return;
 
    if( wxWindow* inputWindow = dynamic_cast<wxWindow*>( m_gal ) )
    {
        m_touchpadGestureHandler = KIPLATFORM::UI::CreateTouchpadGestureHandler(
                inputWindow,
                [this]( const KIPLATFORM::UI::TOUCHPAD_GESTURE& aGesture )
                {
                    if( !m_viewControls )
                        return;
 
                    m_viewControls->ApplyPanAndZoomGesture(
                            VECTOR2D( aGesture.panX, aGesture.panY ), aGesture.zoomFactor,
                            VECTOR2D( aGesture.zoomAnchor.x, aGesture.zoomAnchor.y ) );
                } );
    }
}
 
 
void EDA_DRAW_PANEL_GAL::OnEvent( wxEvent& aEvent )
{
    bool shouldSetFocus = m_lostFocus && m_stealsFocus
                          && !KIUI::IsInputControlFocused()                // Don't steal from input controls
                          && !KIUI::IsModalDialogFocused()                 // Don't steal from dialogs
                          && KIPLATFORM::UI::IsWindowActive( m_edaFrame ); // Don't steal from other windows
 
    if( shouldSetFocus )
        SetFocus();
 
    if( !m_eventDispatcher )
        aEvent.Skip();
    else
        m_eventDispatcher->DispatchWxEvent( aEvent );
 
    Refresh();
}
 
 
void EDA_DRAW_PANEL_GAL::onEnter( wxMouseEvent& aEvent )
{
    bool shouldSetFocus = m_stealsFocus
                          && !KIUI::IsInputControlFocused()                // Don't steal from input controls
                          && !KIUI::IsModalDialogFocused()                 // Don't steal from dialogs
                          && KIPLATFORM::UI::IsWindowActive( m_edaFrame ); // Don't steal from other windows
 
    // Getting focus is necessary in order to receive key events properly
    if( shouldSetFocus )
        SetFocus();
 
    aEvent.Skip();
}
 
 
void EDA_DRAW_PANEL_GAL::onLostFocus( wxFocusEvent& aEvent )
{
    m_lostFocus = true;
 
    m_viewControls->CancelDrag();
 
    // Reset the tool dispatcher's button state when focus is lost. This prevents
    // the dispatcher from thinking the button is still pressed when focus returns,
    // which can cause selection and drag operations to stop working.
    if( m_eventDispatcher )
        m_eventDispatcher->ResetState();
 
    aEvent.Skip();
}
 
 
void EDA_DRAW_PANEL_GAL::onIdle( wxIdleEvent& aEvent )
{
    if( m_needIdleRefresh )
    {
        m_needIdleRefresh = false;
        Refresh();
    }
 
    aEvent.Skip();
}
 
 
void EDA_DRAW_PANEL_GAL::onRefreshTimer( wxTimerEvent& aEvent )
{
    ForceRefresh();
}
 
 
void EDA_DRAW_PANEL_GAL::onShowEvent( wxShowEvent& aEvent )
{
    if( m_gal && m_gal->IsInitialized() && m_gal->IsVisible() )
    {
        OnShow();
    }
}
 
 
void EDA_DRAW_PANEL_GAL::SetCurrentCursor( KICURSOR aCursor )
{
    if( !m_gal )
        return;
 
    DPI_SCALING_COMMON dpi( nullptr, m_parent );
 
    bool hidpi = false;
 
    // Cursor scaling factor cannot be set for a wxCursor on GTK and OSX (at least before wx 3.3),
    // resulting in 4x rendered size on 2x window scale.
    // MSW renders the bitmap as-is, without scaling, so this works here.
#ifdef __WXMSW__
    hidpi = dpi.GetContentScaleFactor() >= 2.0;
#endif
 
    m_gal->SetNativeCursorStyle( aCursor, hidpi );
}
 
 
std::shared_ptr<KIGFX::VIEW_OVERLAY> EDA_DRAW_PANEL_GAL::DebugOverlay()
{
    if( !m_debugOverlay )
    {
        m_debugOverlay.reset( new KIGFX::VIEW_OVERLAY() );
        m_view->Add( m_debugOverlay.get() );
    }
 
    return m_debugOverlay;
}
 
 
void EDA_DRAW_PANEL_GAL::ClearDebugOverlay()
{
    if( m_debugOverlay )
    {
        m_view->Remove( m_debugOverlay.get() );
        m_debugOverlay = nullptr;
    }
}
 
 
KIGFX::VC_SETTINGS EDA_DRAW_PANEL_GAL::GetVcSettings()
{
    COMMON_SETTINGS* cfg = Pgm().GetCommonSettings();
 
    KIGFX::VC_SETTINGS vcSettings;
    vcSettings.m_warpCursor = cfg->m_Input.center_on_zoom;
    vcSettings.m_focusFollowSchPcb = cfg->m_Input.focus_follow_sch_pcb;
    vcSettings.m_autoPanSettingEnabled = cfg->m_Input.auto_pan;
    vcSettings.m_autoPanAcceleration = cfg->m_Input.auto_pan_acceleration;
    vcSettings.m_horizontalPan = cfg->m_Input.horizontal_pan;
    vcSettings.m_zoomAcceleration = cfg->m_Input.zoom_acceleration;
    vcSettings.m_zoomSpeed = cfg->m_Input.zoom_speed;
    vcSettings.m_zoomSpeedAuto = cfg->m_Input.zoom_speed_auto;
    vcSettings.m_scrollModifierZoom = cfg->m_Input.scroll_modifier_zoom;
    vcSettings.m_scrollModifierPanH = cfg->m_Input.scroll_modifier_pan_h;
    vcSettings.m_scrollModifierPanV = cfg->m_Input.scroll_modifier_pan_v;
    vcSettings.m_motionPanModifier = cfg->m_Input.motion_pan_modifier;
    vcSettings.m_dragLeft = cfg->m_Input.drag_left;
    vcSettings.m_dragMiddle = cfg->m_Input.drag_middle;
    vcSettings.m_dragRight = cfg->m_Input.drag_right;
    vcSettings.m_scrollReverseZoom = cfg->m_Input.reverse_scroll_zoom;
    vcSettings.m_scrollReversePanH = cfg->m_Input.reverse_scroll_pan_h;
 
    return vcSettings;
}