src/gtk/glcanvas.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        gtk/glcanvas.cpp
   3 // Purpose:     wxGLCanvas, for using OpenGL/Mesa with wxWidgets and GTK
   4 // Author:      Robert Roebling
   5 // Modified by:
   6 // Created:     17/08/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Robert Roebling
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  13 #pragma implementation "glcanvas.h"
  14 #endif
  15
  16 // For compilers that support precompilation, includes "wx.h".
  17 #include "wx/wxprec.h"
  18
  19 #include "wx/setup.h"
  20
  21 #if wxUSE_GLCANVAS
  22
  23 #include "wx/glcanvas.h"
  24
  25 #include "wx/frame.h"
  26 #include "wx/colour.h"
  27 #include "wx/module.h"
  28 #include "wx/app.h"
  29
  30 extern "C"
  31 {
  32 #include "gtk/gtk.h"
  33 #include "gdk/gdk.h"
  34 #include "gdk/gdkx.h"
  35 }
  36
  37 #include "wx/gtk/win_gtk.h"
  38
  39 // DLL options compatibility check:
  40 #include "wx/build.h"
  41 WX_CHECK_BUILD_OPTIONS("wxGL")
  42
  43 //---------------------------------------------------------------------------
  44 // global data
  45 //---------------------------------------------------------------------------
  46
  47 XVisualInfo *g_vi = (XVisualInfo*) NULL;
  48
  49 //-----------------------------------------------------------------------------
  50 // idle system
  51 //-----------------------------------------------------------------------------
  52
  53 extern void wxapp_install_idle_handler();
  54 extern bool g_isIdle;
  55
  56 //---------------------------------------------------------------------------
  57 // wxGLContext
  58 //---------------------------------------------------------------------------
  59
  60 IMPLEMENT_CLASS(wxGLContext,wxObject)
  61
  62 wxGLContext::wxGLContext( bool WXUNUSED(isRGB), wxWindow *win, const wxPalette& WXUNUSED(palette) )
  63 {
  64     m_window = win;
  65     m_widget = win->m_wxwindow;
  66
  67     wxGLCanvas *gc = (wxGLCanvas*) win;
  68     XVisualInfo *vi = (XVisualInfo *) gc->m_vi;
  69
  70     wxCHECK_RET( vi, _T("invalid visual for OpenGl") );
  71
  72     m_glContext = glXCreateContext( GDK_DISPLAY(), vi, None, GL_TRUE );
  73
  74     wxCHECK_RET( m_glContext, _T("Couldn't create OpenGl context") );
  75 }
  76
  77 wxGLContext::wxGLContext(
  78                bool WXUNUSED(isRGB), wxWindow *win,
  79                const wxPalette& WXUNUSED(palette),
  80                const wxGLContext *other        /* for sharing display lists */
  81 )
  82 {
  83     m_window = win;
  84     m_widget = win->m_wxwindow;
  85
  86     wxGLCanvas *gc = (wxGLCanvas*) win;
  87     XVisualInfo *vi = (XVisualInfo *) gc->m_vi;
  88
  89     wxCHECK_RET( vi, _T("invalid visual for OpenGl") );
  90
  91     m_glContext = glXCreateContext( GDK_DISPLAY(), vi,
  92                                     other ? other->m_glContext : None,
  93                                     GL_TRUE );
  94
  95     if ( !m_glContext )
  96     {
  97         wxFAIL_MSG( _T("Couldn't create OpenGl context") );
  98     }
  99 }
 100
 101 wxGLContext::~wxGLContext()
 102 {
 103     if (!m_glContext) return;
 104
 105     if (m_glContext == glXGetCurrentContext())
 106     {
 107         glXMakeCurrent( GDK_DISPLAY(), None, NULL);
 108     }
 109
 110     glXDestroyContext( GDK_DISPLAY(), m_glContext );
 111 }
 112
 113 void wxGLContext::SwapBuffers()
 114 {
 115     if (m_glContext)
 116     {
 117         GdkWindow *window = GTK_PIZZA(m_widget)->bin_window;
 118         glXSwapBuffers( GDK_DISPLAY(), GDK_WINDOW_XWINDOW( window ) );
 119     }
 120 }
 121
 122 void wxGLContext::SetCurrent()
 123 {
 124     if (m_glContext)
 125     {
 126         GdkWindow *window = GTK_PIZZA(m_widget)->bin_window;
 127         glXMakeCurrent( GDK_DISPLAY(), GDK_WINDOW_XWINDOW(window), m_glContext );
 128     }
 129 }
 130
 131 void wxGLContext::SetColour(const wxChar *colour)
 132 {
 133     wxColour col = wxTheColourDatabase->Find(colour);
 134     if (col.Ok())
 135     {
 136         float r = (float)(col.Red()/256.0);
 137         float g = (float)(col.Green()/256.0);
 138         float b = (float)(col.Blue()/256.0);
 139         glColor3f( r, g, b);
 140     }
 141 }
 142
 143 void wxGLContext::SetupPixelFormat()
 144 {
 145 }
 146
 147 void wxGLContext::SetupPalette( const wxPalette& WXUNUSED(palette) )
 148 {
 149 }
 150
 151 wxPalette wxGLContext::CreateDefaultPalette()
 152 {
 153     return wxNullPalette;
 154 }
 155
 156 //-----------------------------------------------------------------------------
 157 // "realize" from m_wxwindow
 158 //-----------------------------------------------------------------------------
 159
 160 static gint
 161 gtk_glwindow_realized_callback( GtkWidget * WXUNUSED(widget), wxGLCanvas *win )
 162 {
 163     if ( !win->m_glContext )
 164     {
 165         wxGLContext *share = win->m_sharedContext;
 166         if ( !share && win->m_sharedContextOf )
 167             share = win->m_sharedContextOf->GetContext();
 168
 169         win->m_glContext = new wxGLContext( TRUE, win, wxNullPalette, share );
 170     }
 171
 172     return FALSE;
 173 }
 174
 175 //-----------------------------------------------------------------------------
 176 // "map" from m_wxwindow
 177 //-----------------------------------------------------------------------------
 178
 179 static gint
 180 gtk_glwindow_map_callback( GtkWidget * WXUNUSED(widget), wxGLCanvas *win )
 181 {
 182     if (win->m_glContext/* && win->m_exposed*/)
 183     {
 184         wxPaintEvent event( win->GetId() );
 185         event.SetEventObject( win );
 186         win->GetEventHandler()->ProcessEvent( event );
 187
 188         win->m_exposed = FALSE;
 189         win->GetUpdateRegion().Clear();
 190     }
 191
 192     return FALSE;
 193 }
 194
 195 //-----------------------------------------------------------------------------
 196 // "expose_event" of m_wxwindow
 197 //-----------------------------------------------------------------------------
 198
 199 static void
 200 gtk_glwindow_expose_callback( GtkWidget *WXUNUSED(widget), GdkEventExpose *gdk_event, wxGLCanvas *win )
 201 {
 202     if (g_isIdle)
 203         wxapp_install_idle_handler();
 204
 205     win->m_exposed = TRUE;
 206
 207     win->GetUpdateRegion().Union( gdk_event->area.x,
 208                                   gdk_event->area.y,
 209                                   gdk_event->area.width,
 210                                   gdk_event->area.height );
 211 }
 212
 213 //-----------------------------------------------------------------------------
 214 // "draw" of m_wxwindow
 215 //-----------------------------------------------------------------------------
 216
 217 #ifndef __WXGTK20__
 218 static void
 219 gtk_glwindow_draw_callback( GtkWidget *WXUNUSED(widget), GdkRectangle *rect, wxGLCanvas *win )
 220 {
 221     if (g_isIdle)
 222         wxapp_install_idle_handler();
 223
 224     win->m_exposed = TRUE;
 225
 226     win->GetUpdateRegion().Union( rect->x, rect->y,
 227                                   rect->width, rect->height );
 228 }
 229 #endif
 230
 231 //-----------------------------------------------------------------------------
 232 // "size_allocate" of m_wxwindow
 233 //-----------------------------------------------------------------------------
 234
 235 static void
 236 gtk_glcanvas_size_callback( GtkWidget *WXUNUSED(widget), GtkAllocation* alloc, wxGLCanvas *win )
 237 {
 238     if (g_isIdle)
 239         wxapp_install_idle_handler();
 240
 241     if (!win->m_hasVMT)
 242         return;
 243
 244     wxSizeEvent event( wxSize(win->m_width,win->m_height), win->GetId() );
 245     event.SetEventObject( win );
 246     win->GetEventHandler()->ProcessEvent( event );
 247 }
 248
 249 //---------------------------------------------------------------------------
 250 // wxGlCanvas
 251 //---------------------------------------------------------------------------
 252
 253 IMPLEMENT_CLASS(wxGLCanvas, wxWindow)
 254
 255 BEGIN_EVENT_TABLE(wxGLCanvas, wxWindow)
 256     EVT_SIZE(wxGLCanvas::OnSize)
 257 END_EVENT_TABLE()
 258
 259 wxGLCanvas::wxGLCanvas( wxWindow *parent, wxWindowID id,
 260                         const wxPoint& pos, const wxSize& size,
 261                         long style, const wxString& name,
 262                         int *attribList,
 263                         const wxPalette& palette )
 264 {
 265     Create( parent, NULL, NULL, id, pos, size, style, name, attribList, palette );
 266 }
 267
 268 wxGLCanvas::wxGLCanvas( wxWindow *parent,
 269                         const wxGLContext *shared,
 270                         wxWindowID id,
 271                         const wxPoint& pos, const wxSize& size,
 272                         long style, const wxString& name,
 273                         int *attribList,
 274                         const wxPalette& palette )
 275 {
 276     Create( parent, shared, NULL, id, pos, size, style, name, attribList, palette );
 277 }
 278
 279 wxGLCanvas::wxGLCanvas( wxWindow *parent,
 280                         const wxGLCanvas *shared,
 281                         wxWindowID id,
 282                         const wxPoint& pos, const wxSize& size,
 283                         long style, const wxString& name,
 284                         int *attribList,
 285                         const wxPalette& palette )
 286 {
 287     Create( parent, NULL, shared, id, pos, size, style, name, attribList, palette );
 288 }
 289
 290 bool wxGLCanvas::Create( wxWindow *parent,
 291                          const wxGLContext *shared,
 292                          const wxGLCanvas *shared_context_of,
 293                          wxWindowID id,
 294                          const wxPoint& pos, const wxSize& size,
 295                          long style, const wxString& name,
 296                          int *attribList,
 297                          const wxPalette& palette)
 298 {
 299     m_sharedContext = (wxGLContext*)shared;  // const_cast
 300     m_sharedContextOf = (wxGLCanvas*)shared_context_of;  // const_cast
 301     m_glContext = (wxGLContext*) NULL;
 302
 303     m_exposed = FALSE;
 304     m_noExpose = TRUE;
 305     m_nativeSizeEvent = TRUE;
 306
 307     XVisualInfo *vi = NULL;
 308     if (wxTheApp->m_glVisualInfo != NULL)
 309     {
 310         vi = (XVisualInfo *) wxTheApp->m_glVisualInfo;
 311         m_canFreeVi = FALSE; // owned by wxTheApp - don't free upon destruction
 312     }
 313     else
 314     {
 315         vi = (XVisualInfo *) ChooseGLVisual(attribList);
 316         m_canFreeVi = TRUE;
 317     }
 318     m_vi = vi;  // save for later use
 319
 320     wxCHECK_MSG( m_vi, FALSE, _T("required visual couldn't be found") );
 321
 322     GdkVisual *visual = gdkx_visual_get( vi->visualid );
 323     GdkColormap *colormap = gdk_colormap_new( visual, TRUE );
 324
 325     gtk_widget_push_colormap( colormap );
 326     gtk_widget_push_visual( visual );
 327
 328     wxWindow::Create( parent, id, pos, size, style, name );
 329
 330     m_glWidget = m_wxwindow;
 331
 332 #ifdef __WXGTK20__
 333     gtk_widget_set_double_buffered( m_glWidget, FALSE );
 334 #endif
 335
 336     gtk_pizza_set_clear( GTK_PIZZA(m_wxwindow), FALSE );
 337
 338     gtk_signal_connect( GTK_OBJECT(m_wxwindow), "realize",
 339                             GTK_SIGNAL_FUNC(gtk_glwindow_realized_callback), (gpointer) this );
 340
 341     gtk_signal_connect( GTK_OBJECT(m_wxwindow), "map",
 342                             GTK_SIGNAL_FUNC(gtk_glwindow_map_callback), (gpointer) this );
 343
 344     gtk_signal_connect( GTK_OBJECT(m_wxwindow), "expose_event",
 345         GTK_SIGNAL_FUNC(gtk_glwindow_expose_callback), (gpointer)this );
 346
 347 #ifndef __WXGTK20__
 348     gtk_signal_connect( GTK_OBJECT(m_wxwindow), "draw",
 349         GTK_SIGNAL_FUNC(gtk_glwindow_draw_callback), (gpointer)this );
 350 #endif
 351
 352     gtk_signal_connect( GTK_OBJECT(m_widget), "size_allocate",
 353         GTK_SIGNAL_FUNC(gtk_glcanvas_size_callback), (gpointer)this );
 354
 355     gtk_widget_pop_visual();
 356     gtk_widget_pop_colormap();
 357
 358     // if our parent window is already visible, we had been realized before we
 359     // connected to the "realize" signal and hence our m_glContext hasn't been
 360     // initialized yet and we have to do it now
 361     if (GTK_WIDGET_REALIZED(m_wxwindow))
 362         gtk_glwindow_realized_callback( m_wxwindow, this );
 363
 364     if (GTK_WIDGET_MAPPED(m_wxwindow))
 365         gtk_glwindow_map_callback( m_wxwindow, this );
 366
 367     return TRUE;
 368 }
 369
 370 wxGLCanvas::~wxGLCanvas()
 371 {
 372     XVisualInfo *vi = (XVisualInfo *) m_vi;
 373
 374     if (vi && m_canFreeVi) XFree( vi );
 375     delete m_glContext;
 376 }
 377
 378 void* wxGLCanvas::ChooseGLVisual(int *attribList)
 379 {
 380     int data[512];
 381     if (!attribList)
 382     {
 383         // default settings if attriblist = 0
 384         data[0] = GLX_RGBA;
 385         data[1] = GLX_DOUBLEBUFFER;
 386         data[2] = GLX_DEPTH_SIZE;   data[3] = 1;
 387         data[4] = GLX_RED_SIZE;     data[5] = 1;
 388         data[6] = GLX_GREEN_SIZE;   data[7] = 1;
 389         data[8] = GLX_BLUE_SIZE;    data[9] = 1;
 390         data[10] = GLX_ALPHA_SIZE;  data[11] = 0;
 391         data[12] = None;
 392
 393         attribList = (int*) data;
 394     }
 395     else
 396     {
 397       int arg=0, p=0;
 398
 399       while( (attribList[arg]!=0) && (p<510) )
 400       {
 401         switch( attribList[arg++] )
 402         {
 403           case WX_GL_RGBA: data[p++] = GLX_RGBA; break;
 404           case WX_GL_BUFFER_SIZE:
 405             data[p++]=GLX_BUFFER_SIZE; data[p++]=attribList[arg++]; break;
 406           case WX_GL_LEVEL:
 407             data[p++]=GLX_LEVEL; data[p++]=attribList[arg++]; break;
 408           case WX_GL_DOUBLEBUFFER: data[p++] = GLX_DOUBLEBUFFER; break;
 409           case WX_GL_STEREO: data[p++] = GLX_STEREO; break;
 410           case WX_GL_AUX_BUFFERS:
 411             data[p++]=GLX_AUX_BUFFERS; data[p++]=attribList[arg++]; break;
 412           case WX_GL_MIN_RED:
 413             data[p++]=GLX_RED_SIZE; data[p++]=attribList[arg++]; break;
 414           case WX_GL_MIN_GREEN:
 415             data[p++]=GLX_GREEN_SIZE; data[p++]=attribList[arg++]; break;
 416           case WX_GL_MIN_BLUE:
 417             data[p++]=GLX_BLUE_SIZE; data[p++]=attribList[arg++]; break;
 418           case WX_GL_MIN_ALPHA:
 419             data[p++]=GLX_ALPHA_SIZE; data[p++]=attribList[arg++]; break;
 420           case WX_GL_DEPTH_SIZE:
 421             data[p++]=GLX_DEPTH_SIZE; data[p++]=attribList[arg++]; break;
 422           case WX_GL_STENCIL_SIZE:
 423             data[p++]=GLX_STENCIL_SIZE; data[p++]=attribList[arg++]; break;
 424           case WX_GL_MIN_ACCUM_RED:
 425             data[p++]=GLX_ACCUM_RED_SIZE; data[p++]=attribList[arg++]; break;
 426           case WX_GL_MIN_ACCUM_GREEN:
 427             data[p++]=GLX_ACCUM_GREEN_SIZE; data[p++]=attribList[arg++]; break;
 428           case WX_GL_MIN_ACCUM_BLUE:
 429             data[p++]=GLX_ACCUM_BLUE_SIZE; data[p++]=attribList[arg++]; break;
 430           case WX_GL_MIN_ACCUM_ALPHA:
 431             data[p++]=GLX_ACCUM_ALPHA_SIZE; data[p++]=attribList[arg++]; break;
 432           default:
 433             break;
 434         }
 435       }
 436       data[p] = 0;
 437
 438       attribList = (int*) data;
 439     }
 440
 441
 442     Display *dpy = GDK_DISPLAY();
 443
 444     return glXChooseVisual( dpy, DefaultScreen(dpy), attribList );
 445 }
 446
 447 void wxGLCanvas::SwapBuffers()
 448 {
 449     if (m_glContext)
 450         m_glContext->SwapBuffers();
 451 }
 452
 453 void wxGLCanvas::OnSize(wxSizeEvent& WXUNUSED(event))
 454 {
 455 }
 456
 457 void wxGLCanvas::SetCurrent()
 458 {
 459     if (m_glContext)
 460         m_glContext->SetCurrent();
 461 }
 462
 463 void wxGLCanvas::SetColour( const wxChar *colour )
 464 {
 465     if (m_glContext)
 466         m_glContext->SetColour( colour );
 467 }
 468
 469 void wxGLCanvas::OnInternalIdle()
 470 {
 471     if (m_glContext && m_exposed)
 472     {
 473         wxPaintEvent event( GetId() );
 474         event.SetEventObject( this );
 475         GetEventHandler()->ProcessEvent( event );
 476
 477         m_exposed = FALSE;
 478         GetUpdateRegion().Clear();
 479     }
 480
 481     wxWindow::OnInternalIdle();
 482 }
 483
 484
 485
 486 //---------------------------------------------------------------------------
 487 // wxGLApp
 488 //---------------------------------------------------------------------------
 489
 490 IMPLEMENT_CLASS(wxGLApp, wxApp)
 491
 492 wxGLApp::~wxGLApp()
 493 {
 494     if (m_glVisualInfo)
 495         XFree(m_glVisualInfo);
 496 }
 497
 498 bool wxGLApp::InitGLVisual(int *attribList)
 499 {
 500     if (m_glVisualInfo)
 501         XFree(m_glVisualInfo);
 502
 503     m_glVisualInfo = wxGLCanvas::ChooseGLVisual(attribList);
 504
 505     return m_glVisualInfo != NULL;
 506 }
 507
 508 #endif
 509     // wxUSE_GLCANVAS
 510