Big wxGL classes refactoring/cleanup:

1. Provide the same API, especially, but not limited to, wxGLCanvas and
   wxCLContext ctors (which were completely different in all ports)
2. Extracted common parts into wxGLCanvas/ContextBase classes
3. Deprecate the old API using implicitly created wxGLContext


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@45388 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2007-04-10 17:38:55 +00:00
parent 1f602af615
commit dc3065a56f
25 changed files with 1860 additions and 1996 deletions

View File

@@ -33,22 +33,26 @@ extern "C"
#include "wx/gtk/win_gtk.h"
#include "wx/gtk/private.h"
// DLL options compatibility check:
#include "wx/build.h"
WX_CHECK_BUILD_OPTIONS("wxGL")
//---------------------------------------------------------------------------
// static variables
//---------------------------------------------------------------------------
int wxGLCanvas::m_glxVersion = 0;
//---------------------------------------------------------------------------
// global data
//---------------------------------------------------------------------------
XVisualInfo *g_vi = (XVisualInfo*) NULL;
// ----------------------------------------------------------------------------
// helper functions
// ----------------------------------------------------------------------------
// wrapper around glXMakeContextCurrent/glXMakeCurrent depending on GLX
// version
static void wxMakeContextCurrent(GLXDrawable drawable, GLXContext context)
{
if (wxGLCanvas::GetGLXVersion() >= 13)
glXMakeContextCurrent( GDK_DISPLAY(), drawable, drawable, context);
else // GLX <= 1.2 doesn't have glXMakeContextCurrent()
glXMakeCurrent( GDK_DISPLAY(), drawable, context);
}
//---------------------------------------------------------------------------
// wxGLContext
//---------------------------------------------------------------------------
@@ -61,16 +65,14 @@ wxGLContext::wxGLContext(wxWindow* win, const wxGLContext* other)
if (wxGLCanvas::GetGLXVersion() >= 13)
{
// GLX >= 1.3
GLXFBConfig *fbc = gc->m_fbc;
wxCHECK_RET( fbc, _T("invalid GLXFBConfig for OpenGl") );
m_glContext = glXCreateNewContext( GDK_DISPLAY(), fbc[0], GLX_RGBA_TYPE,
other ? other->m_glContext : None,
GL_TRUE );
}
else
else // GLX <= 1.2
{
// GLX <= 1.2
XVisualInfo *vi = (XVisualInfo *) gc->m_vi;
wxCHECK_RET( vi, _T("invalid visual for OpenGl") );
m_glContext = glXCreateContext( GDK_DISPLAY(), vi,
@@ -78,66 +80,50 @@ wxGLContext::wxGLContext(wxWindow* win, const wxGLContext* other)
GL_TRUE );
}
if ( !m_glContext )
{
wxFAIL_MSG( _T("Couldn't create OpenGl context") );
}
wxASSERT_MSG( m_glContext, _T("Couldn't create OpenGl context") );
}
wxGLContext::~wxGLContext()
{
if (!m_glContext) return;
if ( !m_glContext )
return;
if (m_glContext == glXGetCurrentContext())
{
if (wxGLCanvas::GetGLXVersion() >= 13)
// GLX >= 1.3
glXMakeContextCurrent( GDK_DISPLAY(), None, None, NULL);
else
// GLX <= 1.2
glXMakeCurrent( GDK_DISPLAY(), None, NULL);
}
if ( m_glContext == glXGetCurrentContext() )
wxMakeContextCurrent(None, NULL);
glXDestroyContext( GDK_DISPLAY(), m_glContext );
}
void wxGLContext::SetCurrent(const wxGLCanvas& win) const
{
if (m_glContext)
{
GdkWindow *window = GTK_PIZZA(win.m_wxwindow)->bin_window;
if ( !m_glContext )
return;
if (wxGLCanvas::GetGLXVersion() >= 13)
// GLX >= 1.3
glXMakeContextCurrent( GDK_DISPLAY(), GDK_WINDOW_XWINDOW(window), GDK_WINDOW_XWINDOW(window), m_glContext );
else
// GLX <= 1.2
glXMakeCurrent( GDK_DISPLAY(), GDK_WINDOW_XWINDOW(window), m_glContext );
}
GdkWindow *window = GTK_PIZZA(win.m_wxwindow)->bin_window;
wxCHECK_RET( window, _T("window must be shown") );
wxMakeContextCurrent(GDK_WINDOW_XWINDOW(window), m_glContext);
}
#if WXWIN_COMPATIBILITY_2_8
//-----------------------------------------------------------------------------
// "realize" from m_wxwindow
// "realize" from m_wxwindow: used to create m_glContext implicitly
//-----------------------------------------------------------------------------
extern "C" {
static gint
gtk_glwindow_realized_callback( GtkWidget *WXUNUSED(widget), wxGLCanvas *win )
{
if (!win->m_glContext && win->m_createImplicitContext)
{
wxGLContext *share = win->m_sharedContext;
if ( !share && win->m_sharedContextOf )
share = win->m_sharedContextOf->GetContext();
win->m_glContext = new wxGLContext(win, share);
}
win->GTKInitImplicitContext();
return FALSE;
}
}
#endif // WXWIN_COMPATIBILITY_2_8
//-----------------------------------------------------------------------------
// "map" from m_wxwindow
//-----------------------------------------------------------------------------
@@ -146,16 +132,12 @@ extern "C" {
static gint
gtk_glwindow_map_callback( GtkWidget * WXUNUSED(widget), wxGLCanvas *win )
{
// CF: Can the "if" line be removed, and the code unconditionally (always) be run?
if (win->m_glContext || !win->m_createImplicitContext)
{
wxPaintEvent event( win->GetId() );
event.SetEventObject( win );
win->GetEventHandler()->ProcessEvent( event );
wxPaintEvent event( win->GetId() );
event.SetEventObject( win );
win->GetEventHandler()->ProcessEvent( event );
win->m_exposed = false;
win->GetUpdateRegion().Clear();
}
win->m_exposed = false;
win->GetUpdateRegion().Clear();
return FALSE;
}
@@ -207,76 +189,83 @@ gtk_glcanvas_size_callback( GtkWidget *WXUNUSED(widget), GtkAllocation* alloc, w
IMPLEMENT_CLASS(wxGLCanvas, wxWindow)
BEGIN_EVENT_TABLE(wxGLCanvas, wxWindow)
EVT_SIZE(wxGLCanvas::OnSize)
END_EVENT_TABLE()
wxGLCanvas::wxGLCanvas( wxWindow *parent, wxWindowID id,
int *attribList,
const wxPoint& pos, const wxSize& size,
long style, const wxString& name,
const wxPalette& palette )
wxGLCanvas::wxGLCanvas(wxWindow *parent,
wxWindowID id,
const int *attribList,
const wxPoint& pos,
const wxSize& size,
long style,
const wxString& name,
const wxPalette& palette)
#if WXWIN_COMPATIBILITY_2_8
: m_createImplicitContext(false)
#endif
{
Create( parent, NULL, NULL, id, pos, size, style, name, attribList, palette );
Create(parent, id, pos, size, style, name, attribList, palette);
}
wxGLCanvas::wxGLCanvas( wxWindow *parent, wxWindowID id,
const wxPoint& pos, const wxSize& size,
long style, const wxString& name,
int *attribList,
const wxPalette& palette )
#if WXWIN_COMPATIBILITY_2_8
wxGLCanvas::wxGLCanvas(wxWindow *parent,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
long style,
const wxString& name,
const int *attribList,
const wxPalette& palette)
: m_createImplicitContext(true)
{
Create( parent, NULL, NULL, id, pos, size, style, name, attribList, palette );
Create(parent, id, pos, size, style, name, attribList, palette);
}
wxGLCanvas::wxGLCanvas( wxWindow *parent,
const wxGLContext *shared,
wxGLCanvas::wxGLCanvas(wxWindow *parent,
const wxGLContext *shared,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
long style,
const wxString& name,
const int *attribList,
const wxPalette& palette)
: m_createImplicitContext(true)
{
m_sharedContext = wx_const_cast(wxGLContext *, shared);
Create(parent, id, pos, size, style, name, attribList, palette);
}
wxGLCanvas::wxGLCanvas(wxWindow *parent,
const wxGLCanvas *shared,
wxWindowID id,
const wxPoint& pos, const wxSize& size,
long style, const wxString& name,
const int *attribList,
const wxPalette& palette )
: m_createImplicitContext(true)
{
m_sharedContextOf = wx_const_cast(wxGLCanvas *, shared);
Create(parent, id, pos, size, style, name, attribList, palette);
}
#endif // WXWIN_COMPATIBILITY_2_8
bool wxGLCanvas::Create(wxWindow *parent,
wxWindowID id,
const wxPoint& pos, const wxSize& size,
long style, const wxString& name,
int *attribList,
const wxPalette& palette )
: m_createImplicitContext(true)
const wxPoint& pos,
const wxSize& size,
long style,
const wxString& name,
const int *attribList,
const wxPalette& palette)
{
Create( parent, shared, NULL, id, pos, size, style, name, attribList, palette );
}
wxGLCanvas::wxGLCanvas( wxWindow *parent,
const wxGLCanvas *shared,
wxWindowID id,
const wxPoint& pos, const wxSize& size,
long style, const wxString& name,
int *attribList,
const wxPalette& palette )
: m_createImplicitContext(true)
{
Create( parent, NULL, shared, id, pos, size, style, name, attribList, palette );
}
bool wxGLCanvas::Create( wxWindow *parent,
const wxGLContext *shared,
const wxGLCanvas *shared_context_of,
wxWindowID id,
const wxPoint& pos, const wxSize& size,
long style, const wxString& name,
int *attribList,
const wxPalette& palette)
{
m_sharedContext = (wxGLContext*)shared; // const_cast
m_sharedContextOf = (wxGLCanvas*)shared_context_of; // const_cast
m_glContext = (wxGLContext*) NULL;
m_exposed = false;
m_noExpose = true;
m_nativeSizeEvent = true;
m_fbc = NULL;
m_vi = NULL;
// to be sure the glx version is known
wxGLCanvas::QueryGLXVersion();
if (wxGLCanvas::GetGLXVersion() >= 13)
{
// GLX >= 1.3 uses a GLXFBConfig
@@ -340,7 +329,7 @@ bool wxGLCanvas::Create( wxWindow *parent,
gtk_widget_set_colormap( m_glWidget, colormap );
}
else
#endif
#endif // GTK+ >= 2.2
{
visual = gdkx_visual_get( vi->visualid );
colormap = gdk_colormap_new( visual, TRUE );
@@ -353,7 +342,9 @@ bool wxGLCanvas::Create( wxWindow *parent,
gtk_widget_set_double_buffered( m_glWidget, FALSE );
#if WXWIN_COMPATIBILITY_2_8
g_signal_connect(m_wxwindow, "realize", G_CALLBACK(gtk_glwindow_realized_callback), this);
#endif // WXWIN_COMPATIBILITY_2_8
g_signal_connect(m_wxwindow, "map", G_CALLBACK(gtk_glwindow_map_callback), this);
g_signal_connect(m_wxwindow, "expose_event", G_CALLBACK(gtk_glwindow_expose_callback), this);
g_signal_connect(m_widget, "size_allocate", G_CALLBACK(gtk_glcanvas_size_callback), this);
@@ -363,11 +354,13 @@ bool wxGLCanvas::Create( wxWindow *parent,
gtk_widget_pop_colormap();
}
#if WXWIN_COMPATIBILITY_2_8
// if our parent window is already visible, we had been realized before we
// connected to the "realize" signal and hence our m_glContext hasn't been
// initialized yet and we have to do it now
if (GTK_WIDGET_REALIZED(m_wxwindow))
gtk_glwindow_realized_callback( m_wxwindow, this );
#endif // WXWIN_COMPATIBILITY_2_8
if (GTK_WIDGET_MAPPED(m_wxwindow))
gtk_glwindow_map_callback( m_wxwindow, this );
@@ -384,41 +377,40 @@ wxGLCanvas::~wxGLCanvas()
XVisualInfo *vi = (XVisualInfo *) m_vi;
if (vi && m_canFreeVi)
XFree( vi );
delete m_glContext;
}
void* wxGLCanvas::ChooseGLVisual(int *attribList)
void* wxGLCanvas::ChooseGLVisual(const int *attribList)
{
int data[512];
GetGLAttribListFromWX( attribList, data );
attribList = (int*) data;
Display *dpy = GDK_DISPLAY();
return glXChooseVisual( dpy, DefaultScreen(dpy), attribList );
return glXChooseVisual( dpy, DefaultScreen(dpy), data );
}
void* wxGLCanvas::ChooseGLFBC(int *attribList)
void* wxGLCanvas::ChooseGLFBC(const int *attribList)
{
int data[512];
GetGLAttribListFromWX( attribList, data );
attribList = (int*) data;
int returned;
return glXChooseFBConfig( GDK_DISPLAY(), DefaultScreen(GDK_DISPLAY()),
attribList, &returned );
data, &returned );
}
void wxGLCanvas::GetGLAttribListFromWX(int *wx_attribList, int *gl_attribList )
void
wxGLCanvas::GetGLAttribListFromWX(const int *wx_attribList, int *gl_attribList)
{
if (!wx_attribList)
if ( !wx_attribList )
{
if (wxGLCanvas::GetGLXVersion() >= 13)
// leave GLX >= 1.3 choose the default attributes
{
// leave GLX >= 1.3 choose the default attributes
gl_attribList[0] = 0;
else
}
else // GLX < 1.3
{
int i = 0;
// default settings if attriblist = 0
@@ -432,7 +424,7 @@ void wxGLCanvas::GetGLAttribListFromWX(int *wx_attribList, int *gl_attribList )
gl_attribList[i++] = None;
}
}
else
else // have non-default attributes
{
int arg=0, p=0;
while( (wx_attribList[arg]!=0) && (p<510) )
@@ -441,8 +433,10 @@ void wxGLCanvas::GetGLAttribListFromWX(int *wx_attribList, int *gl_attribList )
{
case WX_GL_RGBA:
if (wxGLCanvas::GetGLXVersion() <= 12)
{
// for GLX >= 1.3, GLX_RGBA is useless (setting this flags will crash on most opengl implm)
gl_attribList[p++] = GLX_RGBA;
}
break;
case WX_GL_BUFFER_SIZE:
gl_attribList[p++] = GLX_BUFFER_SIZE;
@@ -453,13 +447,7 @@ void wxGLCanvas::GetGLAttribListFromWX(int *wx_attribList, int *gl_attribList )
gl_attribList[p++] = wx_attribList[arg++];
break;
case WX_GL_DOUBLEBUFFER:
if (wxGLCanvas::GetGLXVersion() <= 12)
gl_attribList[p++] = GLX_DOUBLEBUFFER;
else
// for GLX >= 1.3, GLX_DOUBLEBUFFER format is different (1 <=> True)
// it seems this flag is useless for some hardware opengl implementation.
// but for Mesa 6.2.1, this flag is used so don't ignore it.
gl_attribList[p++] = GLX_DOUBLEBUFFER;
gl_attribList[p++] = GLX_DOUBLEBUFFER;
gl_attribList[p++] = 1;
break;
case WX_GL_STEREO:
@@ -518,64 +506,34 @@ void wxGLCanvas::GetGLAttribListFromWX(int *wx_attribList, int *gl_attribList )
}
}
void wxGLCanvas::QueryGLXVersion()
/* static */
int wxGLCanvas::GetGLXVersion()
{
if (m_glxVersion == 0)
static int s_glxVersion = 0;
if ( s_glxVersion == 0 )
{
// check the GLX version
int glxMajorVer, glxMinorVer;
bool ok = glXQueryVersion(GDK_DISPLAY(), &glxMajorVer, &glxMinorVer);
wxASSERT_MSG( ok, _T("GLX version not found") );
if (!ok)
m_glxVersion = 10; // 1.0 by default
s_glxVersion = 10; // 1.0 by default
else
m_glxVersion = glxMajorVer*10 + glxMinorVer;
s_glxVersion = glxMajorVer*10 + glxMinorVer;
}
}
int wxGLCanvas::GetGLXVersion()
{
wxASSERT_MSG( m_glxVersion>0, _T("GLX version has not been initialized with wxGLCanvas::QueryGLXVersion()") );
return m_glxVersion;
return s_glxVersion;
}
void wxGLCanvas::SwapBuffers()
{
GdkWindow *window = GTK_PIZZA(m_wxwindow)->bin_window;
glXSwapBuffers( GDK_DISPLAY(), GDK_WINDOW_XWINDOW( window ) );
}
void wxGLCanvas::OnSize(wxSizeEvent& WXUNUSED(event))
{
}
void wxGLCanvas::SetCurrent(const wxGLContext& RC) const
{
RC.SetCurrent(*this);
}
void wxGLCanvas::SetCurrent()
{
if (m_glContext)
m_glContext->SetCurrent(*this);
}
void wxGLCanvas::SetColour( const wxChar *colour )
{
wxColour col = wxTheColourDatabase->Find(colour);
if (col.Ok())
{
float r = (float)(col.Red()/256.0);
float g = (float)(col.Green()/256.0);
float b = (float)(col.Blue()/256.0);
glColor3f( r, g, b);
}
}
void wxGLCanvas::OnInternalIdle()
{
if (/*m_glContext &&*/ m_exposed)
if (m_exposed)
{
wxPaintEvent event( GetId() );
event.SetEventObject( this );
@@ -588,50 +546,49 @@ void wxGLCanvas::OnInternalIdle()
wxWindow::OnInternalIdle();
}
#if WXWIN_COMPATIBILITY_2_8
void wxGLCanvas::GTKInitImplicitContext()
{
if ( !m_glContext && m_createImplicitContext )
{
wxGLContext *share = m_sharedContext;
if ( !share && m_sharedContextOf )
share = m_sharedContextOf->m_glContext;
m_glContext = new wxGLContext(this, share);
}
}
#endif // WXWIN_COMPATIBILITY_2_8
//---------------------------------------------------------------------------
// wxGLApp
//---------------------------------------------------------------------------
IMPLEMENT_CLASS(wxGLApp, wxApp)
wxGLApp::~wxGLApp()
bool wxGLApp::InitGLVisual(const int *attribList)
{
if (m_glFBCInfo)
XFree(m_glFBCInfo);
if (m_glVisualInfo)
XFree(m_glVisualInfo);
}
bool wxGLApp::InitGLVisual(int *attribList)
{
wxGLCanvas::QueryGLXVersion();
if (wxGLCanvas::GetGLXVersion() >= 13)
if ( wxGLCanvas::GetGLXVersion() >= 13 )
{
// GLX >= 1.3
if (m_glFBCInfo)
XFree(m_glFBCInfo);
m_glFBCInfo = wxGLCanvas::ChooseGLFBC(attribList);
if (m_glFBCInfo)
{
if (m_glVisualInfo)
XFree(m_glVisualInfo);
m_glVisualInfo = glXGetVisualFromFBConfig(GDK_DISPLAY(), ((GLXFBConfig *)m_glFBCInfo)[0]);
}
return (m_glFBCInfo != NULL) && (m_glVisualInfo != NULL);
if ( !m_glFBCInfo )
return false;
if (m_glVisualInfo)
XFree(m_glVisualInfo);
m_glVisualInfo = glXGetVisualFromFBConfig(GDK_DISPLAY(), ((GLXFBConfig *)m_glFBCInfo)[0]);
}
else
else // GLX <= 1.2
{
// GLX <= 1.2
if (m_glVisualInfo)
XFree(m_glVisualInfo);
m_glVisualInfo = wxGLCanvas::ChooseGLVisual(attribList);
return m_glVisualInfo != NULL;
}
return m_glVisualInfo != NULL;
}
#endif
// wxUSE_GLCANVAS
#endif // wxUSE_GLCANVAS