KiCad PCB EDA Suite
gl_context_mgr.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2016 CERN
5  * Copyright (C) 2020-2021 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * @author Maciej Suminski <[email protected]>
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, you may find one here:
21  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22  * or you may search the http://www.gnu.org website for the version 2 license,
23  * or you may write to the Free Software Foundation, Inc.,
24  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25  */
26 
27 #ifndef GL_CONTEXT_MANAGER_H
28 #define GL_CONTEXT_MANAGER_H
29 
30 #include <wx/glcanvas.h>
31 #include <mutex>
32 #include <map>
33 
35 {
36 public:
40  static GL_CONTEXT_MANAGER& Get();
41 
50  wxGLContext* CreateCtx( wxGLCanvas* aCanvas, const wxGLContext* aOther = nullptr );
51 
59  void DestroyCtx( wxGLContext* aContext );
60 
66  void DeleteAll();
67 
78  void LockCtx( wxGLContext* aContext, wxGLCanvas* aCanvas );
79 
86  void UnlockCtx( wxGLContext* aContext );
87 
88 private:
90  std::map<wxGLContext*, wxGLCanvas*> m_glContexts;
91 
93  wxGLContext* m_glCtx;
94 
96  std::mutex m_glCtxMutex;
97 
98  // Singleton
101  void operator=( const GL_CONTEXT_MANAGER& );
102 };
103 
104 #endif /* GL_CONTEXT_MANAGER_H */
105 
void operator=(const GL_CONTEXT_MANAGER &)
void DeleteAll()
Destroy all managed OpenGL contexts.
std::map< wxGLContext *, wxGLCanvas * > m_glContexts
< Map of GL contexts & their parent canvases.
wxGLContext * m_glCtx
Lock to prevent unexpected GL context switching.
void UnlockCtx(wxGLContext *aContext)
Allow other canvases to bind an OpenGL context.
static GL_CONTEXT_MANAGER & Get()
Return the GL_CONTEXT_MANAGER instance (singleton).
wxGLContext * CreateCtx(wxGLCanvas *aCanvas, const wxGLContext *aOther=nullptr)
Create a managed OpenGL context.
void LockCtx(wxGLContext *aContext, wxGLCanvas *aCanvas)
Set a context as current and prevents other canvases from switching it.
std::mutex m_glCtxMutex
void DestroyCtx(wxGLContext *aContext)
Destroy a managed OpenGL context.