#include <gl_context_mgr.h>

Public Member Functions
wxGLContext *	CreateCtx (wxGLCanvas aCanvas, const wxGLContext aOther=nullptr)
	Create a managed OpenGL context. More...

void	DestroyCtx (wxGLContext *aContext)
	Destroy a managed OpenGL context. More...

void	DeleteAll ()
	Destroy all managed OpenGL contexts. More...

void	LockCtx (wxGLContext aContext, wxGLCanvas aCanvas)
	Set a context as current and prevents other canvases from switching it. More...

void	UnlockCtx (wxGLContext *aContext)
	Allow other canvases to bind an OpenGL context. More...

Static Public Member Functions
static GL_CONTEXT_MANAGER &	Get ()
	Return the GL_CONTEXT_MANAGER instance (singleton). More...

Private Member Functions
	GL_CONTEXT_MANAGER ()

	GL_CONTEXT_MANAGER (const GL_CONTEXT_MANAGER &)

void	operator= (const GL_CONTEXT_MANAGER &)

Private Attributes
std::map< wxGLContext , wxGLCanvas >	m_glContexts
	< Map of GL contexts & their parent canvases. More...

wxGLContext *	m_glCtx
	Lock to prevent unexpected GL context switching. More...

std::mutex	m_glCtxMutex

Detailed Description

Definition at line 34 of file gl_context_mgr.h.

Constructor & Destructor Documentation

◆ GL_CONTEXT_MANAGER() [1/2]

GL_CONTEXT_MANAGER::GL_CONTEXT_MANAGER ( )

private

Definition at line 124 of file gl_context_mgr.cpp.

 : m_glCtx( nullptr )
{
}

◆ GL_CONTEXT_MANAGER() [2/2]

GL_CONTEXT_MANAGER::GL_CONTEXT_MANAGER ( const GL_CONTEXT_MANAGER & )

private

Member Function Documentation

◆ CreateCtx()

wxGLContext * GL_CONTEXT_MANAGER::CreateCtx	(	wxGLCanvas *	aCanvas,
		const wxGLContext *	aOther = `nullptr`
	)

Create a managed OpenGL context.

It is assured that the created context is freed upon exit. See wxGLContext documentation for the parameters description.

Returns: Created OpenGL context.

Definition at line 38 of file gl_context_mgr.cpp.

{
 wxGLContext* context = new wxGLContext( aCanvas, aOther );
 wxCHECK( context, nullptr );
 
#if wxCHECK_VERSION( 3, 1, 0 )
 if( !context->IsOK() )
 {
 delete context;
 return nullptr;
 }
#endif /* wxCHECK_VERSION( 3, 1, 0 ) */
 
 m_glContexts.insert( std::make_pair( context, aCanvas ) );
 
 return context;
}

References m_glContexts.

Referenced by EDA_3D_CANVAS::DoRePaint(), EDA_3D_MODEL_VIEWER::OnPaint(), and KIGFX::OPENGL_GAL::OPENGL_GAL().

◆ DeleteAll()

void GL_CONTEXT_MANAGER::DeleteAll ( )

Destroy all managed OpenGL contexts.

This method should be called in the final deinitialization routine.

Definition at line 75 of file gl_context_mgr.cpp.

{
 m_glCtxMutex.lock();
 
 for( auto& ctx : m_glContexts )
 delete ctx.first;
 
 m_glContexts.clear();
 m_glCtx = nullptr;
 m_glCtxMutex.unlock();
}

References m_glContexts, m_glCtx, and m_glCtxMutex.

◆ DestroyCtx()

void GL_CONTEXT_MANAGER::DestroyCtx ( wxGLContext * aContext )

Destroy a managed OpenGL context.

The context to be removed has to be created using GL_CONTEXT_MANAGER::CreateCtx() first.

Parameters

aContext is the OpenGL context to be destroyed. It will not be managed anymore.

Definition at line 57 of file gl_context_mgr.cpp.

{
 if( m_glContexts.count( aContext ) )
 {
 m_glContexts.erase( aContext );
 delete aContext;
 }
 else
 {
 // Do not delete unknown GL contexts
 wxFAIL;
 }
 
 if( m_glCtx == aContext )
 m_glCtx = nullptr;
}

References m_glContexts, and m_glCtx.

Referenced by EDA_3D_CANVAS::releaseOpenGL(), EDA_3D_MODEL_VIEWER::~EDA_3D_MODEL_VIEWER(), and KIGFX::OPENGL_GAL::~OPENGL_GAL().

◆ Get()

GL_CONTEXT_MANAGER & GL_CONTEXT_MANAGER::Get ( )

static

Return the GL_CONTEXT_MANAGER instance (singleton).

Definition at line 30 of file gl_context_mgr.cpp.

{
 static GL_CONTEXT_MANAGER instance;
 
 return instance;
}

