1 /////////////////////////////////////////////////////////////////////////////
2 // Name: 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"
19 #include "wx/glcanvas.h"
22 #include "wx/colour.h"
23 #include "wx/module.h"
33 #include "wx/gtk1/win_gtk.h"
35 // DLL options compatibility check:
37 WX_CHECK_BUILD_OPTIONS("wxGL")
40 //---------------------------------------------------------------------------
42 //---------------------------------------------------------------------------
43 int wxGLCanvas::m_glxVersion
= 0;
45 //---------------------------------------------------------------------------
47 //---------------------------------------------------------------------------
49 XVisualInfo
*g_vi
= (XVisualInfo
*) NULL
;
50 //-----------------------------------------------------------------------------
52 //-----------------------------------------------------------------------------
54 extern void wxapp_install_idle_handler();
57 //---------------------------------------------------------------------------
59 //---------------------------------------------------------------------------
61 IMPLEMENT_CLASS(wxGLContext
,wxObject
)
63 wxGLContext::wxGLContext( bool WXUNUSED(isRGB
), wxWindow
*win
, const wxPalette
& WXUNUSED(palette
) )
66 m_widget
= win
->m_wxwindow
;
68 wxGLCanvas
*gc
= (wxGLCanvas
*) win
;
70 if (wxGLCanvas::GetGLXVersion() >= 13)
73 GLXFBConfig
*fbc
= gc
->m_fbc
;
74 wxCHECK_RET( fbc
, _T("invalid GLXFBConfig for OpenGl") );
75 m_glContext
= glXCreateNewContext( GDK_DISPLAY(), fbc
[0], GLX_RGBA_TYPE
, None
, GL_TRUE
);
80 XVisualInfo
*vi
= (XVisualInfo
*) gc
->m_vi
;
81 wxCHECK_RET( vi
, _T("invalid visual for OpenGl") );
82 m_glContext
= glXCreateContext( GDK_DISPLAY(), vi
, None
, GL_TRUE
);
85 wxCHECK_RET( m_glContext
, _T("Couldn't create OpenGl context") );
88 wxGLContext::wxGLContext(
89 bool WXUNUSED(isRGB
), wxWindow
*win
,
90 const wxPalette
& WXUNUSED(palette
),
91 const wxGLContext
*other
/* for sharing display lists */
95 m_widget
= win
->m_wxwindow
;
97 wxGLCanvas
*gc
= (wxGLCanvas
*) win
;
99 if (wxGLCanvas::GetGLXVersion() >= 13)
102 GLXFBConfig
*fbc
= gc
->m_fbc
;
103 wxCHECK_RET( fbc
, _T("invalid GLXFBConfig for OpenGl") );
104 m_glContext
= glXCreateNewContext( GDK_DISPLAY(), fbc
[0], GLX_RGBA_TYPE
,
105 other
? other
->m_glContext
: None
,
111 XVisualInfo
*vi
= (XVisualInfo
*) gc
->m_vi
;
112 wxCHECK_RET( vi
, _T("invalid visual for OpenGl") );
113 m_glContext
= glXCreateContext( GDK_DISPLAY(), vi
,
114 other
? other
->m_glContext
: None
,
120 wxFAIL_MSG( _T("Couldn't create OpenGl context") );
124 wxGLContext::~wxGLContext()
126 if (!m_glContext
) return;
128 if (m_glContext
== glXGetCurrentContext())
130 if (wxGLCanvas::GetGLXVersion() >= 13)
132 glXMakeContextCurrent( GDK_DISPLAY(), None
, None
, NULL
);
135 glXMakeCurrent( GDK_DISPLAY(), None
, NULL
);
138 glXDestroyContext( GDK_DISPLAY(), m_glContext
);
141 void wxGLContext::SwapBuffers()
145 GdkWindow
*window
= GTK_PIZZA(m_widget
)->bin_window
;
146 glXSwapBuffers( GDK_DISPLAY(), GDK_WINDOW_XWINDOW( window
) );
150 void wxGLContext::SetCurrent()
154 GdkWindow
*window
= GTK_PIZZA(m_widget
)->bin_window
;
156 if (wxGLCanvas::GetGLXVersion() >= 13)
158 glXMakeContextCurrent( GDK_DISPLAY(), GDK_WINDOW_XWINDOW(window
),
159 GDK_WINDOW_XWINDOW(window
), m_glContext
);
162 glXMakeCurrent( GDK_DISPLAY(), GDK_WINDOW_XWINDOW(window
), m_glContext
);
166 void wxGLContext::SetColour(const wxChar
*colour
)
168 wxColour col
= wxTheColourDatabase
->Find(colour
);
171 float r
= (float)(col
.Red()/256.0);
172 float g
= (float)(col
.Green()/256.0);
173 float b
= (float)(col
.Blue()/256.0);
178 void wxGLContext::SetupPixelFormat()
182 void wxGLContext::SetupPalette( const wxPalette
& WXUNUSED(palette
) )
186 wxPalette
wxGLContext::CreateDefaultPalette()
188 return wxNullPalette
;
191 //-----------------------------------------------------------------------------
192 // "realize" from m_wxwindow
193 //-----------------------------------------------------------------------------
197 gtk_glwindow_realized_callback( GtkWidget
*WXUNUSED(widget
), wxGLCanvas
*win
)
199 if ( !win
->m_glContext
)
201 wxGLContext
*share
= win
->m_sharedContext
;
202 if ( !share
&& win
->m_sharedContextOf
)
203 share
= win
->m_sharedContextOf
->GetContext();
205 win
->m_glContext
= new wxGLContext( TRUE
, win
, wxNullPalette
, share
);
212 //-----------------------------------------------------------------------------
213 // "map" from m_wxwindow
214 //-----------------------------------------------------------------------------
218 gtk_glwindow_map_callback( GtkWidget
* WXUNUSED(widget
), wxGLCanvas
*win
)
220 if (win
->m_glContext
/* && win->m_exposed*/)
222 wxPaintEvent
event( win
->GetId() );
223 event
.SetEventObject( win
);
224 win
->GetEventHandler()->ProcessEvent( event
);
226 win
->m_exposed
= FALSE
;
227 win
->GetUpdateRegion().Clear();
234 //-----------------------------------------------------------------------------
235 // "expose_event" of m_wxwindow
236 //-----------------------------------------------------------------------------
240 gtk_glwindow_expose_callback( GtkWidget
*WXUNUSED(widget
), GdkEventExpose
*gdk_event
, wxGLCanvas
*win
)
243 wxapp_install_idle_handler();
245 win
->m_exposed
= TRUE
;
247 win
->GetUpdateRegion().Union( gdk_event
->area
.x
,
249 gdk_event
->area
.width
,
250 gdk_event
->area
.height
);
254 //-----------------------------------------------------------------------------
255 // "draw" of m_wxwindow
256 //-----------------------------------------------------------------------------
260 gtk_glwindow_draw_callback( GtkWidget
*WXUNUSED(widget
), GdkRectangle
*rect
, wxGLCanvas
*win
)
263 wxapp_install_idle_handler();
265 win
->m_exposed
= TRUE
;
267 win
->GetUpdateRegion().Union( rect
->x
, rect
->y
,
268 rect
->width
, rect
->height
);
272 //-----------------------------------------------------------------------------
273 // "size_allocate" of m_wxwindow
274 //-----------------------------------------------------------------------------
278 gtk_glcanvas_size_callback( GtkWidget
*WXUNUSED(widget
), GtkAllocation
* alloc
, wxGLCanvas
*win
)
281 wxapp_install_idle_handler();
286 wxSizeEvent
event( wxSize(win
->m_width
,win
->m_height
), win
->GetId() );
287 event
.SetEventObject( win
);
288 win
->GetEventHandler()->ProcessEvent( event
);
292 //---------------------------------------------------------------------------
294 //---------------------------------------------------------------------------
296 IMPLEMENT_CLASS(wxGLCanvas
, wxWindow
)
298 BEGIN_EVENT_TABLE(wxGLCanvas
, wxWindow
)
299 EVT_SIZE(wxGLCanvas::OnSize
)
302 wxGLCanvas::wxGLCanvas( wxWindow
*parent
, wxWindowID id
,
303 const wxPoint
& pos
, const wxSize
& size
,
304 long style
, const wxString
& name
,
306 const wxPalette
& palette
)
308 Create( parent
, NULL
, NULL
, id
, pos
, size
, style
, name
, attribList
, palette
);
311 wxGLCanvas::wxGLCanvas( wxWindow
*parent
,
312 const wxGLContext
*shared
,
314 const wxPoint
& pos
, const wxSize
& size
,
315 long style
, const wxString
& name
,
317 const wxPalette
& palette
)
319 Create( parent
, shared
, NULL
, id
, pos
, size
, style
, name
, attribList
, palette
);
322 wxGLCanvas::wxGLCanvas( wxWindow
*parent
,
323 const wxGLCanvas
*shared
,
325 const wxPoint
& pos
, const wxSize
& size
,
326 long style
, const wxString
& name
,
328 const wxPalette
& palette
)
330 Create( parent
, NULL
, shared
, id
, pos
, size
, style
, name
, attribList
, palette
);
333 bool wxGLCanvas::Create( wxWindow
*parent
,
334 const wxGLContext
*shared
,
335 const wxGLCanvas
*shared_context_of
,
337 const wxPoint
& pos
, const wxSize
& size
,
338 long style
, const wxString
& name
,
340 const wxPalette
& palette
)
342 m_sharedContext
= (wxGLContext
*)shared
; // const_cast
343 m_sharedContextOf
= (wxGLCanvas
*)shared_context_of
; // const_cast
344 m_glContext
= (wxGLContext
*) NULL
;
348 m_nativeSizeEvent
= TRUE
;
352 // to be sure the glx version is known
353 wxGLCanvas::QueryGLXVersion();
355 if (wxGLCanvas::GetGLXVersion() >= 13)
357 // GLX >= 1.3 uses a GLXFBConfig
358 GLXFBConfig
* fbc
= NULL
;
359 if (wxTheApp
->m_glFBCInfo
!= NULL
)
361 fbc
= (GLXFBConfig
*) wxTheApp
->m_glFBCInfo
;
362 m_canFreeFBC
= FALSE
; // owned by wxTheApp - don't free upon destruction
366 fbc
= (GLXFBConfig
*) wxGLCanvas::ChooseGLFBC(attribList
);
369 m_fbc
= fbc
; // save for later use
370 wxCHECK_MSG( m_fbc
, FALSE
, _T("required FBConfig couldn't be found") );
373 XVisualInfo
*vi
= NULL
;
374 if (wxTheApp
->m_glVisualInfo
!= NULL
)
376 vi
= (XVisualInfo
*)wxTheApp
->m_glVisualInfo
;
377 m_canFreeVi
= FALSE
; // owned by wxTheApp - don't free upon destruction
381 if (wxGLCanvas::GetGLXVersion() >= 13)
383 vi
= glXGetVisualFromFBConfig(GDK_DISPLAY(), m_fbc
[0]);
386 vi
= (XVisualInfo
*) ChooseGLVisual(attribList
);
391 m_vi
= vi
; // save for later use
393 wxCHECK_MSG( m_vi
, FALSE
, _T("required visual couldn't be found") );
395 GdkColormap
*colormap
;
397 // MR: This needs a fix for lower gtk+ versions too. Might need to rethink logic (FIXME)
399 if (!gtk_check_version(2,2,0))
401 wxWindow::Create( parent
, id
, pos
, size
, style
, name
);
403 m_glWidget
= m_wxwindow
;
405 GdkScreen
*screen
= gtk_widget_get_screen( m_glWidget
);
406 colormap
= gdk_screen_get_default_colormap(screen
);
407 visual
= gdk_colormap_get_visual(colormap
);
409 if (GDK_VISUAL_XVISUAL(visual
)->visualid
!= vi
->visualid
)
411 visual
= gdk_x11_screen_lookup_visual( screen
, vi
->visualid
);
412 colormap
= gdk_colormap_new(visual
, FALSE
);
415 gtk_widget_set_colormap( m_glWidget
, colormap
);
420 visual
= gdkx_visual_get( vi
->visualid
);
421 colormap
= gdk_colormap_new( visual
, TRUE
);
423 gtk_widget_push_colormap( colormap
);
424 gtk_widget_push_visual( visual
);
426 wxWindow::Create( parent
, id
, pos
, size
, style
, name
);
427 m_glWidget
= m_wxwindow
;
430 gtk_pizza_set_clear( GTK_PIZZA(m_wxwindow
), FALSE
);
432 gtk_signal_connect( GTK_OBJECT(m_wxwindow
), "realize",
433 GTK_SIGNAL_FUNC(gtk_glwindow_realized_callback
), (gpointer
) this );
435 gtk_signal_connect( GTK_OBJECT(m_wxwindow
), "map",
436 GTK_SIGNAL_FUNC(gtk_glwindow_map_callback
), (gpointer
) this );
438 gtk_signal_connect( GTK_OBJECT(m_wxwindow
), "expose_event",
439 GTK_SIGNAL_FUNC(gtk_glwindow_expose_callback
), (gpointer
)this );
441 gtk_signal_connect( GTK_OBJECT(m_wxwindow
), "draw",
442 GTK_SIGNAL_FUNC(gtk_glwindow_draw_callback
), (gpointer
)this );
444 gtk_signal_connect( GTK_OBJECT(m_widget
), "size_allocate",
445 GTK_SIGNAL_FUNC(gtk_glcanvas_size_callback
), (gpointer
)this );
447 gtk_widget_pop_visual();
448 gtk_widget_pop_colormap();
450 // if our parent window is already visible, we had been realized before we
451 // connected to the "realize" signal and hence our m_glContext hasn't been
452 // initialized yet and we have to do it now
453 if (GTK_WIDGET_REALIZED(m_wxwindow
))
454 gtk_glwindow_realized_callback( m_wxwindow
, this );
456 if (GTK_WIDGET_MAPPED(m_wxwindow
))
457 gtk_glwindow_map_callback( m_wxwindow
, this );
462 wxGLCanvas::~wxGLCanvas()
464 GLXFBConfig
* fbc
= (GLXFBConfig
*) m_fbc
;
465 if (fbc
&& m_canFreeFBC
)
468 XVisualInfo
*vi
= (XVisualInfo
*) m_vi
;
469 if (vi
&& m_canFreeVi
)
475 void* wxGLCanvas::ChooseGLVisual(int *attribList
)
478 GetGLAttribListFromWX( attribList
, data
);
479 attribList
= (int*) data
;
481 Display
*dpy
= GDK_DISPLAY();
483 return glXChooseVisual( dpy
, DefaultScreen(dpy
), attribList
);
486 void* wxGLCanvas::ChooseGLFBC(int *attribList
)
489 GetGLAttribListFromWX( attribList
, data
);
490 attribList
= (int*) data
;
493 return glXChooseFBConfig( GDK_DISPLAY(), DefaultScreen(GDK_DISPLAY()),
494 attribList
, &returned
);
498 void wxGLCanvas::GetGLAttribListFromWX(int *wx_attribList
, int *gl_attribList
)
502 if (wxGLCanvas::GetGLXVersion() >= 13)
503 // leave GLX >= 1.3 choose the default attributes
504 gl_attribList
[0] = 0;
508 // default settings if attriblist = 0
509 gl_attribList
[i
++] = GLX_RGBA
;
510 gl_attribList
[i
++] = GLX_DOUBLEBUFFER
;
511 gl_attribList
[i
++] = GLX_DEPTH_SIZE
; gl_attribList
[i
++] = 1;
512 gl_attribList
[i
++] = GLX_RED_SIZE
; gl_attribList
[i
++] = 1;
513 gl_attribList
[i
++] = GLX_GREEN_SIZE
; gl_attribList
[i
++] = 1;
514 gl_attribList
[i
++] = GLX_BLUE_SIZE
; gl_attribList
[i
++] = 1;
515 gl_attribList
[i
++] = GLX_ALPHA_SIZE
; gl_attribList
[i
++] = 0;
516 gl_attribList
[i
++] = None
;
522 while( (wx_attribList
[arg
]!=0) && (p
<510) )
524 switch( wx_attribList
[arg
++] )
527 if (wxGLCanvas::GetGLXVersion() <= 12)
528 // for GLX >= 1.3, GLX_RGBA is useless (setting this flags will crash on most opengl implm)
529 gl_attribList
[p
++] = GLX_RGBA
;
531 case WX_GL_BUFFER_SIZE
:
532 gl_attribList
[p
++] = GLX_BUFFER_SIZE
;
533 gl_attribList
[p
++] = wx_attribList
[arg
++];
536 gl_attribList
[p
++] = GLX_LEVEL
;
537 gl_attribList
[p
++] = wx_attribList
[arg
++];
539 case WX_GL_DOUBLEBUFFER
:
540 if (wxGLCanvas::GetGLXVersion() <= 12)
541 gl_attribList
[p
++] = GLX_DOUBLEBUFFER
;
543 // for GLX >= 1.3, GLX_DOUBLEBUFFER format is different (1 <=> True)
544 // it seems this flag is useless for some hardware opengl implementation.
545 // but for Mesa 6.2.1, this flag is used so don't ignore it.
546 gl_attribList
[p
++] = GLX_DOUBLEBUFFER
;
547 gl_attribList
[p
++] = 1;
550 gl_attribList
[p
++] = GLX_STEREO
;
552 case WX_GL_AUX_BUFFERS
:
553 gl_attribList
[p
++] = GLX_AUX_BUFFERS
;
554 gl_attribList
[p
++] = wx_attribList
[arg
++];
557 gl_attribList
[p
++] = GLX_RED_SIZE
;
558 gl_attribList
[p
++] = wx_attribList
[arg
++];
560 case WX_GL_MIN_GREEN
:
561 gl_attribList
[p
++] = GLX_GREEN_SIZE
;
562 gl_attribList
[p
++] = wx_attribList
[arg
++];
565 gl_attribList
[p
++] = GLX_BLUE_SIZE
;
566 gl_attribList
[p
++] = wx_attribList
[arg
++];
568 case WX_GL_MIN_ALPHA
:
569 gl_attribList
[p
++] = GLX_ALPHA_SIZE
;
570 gl_attribList
[p
++] = wx_attribList
[arg
++];
572 case WX_GL_DEPTH_SIZE
:
573 gl_attribList
[p
++] = GLX_DEPTH_SIZE
;
574 gl_attribList
[p
++] = wx_attribList
[arg
++];
576 case WX_GL_STENCIL_SIZE
:
577 gl_attribList
[p
++] = GLX_STENCIL_SIZE
;
578 gl_attribList
[p
++] = wx_attribList
[arg
++];
580 case WX_GL_MIN_ACCUM_RED
:
581 gl_attribList
[p
++] = GLX_ACCUM_RED_SIZE
;
582 gl_attribList
[p
++] = wx_attribList
[arg
++];
584 case WX_GL_MIN_ACCUM_GREEN
:
585 gl_attribList
[p
++] = GLX_ACCUM_GREEN_SIZE
;
586 gl_attribList
[p
++] = wx_attribList
[arg
++];
588 case WX_GL_MIN_ACCUM_BLUE
:
589 gl_attribList
[p
++] = GLX_ACCUM_BLUE_SIZE
;
590 gl_attribList
[p
++] = wx_attribList
[arg
++];
592 case WX_GL_MIN_ACCUM_ALPHA
:
593 gl_attribList
[p
++] = GLX_ACCUM_ALPHA_SIZE
;
594 gl_attribList
[p
++] = wx_attribList
[arg
++];
601 gl_attribList
[p
] = 0;
605 void wxGLCanvas::QueryGLXVersion()
607 if (m_glxVersion
== 0)
609 // check the GLX version
610 int glxMajorVer
, glxMinorVer
;
611 bool ok
= glXQueryVersion(GDK_DISPLAY(), &glxMajorVer
, &glxMinorVer
);
612 wxASSERT_MSG( ok
, _T("GLX version not found") );
614 m_glxVersion
= 10; // 1.0 by default
616 m_glxVersion
= glxMajorVer
*10 + glxMinorVer
;
620 int wxGLCanvas::GetGLXVersion()
622 wxASSERT_MSG( m_glxVersion
>0, _T("GLX version has not been initialized with wxGLCanvas::QueryGLXVersion()") );
627 void wxGLCanvas::SwapBuffers()
630 m_glContext
->SwapBuffers();
633 void wxGLCanvas::OnSize(wxSizeEvent
& WXUNUSED(event
))
637 void wxGLCanvas::SetCurrent()
640 m_glContext
->SetCurrent();
643 void wxGLCanvas::SetColour( const wxChar
*colour
)
646 m_glContext
->SetColour( colour
);
649 void wxGLCanvas::OnInternalIdle()
651 if (m_glContext
&& m_exposed
)
653 wxPaintEvent
event( GetId() );
654 event
.SetEventObject( this );
655 GetEventHandler()->ProcessEvent( event
);
658 GetUpdateRegion().Clear();
661 wxWindow::OnInternalIdle();
666 //---------------------------------------------------------------------------
668 //---------------------------------------------------------------------------
670 IMPLEMENT_CLASS(wxGLApp
, wxApp
)
677 XFree(m_glVisualInfo
);
680 bool wxGLApp::InitGLVisual(int *attribList
)
682 wxGLCanvas::QueryGLXVersion();
684 if (wxGLCanvas::GetGLXVersion() >= 13)
689 m_glFBCInfo
= wxGLCanvas::ChooseGLFBC(attribList
);
694 XFree(m_glVisualInfo
);
695 m_glVisualInfo
= glXGetVisualFromFBConfig(GDK_DISPLAY(), ((GLXFBConfig
*)m_glFBCInfo
)[0]);
697 return (m_glFBCInfo
!= NULL
) && (m_glVisualInfo
!= NULL
);
703 XFree(m_glVisualInfo
);
704 m_glVisualInfo
= wxGLCanvas::ChooseGLVisual(attribList
);
705 return m_glVisualInfo
!= NULL
;