1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/gtk/glcanvas.cpp
3 // Purpose: wxGLCanvas, for using OpenGL/Mesa with wxWidgets and GTK
4 // Author: Robert Roebling
8 // Copyright: (c) Robert Roebling
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // For compilers that support precompilation, includes "wx.h".
13 #include "wx/wxprec.h"
17 #include "wx/glcanvas.h"
22 #include "wx/colour.h"
25 #include "wx/module.h"
34 #include "wx/gtk/win_gtk.h"
35 #include "wx/gtk/private.h"
37 // DLL options compatibility check:
39 WX_CHECK_BUILD_OPTIONS("wxGL")
42 //---------------------------------------------------------------------------
44 //---------------------------------------------------------------------------
45 int wxGLCanvas::m_glxVersion
= 0;
47 //---------------------------------------------------------------------------
49 //---------------------------------------------------------------------------
51 XVisualInfo
*g_vi
= (XVisualInfo
*) NULL
;
53 //---------------------------------------------------------------------------
55 //---------------------------------------------------------------------------
57 IMPLEMENT_CLASS(wxGLContext
,wxObject
)
59 wxGLContext::wxGLContext( bool WXUNUSED(isRGB
), wxWindow
*win
, const wxPalette
& WXUNUSED(palette
) )
62 m_widget
= win
->m_wxwindow
;
64 wxGLCanvas
*gc
= (wxGLCanvas
*) win
;
66 if (wxGLCanvas::GetGLXVersion() >= 13)
69 GLXFBConfig
*fbc
= gc
->m_fbc
;
70 wxCHECK_RET( fbc
, _T("invalid GLXFBConfig for OpenGl") );
71 m_glContext
= glXCreateNewContext( GDK_DISPLAY(), fbc
[0], GLX_RGBA_TYPE
, None
, GL_TRUE
);
76 XVisualInfo
*vi
= (XVisualInfo
*) gc
->m_vi
;
77 wxCHECK_RET( vi
, _T("invalid visual for OpenGl") );
78 m_glContext
= glXCreateContext( GDK_DISPLAY(), vi
, None
, GL_TRUE
);
81 wxCHECK_RET( m_glContext
, _T("Couldn't create OpenGl context") );
84 wxGLContext::wxGLContext(
85 bool WXUNUSED(isRGB
), wxWindow
*win
,
86 const wxPalette
& WXUNUSED(palette
),
87 const wxGLContext
*other
/* for sharing display lists */
91 m_widget
= win
->m_wxwindow
;
93 wxGLCanvas
*gc
= (wxGLCanvas
*) win
;
95 if (wxGLCanvas::GetGLXVersion() >= 13)
98 GLXFBConfig
*fbc
= gc
->m_fbc
;
99 wxCHECK_RET( fbc
, _T("invalid GLXFBConfig for OpenGl") );
100 m_glContext
= glXCreateNewContext( GDK_DISPLAY(), fbc
[0], GLX_RGBA_TYPE
,
101 other
? other
->m_glContext
: None
,
107 XVisualInfo
*vi
= (XVisualInfo
*) gc
->m_vi
;
108 wxCHECK_RET( vi
, _T("invalid visual for OpenGl") );
109 m_glContext
= glXCreateContext( GDK_DISPLAY(), vi
,
110 other
? other
->m_glContext
: None
,
116 wxFAIL_MSG( _T("Couldn't create OpenGl context") );
120 wxGLContext::~wxGLContext()
122 if (!m_glContext
) return;
124 if (m_glContext
== glXGetCurrentContext())
126 if (wxGLCanvas::GetGLXVersion() >= 13)
128 glXMakeContextCurrent( GDK_DISPLAY(), None
, None
, NULL
);
131 glXMakeCurrent( GDK_DISPLAY(), None
, NULL
);
134 glXDestroyContext( GDK_DISPLAY(), m_glContext
);
137 void wxGLContext::SwapBuffers()
141 GdkWindow
*window
= GTK_PIZZA(m_widget
)->bin_window
;
142 glXSwapBuffers( GDK_DISPLAY(), GDK_WINDOW_XWINDOW( window
) );
146 void wxGLContext::SetCurrent()
150 GdkWindow
*window
= GTK_PIZZA(m_widget
)->bin_window
;
152 if (wxGLCanvas::GetGLXVersion() >= 13)
154 glXMakeContextCurrent( GDK_DISPLAY(), GDK_WINDOW_XWINDOW(window
),
155 GDK_WINDOW_XWINDOW(window
), m_glContext
);
158 glXMakeCurrent( GDK_DISPLAY(), GDK_WINDOW_XWINDOW(window
), m_glContext
);
162 void wxGLContext::SetColour(const wxChar
*colour
)
164 wxColour col
= wxTheColourDatabase
->Find(colour
);
167 float r
= (float)(col
.Red()/256.0);
168 float g
= (float)(col
.Green()/256.0);
169 float b
= (float)(col
.Blue()/256.0);
174 void wxGLContext::SetupPixelFormat()
178 void wxGLContext::SetupPalette( const wxPalette
& WXUNUSED(palette
) )
182 wxPalette
wxGLContext::CreateDefaultPalette()
184 return wxNullPalette
;
187 //-----------------------------------------------------------------------------
188 // "realize" from m_wxwindow
189 //-----------------------------------------------------------------------------
193 gtk_glwindow_realized_callback( GtkWidget
*WXUNUSED(widget
), wxGLCanvas
*win
)
195 if ( !win
->m_glContext
)
197 wxGLContext
*share
= win
->m_sharedContext
;
198 if ( !share
&& win
->m_sharedContextOf
)
199 share
= win
->m_sharedContextOf
->GetContext();
201 win
->m_glContext
= new wxGLContext( TRUE
, win
, wxNullPalette
, share
);
208 //-----------------------------------------------------------------------------
209 // "map" from m_wxwindow
210 //-----------------------------------------------------------------------------
214 gtk_glwindow_map_callback( GtkWidget
* WXUNUSED(widget
), wxGLCanvas
*win
)
216 if (win
->m_glContext
/* && win->m_exposed*/)
218 wxPaintEvent
event( win
->GetId() );
219 event
.SetEventObject( win
);
220 win
->GetEventHandler()->ProcessEvent( event
);
222 win
->m_exposed
= false;
223 win
->GetUpdateRegion().Clear();
230 //-----------------------------------------------------------------------------
231 // "expose_event" of m_wxwindow
232 //-----------------------------------------------------------------------------
236 gtk_glwindow_expose_callback( GtkWidget
*WXUNUSED(widget
), GdkEventExpose
*gdk_event
, wxGLCanvas
*win
)
238 // don't need to install idle handler, its done from "event" signal
240 win
->m_exposed
= true;
242 win
->GetUpdateRegion().Union( gdk_event
->area
.x
,
244 gdk_event
->area
.width
,
245 gdk_event
->area
.height
);
249 //-----------------------------------------------------------------------------
250 // "size_allocate" of m_wxwindow
251 //-----------------------------------------------------------------------------
255 gtk_glcanvas_size_callback( GtkWidget
*WXUNUSED(widget
), GtkAllocation
* alloc
, wxGLCanvas
*win
)
258 wxapp_install_idle_handler();
263 wxSizeEvent
event( wxSize(win
->m_width
,win
->m_height
), win
->GetId() );
264 event
.SetEventObject( win
);
265 win
->GetEventHandler()->ProcessEvent( event
);
269 //---------------------------------------------------------------------------
271 //---------------------------------------------------------------------------
273 IMPLEMENT_CLASS(wxGLCanvas
, wxWindow
)
275 BEGIN_EVENT_TABLE(wxGLCanvas
, wxWindow
)
276 EVT_SIZE(wxGLCanvas::OnSize
)
279 wxGLCanvas::wxGLCanvas( wxWindow
*parent
, wxWindowID id
,
280 const wxPoint
& pos
, const wxSize
& size
,
281 long style
, const wxString
& name
,
283 const wxPalette
& palette
)
285 Create( parent
, NULL
, NULL
, id
, pos
, size
, style
, name
, attribList
, palette
);
288 wxGLCanvas::wxGLCanvas( wxWindow
*parent
,
289 const wxGLContext
*shared
,
291 const wxPoint
& pos
, const wxSize
& size
,
292 long style
, const wxString
& name
,
294 const wxPalette
& palette
)
296 Create( parent
, shared
, NULL
, id
, pos
, size
, style
, name
, attribList
, palette
);
299 wxGLCanvas::wxGLCanvas( wxWindow
*parent
,
300 const wxGLCanvas
*shared
,
302 const wxPoint
& pos
, const wxSize
& size
,
303 long style
, const wxString
& name
,
305 const wxPalette
& palette
)
307 Create( parent
, NULL
, shared
, id
, pos
, size
, style
, name
, attribList
, palette
);
310 bool wxGLCanvas::Create( wxWindow
*parent
,
311 const wxGLContext
*shared
,
312 const wxGLCanvas
*shared_context_of
,
314 const wxPoint
& pos
, const wxSize
& size
,
315 long style
, const wxString
& name
,
317 const wxPalette
& palette
)
319 m_sharedContext
= (wxGLContext
*)shared
; // const_cast
320 m_sharedContextOf
= (wxGLCanvas
*)shared_context_of
; // const_cast
321 m_glContext
= (wxGLContext
*) NULL
;
325 m_nativeSizeEvent
= true;
329 // to be sure the glx version is known
330 wxGLCanvas::QueryGLXVersion();
332 if (wxGLCanvas::GetGLXVersion() >= 13)
334 // GLX >= 1.3 uses a GLXFBConfig
335 GLXFBConfig
* fbc
= NULL
;
336 if (wxTheApp
->m_glFBCInfo
!= NULL
)
338 fbc
= (GLXFBConfig
*) wxTheApp
->m_glFBCInfo
;
339 m_canFreeFBC
= false; // owned by wxTheApp - don't free upon destruction
343 fbc
= (GLXFBConfig
*) wxGLCanvas::ChooseGLFBC(attribList
);
346 m_fbc
= fbc
; // save for later use
347 wxCHECK_MSG( m_fbc
, false, _T("required FBConfig couldn't be found") );
350 XVisualInfo
*vi
= NULL
;
351 if (wxTheApp
->m_glVisualInfo
!= NULL
)
353 vi
= (XVisualInfo
*)wxTheApp
->m_glVisualInfo
;
354 m_canFreeVi
= false; // owned by wxTheApp - don't free upon destruction
358 if (wxGLCanvas::GetGLXVersion() >= 13)
360 vi
= glXGetVisualFromFBConfig(GDK_DISPLAY(), m_fbc
[0]);
363 vi
= (XVisualInfo
*) ChooseGLVisual(attribList
);
368 m_vi
= vi
; // save for later use
370 wxCHECK_MSG( m_vi
, false, _T("required visual couldn't be found") );
372 GdkColormap
*colormap
;
374 // MR: This needs a fix for lower gtk+ versions too. Might need to rethink logic (FIXME)
375 #if defined(__WXGTK20__) && GTK_CHECK_VERSION(2,2,0)
376 if (!gtk_check_version(2,2,0))
378 wxWindow::Create( parent
, id
, pos
, size
, style
, name
);
380 m_glWidget
= m_wxwindow
;
382 GdkScreen
*screen
= gtk_widget_get_screen( m_glWidget
);
383 colormap
= gdk_screen_get_default_colormap(screen
);
384 visual
= gdk_colormap_get_visual(colormap
);
386 if (GDK_VISUAL_XVISUAL(visual
)->visualid
!= vi
->visualid
)
388 visual
= gdk_x11_screen_lookup_visual( screen
, vi
->visualid
);
389 colormap
= gdk_colormap_new(visual
, FALSE
);
392 gtk_widget_set_colormap( m_glWidget
, colormap
);
397 visual
= gdkx_visual_get( vi
->visualid
);
398 colormap
= gdk_colormap_new( visual
, TRUE
);
400 gtk_widget_push_colormap( colormap
);
402 wxWindow::Create( parent
, id
, pos
, size
, style
, name
);
403 m_glWidget
= m_wxwindow
;
406 gtk_widget_set_double_buffered( m_glWidget
, FALSE
);
408 g_signal_connect (m_wxwindow
, "realize",
409 G_CALLBACK (gtk_glwindow_realized_callback
),
411 g_signal_connect (m_wxwindow
, "map",
412 G_CALLBACK (gtk_glwindow_map_callback
),
414 g_signal_connect (m_wxwindow
, "expose_event",
415 G_CALLBACK (gtk_glwindow_expose_callback
),
417 g_signal_connect (m_widget
, "size_allocate",
418 G_CALLBACK (gtk_glcanvas_size_callback
),
421 if (gtk_check_version(2,2,0) != NULL
)
423 gtk_widget_pop_colormap();
426 // if our parent window is already visible, we had been realized before we
427 // connected to the "realize" signal and hence our m_glContext hasn't been
428 // initialized yet and we have to do it now
429 if (GTK_WIDGET_REALIZED(m_wxwindow
))
430 gtk_glwindow_realized_callback( m_wxwindow
, this );
432 if (GTK_WIDGET_MAPPED(m_wxwindow
))
433 gtk_glwindow_map_callback( m_wxwindow
, this );
438 wxGLCanvas::~wxGLCanvas()
440 GLXFBConfig
* fbc
= (GLXFBConfig
*) m_fbc
;
441 if (fbc
&& m_canFreeFBC
)
444 XVisualInfo
*vi
= (XVisualInfo
*) m_vi
;
445 if (vi
&& m_canFreeVi
)
451 void* wxGLCanvas::ChooseGLVisual(int *attribList
)
454 GetGLAttribListFromWX( attribList
, data
);
455 attribList
= (int*) data
;
457 Display
*dpy
= GDK_DISPLAY();
459 return glXChooseVisual( dpy
, DefaultScreen(dpy
), attribList
);
462 void* wxGLCanvas::ChooseGLFBC(int *attribList
)
465 GetGLAttribListFromWX( attribList
, data
);
466 attribList
= (int*) data
;
469 return glXChooseFBConfig( GDK_DISPLAY(), DefaultScreen(GDK_DISPLAY()),
470 attribList
, &returned
);
474 void wxGLCanvas::GetGLAttribListFromWX(int *wx_attribList
, int *gl_attribList
)
478 if (wxGLCanvas::GetGLXVersion() >= 13)
479 // leave GLX >= 1.3 choose the default attributes
480 gl_attribList
[0] = 0;
484 // default settings if attriblist = 0
485 gl_attribList
[i
++] = GLX_RGBA
;
486 gl_attribList
[i
++] = GLX_DOUBLEBUFFER
;
487 gl_attribList
[i
++] = GLX_DEPTH_SIZE
; gl_attribList
[i
++] = 1;
488 gl_attribList
[i
++] = GLX_RED_SIZE
; gl_attribList
[i
++] = 1;
489 gl_attribList
[i
++] = GLX_GREEN_SIZE
; gl_attribList
[i
++] = 1;
490 gl_attribList
[i
++] = GLX_BLUE_SIZE
; gl_attribList
[i
++] = 1;
491 gl_attribList
[i
++] = GLX_ALPHA_SIZE
; gl_attribList
[i
++] = 0;
492 gl_attribList
[i
++] = None
;
498 while( (wx_attribList
[arg
]!=0) && (p
<510) )
500 switch( wx_attribList
[arg
++] )
503 if (wxGLCanvas::GetGLXVersion() <= 12)
504 // for GLX >= 1.3, GLX_RGBA is useless (setting this flags will crash on most opengl implm)
505 gl_attribList
[p
++] = GLX_RGBA
;
507 case WX_GL_BUFFER_SIZE
:
508 gl_attribList
[p
++] = GLX_BUFFER_SIZE
;
509 gl_attribList
[p
++] = wx_attribList
[arg
++];
512 gl_attribList
[p
++] = GLX_LEVEL
;
513 gl_attribList
[p
++] = wx_attribList
[arg
++];
515 case WX_GL_DOUBLEBUFFER
:
516 if (wxGLCanvas::GetGLXVersion() <= 12)
517 gl_attribList
[p
++] = GLX_DOUBLEBUFFER
;
519 // for GLX >= 1.3, GLX_DOUBLEBUFFER format is different (1 <=> True)
520 // it seems this flag is useless for some hardware opengl implementation.
521 // but for Mesa 6.2.1, this flag is used so don't ignore it.
522 gl_attribList
[p
++] = GLX_DOUBLEBUFFER
;
523 gl_attribList
[p
++] = 1;
526 gl_attribList
[p
++] = GLX_STEREO
;
528 case WX_GL_AUX_BUFFERS
:
529 gl_attribList
[p
++] = GLX_AUX_BUFFERS
;
530 gl_attribList
[p
++] = wx_attribList
[arg
++];
533 gl_attribList
[p
++] = GLX_RED_SIZE
;
534 gl_attribList
[p
++] = wx_attribList
[arg
++];
536 case WX_GL_MIN_GREEN
:
537 gl_attribList
[p
++] = GLX_GREEN_SIZE
;
538 gl_attribList
[p
++] = wx_attribList
[arg
++];
541 gl_attribList
[p
++] = GLX_BLUE_SIZE
;
542 gl_attribList
[p
++] = wx_attribList
[arg
++];
544 case WX_GL_MIN_ALPHA
:
545 gl_attribList
[p
++] = GLX_ALPHA_SIZE
;
546 gl_attribList
[p
++] = wx_attribList
[arg
++];
548 case WX_GL_DEPTH_SIZE
:
549 gl_attribList
[p
++] = GLX_DEPTH_SIZE
;
550 gl_attribList
[p
++] = wx_attribList
[arg
++];
552 case WX_GL_STENCIL_SIZE
:
553 gl_attribList
[p
++] = GLX_STENCIL_SIZE
;
554 gl_attribList
[p
++] = wx_attribList
[arg
++];
556 case WX_GL_MIN_ACCUM_RED
:
557 gl_attribList
[p
++] = GLX_ACCUM_RED_SIZE
;
558 gl_attribList
[p
++] = wx_attribList
[arg
++];
560 case WX_GL_MIN_ACCUM_GREEN
:
561 gl_attribList
[p
++] = GLX_ACCUM_GREEN_SIZE
;
562 gl_attribList
[p
++] = wx_attribList
[arg
++];
564 case WX_GL_MIN_ACCUM_BLUE
:
565 gl_attribList
[p
++] = GLX_ACCUM_BLUE_SIZE
;
566 gl_attribList
[p
++] = wx_attribList
[arg
++];
568 case WX_GL_MIN_ACCUM_ALPHA
:
569 gl_attribList
[p
++] = GLX_ACCUM_ALPHA_SIZE
;
570 gl_attribList
[p
++] = wx_attribList
[arg
++];
577 gl_attribList
[p
] = 0;
581 void wxGLCanvas::QueryGLXVersion()
583 if (m_glxVersion
== 0)
585 // check the GLX version
586 int glxMajorVer
, glxMinorVer
;
587 bool ok
= glXQueryVersion(GDK_DISPLAY(), &glxMajorVer
, &glxMinorVer
);
588 wxASSERT_MSG( ok
, _T("GLX version not found") );
590 m_glxVersion
= 10; // 1.0 by default
592 m_glxVersion
= glxMajorVer
*10 + glxMinorVer
;
596 int wxGLCanvas::GetGLXVersion()
598 wxASSERT_MSG( m_glxVersion
>0, _T("GLX version has not been initialized with wxGLCanvas::QueryGLXVersion()") );
603 void wxGLCanvas::SwapBuffers()
606 m_glContext
->SwapBuffers();
609 void wxGLCanvas::OnSize(wxSizeEvent
& WXUNUSED(event
))
613 void wxGLCanvas::SetCurrent()
616 m_glContext
->SetCurrent();
619 void wxGLCanvas::SetColour( const wxChar
*colour
)
622 m_glContext
->SetColour( colour
);
625 void wxGLCanvas::OnInternalIdle()
627 if (m_glContext
&& m_exposed
)
629 wxPaintEvent
event( GetId() );
630 event
.SetEventObject( this );
631 GetEventHandler()->ProcessEvent( event
);
634 GetUpdateRegion().Clear();
637 wxWindow::OnInternalIdle();
642 //---------------------------------------------------------------------------
644 //---------------------------------------------------------------------------
646 IMPLEMENT_CLASS(wxGLApp
, wxApp
)
653 XFree(m_glVisualInfo
);
656 bool wxGLApp::InitGLVisual(int *attribList
)
658 wxGLCanvas::QueryGLXVersion();
660 if (wxGLCanvas::GetGLXVersion() >= 13)
665 m_glFBCInfo
= wxGLCanvas::ChooseGLFBC(attribList
);
670 XFree(m_glVisualInfo
);
671 m_glVisualInfo
= glXGetVisualFromFBConfig(GDK_DISPLAY(), ((GLXFBConfig
*)m_glFBCInfo
)[0]);
673 return (m_glFBCInfo
!= NULL
) && (m_glVisualInfo
!= NULL
);
679 XFree(m_glVisualInfo
);
680 m_glVisualInfo
= wxGLCanvas::ChooseGLVisual(attribList
);
681 return m_glVisualInfo
!= NULL
;