Referenced by EDA_3D_CANVAS::DoRePaint(), KIGFX::OPENGL_GAL::LockContext(), EDA_3D_MODEL_VIEWER::OnPaint(), KIGFX::OPENGL_GAL::OPENGL_GAL(), EDA_3D_CANVAS::releaseOpenGL(), KIGFX::OPENGL_GAL::UnlockContext(), EDA_3D_MODEL_VIEWER::~EDA_3D_MODEL_VIEWER(), and KIGFX::OPENGL_GAL::~OPENGL_GAL().

◆ LockCtx()

void GL_CONTEXT_MANAGER::LockCtx	(	wxGLContext *	aContext,
		wxGLCanvas *	aCanvas
	)

Set a context as current and prevents other canvases from switching it.

Requires calling UnlockCtx() when there are no more GL calls for the context. If another canvas has already locked a GL context, then the calling process is blocked.

Parameters

aContext	is the GL context to be bound.
aCanvas	(optional) allows caller to bind the context to a non-parent canvas (e.g. when a few canvases share a single GL context).

Definition at line 88 of file gl_context_mgr.cpp.

{
 wxCHECK( aCanvas || m_glContexts.count( aContext ) > 0, /* void */ );
 
 m_glCtxMutex.lock();
 wxGLCanvas* canvas = aCanvas ? aCanvas : m_glContexts.at( aContext );
 
 // Prevent assertion failure in wxGLContext::SetCurrent during GAL teardown
#ifdef __WXGTK__
 if( canvas->GetXWindow() )
#endif
 {
 canvas->SetCurrent( *aContext );
 }
 
 m_glCtx = aContext;
}

References m_glContexts, m_glCtx, and m_glCtxMutex.

Referenced by EDA_3D_CANVAS::DoRePaint(), KIGFX::OPENGL_GAL::LockContext(), EDA_3D_MODEL_VIEWER::OnPaint(), EDA_3D_CANVAS::releaseOpenGL(), EDA_3D_MODEL_VIEWER::~EDA_3D_MODEL_VIEWER(), and KIGFX::OPENGL_GAL::~OPENGL_GAL().

◆ operator=()

void GL_CONTEXT_MANAGER::operator= ( const GL_CONTEXT_MANAGER & )

private

◆ UnlockCtx()

void GL_CONTEXT_MANAGER::UnlockCtx ( wxGLContext * aContext )

Allow other canvases to bind an OpenGL context.

Parameters

aContext is the currently bound context. It is only a check to assure the right canvas wants to unlock GL context.

Definition at line 107 of file gl_context_mgr.cpp.

{
 wxCHECK( m_glContexts.count( aContext ) > 0, /* void */ );
 
 if( m_glCtx == aContext )
 {
 m_glCtxMutex.unlock();
 m_glCtx = nullptr;
 }
 else
 {
 wxFAIL_MSG( wxString::Format( wxS( "Trying to unlock GL context mutex from "
 "a wrong context: aContext %p m_glCtx %p" ), aContext, m_glCtx ) );
 }
}

References Format(), m_glContexts, m_glCtx, and m_glCtxMutex.

Referenced by EDA_3D_CANVAS::DoRePaint(), EDA_3D_MODEL_VIEWER::OnPaint(), EDA_3D_CANVAS::releaseOpenGL(), KIGFX::OPENGL_GAL::UnlockContext(), EDA_3D_MODEL_VIEWER::~EDA_3D_MODEL_VIEWER(), and KIGFX::OPENGL_GAL::~OPENGL_GAL().

Member Data Documentation

◆ m_glContexts

std::map<wxGLContext*, wxGLCanvas*> GL_CONTEXT_MANAGER::m_glContexts

private

< Map of GL contexts & their parent canvases.

Currently bound GL context.

Definition at line 90 of file gl_context_mgr.h.

Referenced by CreateCtx(), DeleteAll(), DestroyCtx(), LockCtx(), and UnlockCtx().

◆ m_glCtx

wxGLContext* GL_CONTEXT_MANAGER::m_glCtx

private

Lock to prevent unexpected GL context switching.

Definition at line 93 of file gl_context_mgr.h.

Referenced by DeleteAll(), DestroyCtx(), LockCtx(), and UnlockCtx().

◆ m_glCtxMutex

std::mutex GL_CONTEXT_MANAGER::m_glCtxMutex

private

Definition at line 96 of file gl_context_mgr.h.

Referenced by DeleteAll(), LockCtx(), and UnlockCtx().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GL_CONTEXT_MANAGER() [1/2]

◆ GL_CONTEXT_MANAGER() [2/2]

Member Function Documentation

◆ CreateCtx()

◆ DeleteAll()

◆ DestroyCtx()

◆ Get()

◆ LockCtx()

◆ operator=()

◆ UnlockCtx()

Member Data Documentation

◆ m_glContexts

◆ m_glCtx

◆ m_glCtxMutex