gl_context_mgr.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @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/>.
 */
 
#ifndef GL_CONTEXT_MANAGER_H
#define GL_CONTEXT_MANAGER_H
 
#include <kicad_gl/kiglad.h> // Must be included first
#include <wx/glcanvas.h>
 
#include <kicommon.h>
 
#include <mutex>
#include <map>
#include <set>
 
class KICOMMON_API GL_CONTEXT_MANAGER
{
public:
 
    GL_CONTEXT_MANAGER() : m_glCtx( nullptr ) {}

    wxGLContext* CreateCtx( wxGLCanvas* aCanvas, const wxGLContext* aOther = nullptr );

    void DestroyCtx( wxGLContext* aContext );

    void DeleteAll();

    bool LockCtx( wxGLContext* aContext, wxGLCanvas* aCanvas );

    void UnlockCtx( wxGLContext* aContext );

    wxGLContext* GetCurrentCtx() const
    {
        return m_glCtx;
    }

    wxGLCanvas* GetCurrentCanvas() const
    {
        auto it = m_glContexts.find( m_glCtx );
        return it != m_glContexts.end() ? it->second : nullptr;
    }

    bool IsLoseOnReset( const wxGLContext* aContext ) const
    {
        return m_loseOnResetContexts.count( aContext ) > 0;
    }

    template<typename Func, typename... Args>
    auto RunWithoutCtxLock( Func&& aFunction, Args&&... args )
    {
        wxGLContext* currentCtx = GetCurrentCtx();
        wxGLCanvas* currentCanvas = GetCurrentCanvas();
        UnlockCtx( currentCtx );
 
        if constexpr (std::is_void_v<decltype(aFunction(std::forward<Args>(args)...))>)
        {
            std::forward<Func>(aFunction)(std::forward<Args>(args)...);
            LockCtx( currentCtx, currentCanvas );
            return;
        }
        else
        {
            auto result = std::forward<Func>(aFunction)(std::forward<Args>(args)...);
            LockCtx( currentCtx, currentCanvas );
            return result;
        }
    }
 
private:
    std::map<wxGLContext*, wxGLCanvas*> m_glContexts;

    wxGLContext* m_glCtx;

    std::set<const wxGLContext*> m_loseOnResetContexts;

    std::mutex m_glCtxMutex;
};
 
#endif /* GL_CONTEXT_MANAGER_H */