src/gtk/glcanvas.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        gtk/glcanvas.cpp
   3 // Purpose:     wxGLCanvas, for using OpenGL/Mesa with wxWindows 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     float r = 0.0;
 134     float g = 0.0;
 135     float b = 0.0;
 136     wxColour *col = wxTheColourDatabase->FindColour(colour);
 137     if (col)
 138     {
 139         r = (float)(col->Red()/256.0);
 140         g = (float)(col->Green()/256.0);
 141         b = (float)(col->Blue()/256.0);
 142         glColor3f( r, g, b);
 143     }
 144 }
 145
 146 void wxGLContext::SetupPixelFormat()
 147 {
 148 }
 149
 150 void wxGLContext::SetupPalette( const wxPalette& WXUNUSED(palette) )
 151 {
 152 }
 153
 154 wxPalette wxGLContext::CreateDefaultPalette()
 155 {
 156     return wxNullPalette;
 157 }
 158
 159 //-----------------------------------------------------------------------------
 160 // "realize" from m_wxwindow
 161 //-----------------------------------------------------------------------------
 162
 163 static gint
 164 gtk_glwindow_realized_callback( GtkWidget * WXUNUSED(widget), wxGLCanvas *win )
 165 {
 166     wxGLContext *share= win->m_sharedContext;
 167     if (share==NULL && win->m_sharedContextOf) share=win->m_sharedContextOf->GetContext();
 168
 169     win->m_glContext = new wxGLContext( TRUE, win, wxNullPalette, share );
 170
 171     return FALSE;
 172 }
 173
 174 //-----------------------------------------------------------------------------
 175 // "map" from m_wxwindow
 176 //-----------------------------------------------------------------------------
 177
 178 static gint
 179 gtk_glwindow_map_callback( GtkWidget * WXUNUSED(widget), wxGLCanvas *win )
 180 {
 181     if (win->m_glContext/* && win->m_exposed*/)
 182     {
 183         wxPaintEvent event( win->GetId() );
 184         event.SetEventObject( win );
 185         win->GetEventHandler()->ProcessEvent( event );
 186
 187         win->m_exposed = FALSE;
 188         win->GetUpdateRegion().Clear();
 189     }
 190
 191     return FALSE;
 192 }
 193
 194 //-----------------------------------------------------------------------------
 195 // "expose_event" of m_wxwindow
 196 //-----------------------------------------------------------------------------
 197
 198 static void
 199 gtk_glwindow_expose_callback( GtkWidget *WXUNUSED(widget), GdkEventExpose *gdk_event, wxGLCanvas *win )
 200 {
 201     if (g_isIdle)
 202         wxapp_install_idle_handler();
 203
 204     win->m_exposed = TRUE;
 205
 206     win->GetUpdateRegion().Union( gdk_event->area.x,
 207                                   gdk_event->area.y,
 208                                   gdk_event->area.width,
 209                                   gdk_event->area.height );
 210 }
 211
 212 //-----------------------------------------------------------------------------
 213 // "draw" of m_wxwindow
 214 //-----------------------------------------------------------------------------
 215
 216 #ifndef __WXGTK20__
 217 static void
 218 gtk_glwindow_draw_callback( GtkWidget *WXUNUSED(widget), GdkRectangle *rect, wxGLCanvas *win )
 219 {
 220     if (g_isIdle)
 221         wxapp_install_idle_handler();
 222
 223     win->m_exposed = TRUE;
 224
 225     win->GetUpdateRegion().Union( rect->x, rect->y,
 226                                   rect->width, rect->height );
 227 }
 228 #endif
 229
 230 //-----------------------------------------------------------------------------
 231 // "size_allocate" of m_wxwindow
 232 //-----------------------------------------------------------------------------
 233
 234 static void
 235 gtk_glcanvas_size_callback( GtkWidget *WXUNUSED(widget), GtkAllocation* alloc, wxGLCanvas *win )
 236 {
 237     if (g_isIdle)
 238         wxapp_install_idle_handler();
 239
 240     if (!win->m_hasVMT)
 241         return;
 242
 243     wxSizeEvent event( wxSize(win->m_width,win->m_height), win->GetId() );
 244     event.SetEventObject( win );
 245     win->GetEventHandler()->ProcessEvent( event );
 246 }
 247
 248 //---------------------------------------------------------------------------
 249 // wxGlCanvas
 250 //---------------------------------------------------------------------------
 251
 252 IMPLEMENT_CLASS(wxGLCanvas, wxWindow)
 253
 254 BEGIN_EVENT_TABLE(wxGLCanvas, wxWindow)
 255     EVT_SIZE(wxGLCanvas::OnSize)
 256 END_EVENT_TABLE()
 257
 258 wxGLCanvas::wxGLCanvas( wxWindow *parent, wxWindowID id,
 259                         const wxPoint& pos, const wxSize& size,
 260                         long style, const wxString& name,
 261                         int *attribList,
 262                         const wxPalette& palette )
 263 {
 264     Create( parent, NULL, NULL, id, pos, size, style, name, attribList, palette );
 265 }
 266
 267 wxGLCanvas::wxGLCanvas( wxWindow *parent,
 268                         const wxGLContext *shared,
 269                         wxWindowID id,
 270                         const wxPoint& pos, const wxSize& size,
 271                         long style, const wxString& name,
 272                         int *attribList,
 273                         const wxPalette& palette )
 274 {
 275     Create( parent, shared, NULL, id, pos, size, style, name, attribList, palette );
 276 }
 277
 278 wxGLCanvas::wxGLCanvas( wxWindow *parent,
 279                         const wxGLCanvas *shared,
 280                         wxWindowID id,
 281                         const wxPoint& pos, const wxSize& size,
 282                         long style, const wxString& name,
 283                         int *attribList,
 284                         const wxPalette& palette )
 285 {
 286     Create( parent, NULL, shared, id, pos, size, style, name, attribList, palette );
 287 }
 288
 289 bool wxGLCanvas::Create( wxWindow *parent,
 290                          const wxGLContext *shared,
 291                          const wxGLCanvas *shared_context_of,
 292                          wxWindowID id,
 293                          const wxPoint& pos, const wxSize& size,
 294                          long style, const wxString& name,
 295                          int *attribList,
 296                          const wxPalette& palette)
 297 {
 298     m_sharedContext = (wxGLContext*)shared;  // const_cast
 299     m_sharedContextOf = (wxGLCanvas*)shared_context_of;  // const_cast
 300     m_glContext = (wxGLContext*) NULL;
 301
 302     m_exposed = FALSE;
 303     m_noExpose = TRUE;
 304     m_nativeSizeEvent = TRUE;
 305
 306     XVisualInfo *vi = NULL;
 307     if (wxTheApp->m_glVisualInfo != NULL)
 308     {
 309         vi = (XVisualInfo *) wxTheApp->m_glVisualInfo;
 310         m_canFreeVi = FALSE; // owned by wxTheApp - don't free upon destruction
 311     }
 312     else
 313     {
 314         vi = (XVisualInfo *) ChooseGLVisual(attribList);
 315         m_canFreeVi = TRUE;
 316     }
 317     m_vi = vi;  // save for later use
 318
 319     wxCHECK_MSG( m_vi, FALSE, _T("required visual couldn't be found") );
 320
 321     GdkVisual *visual = gdkx_visual_get( vi->visualid );
 322     GdkColormap *colormap = gdk_colormap_new( gdkx_visual_get(vi->visualid), TRUE );
 323
 324     gtk_widget_push_colormap( colormap );
 325     gtk_widget_push_visual( visual );
 326
 327     wxWindow::Create( parent, id, pos, size, style, name );
 328
 329     m_glWidget = m_wxwindow;
 330
 331 #ifdef __WXGTK20__
 332     gtk_widget_set_double_buffered( m_glWidget, FALSE );
 333 #endif
 334
 335     gtk_pizza_set_clear( GTK_PIZZA(m_wxwindow), FALSE );
 336
 337     gtk_signal_connect( GTK_OBJECT(m_wxwindow), "realize",
 338                             GTK_SIGNAL_FUNC(gtk_glwindow_realized_callback), (gpointer) this );
 339
 340     gtk_signal_connect( GTK_OBJECT(m_wxwindow), "map",
 341                             GTK_SIGNAL_FUNC(gtk_glwindow_map_callback), (gpointer) this );
 342
 343     gtk_signal_connect( GTK_OBJECT(m_wxwindow), "expose_event",
 344         GTK_SIGNAL_FUNC(gtk_glwindow_expose_callback), (gpointer)this );
 345
 346 #ifndef __WXGTK20__
 347     gtk_signal_connect( GTK_OBJECT(m_wxwindow), "draw",
 348         GTK_SIGNAL_FUNC(gtk_glwindow_draw_callback), (gpointer)this );
 349 #endif
 350
 351     gtk_signal_connect( GTK_OBJECT(m_widget), "size_allocate",
 352         GTK_SIGNAL_FUNC(gtk_glcanvas_size_callback), (gpointer)this );
 353
 354     gtk_widget_pop_visual();
 355     gtk_widget_pop_colormap();
 356
 357     if (GTK_WIDGET_REALIZED(m_wxwindow))
 358         gtk_glwindow_realized_callback( m_wxwindow, this );
 359
 360     if (GTK_WIDGET_MAPPED(m_wxwindow))
 361         gtk_glwindow_map_callback( m_wxwindow, this );
 362
 363     return TRUE;
 364 }
 365
 366 wxGLCanvas::~wxGLCanvas()
 367 {
 368     XVisualInfo *vi = (XVisualInfo *) m_vi;
 369
 370     if (vi && m_canFreeVi) XFree( vi );
 371     if (m_glContext) delete m_glContext;
 372 }
 373
 374 void* wxGLCanvas::ChooseGLVisual(int *attribList)
 375 {
 376     int data[512];
 377     if (!attribList)
 378     {
 379         // default settings if attriblist = 0
 380         data[0] = GLX_RGBA;
 381         data[1] = GLX_DOUBLEBUFFER;
 382         data[2] = GLX_DEPTH_SIZE;   data[3] = 1;
 383         data[4] = GLX_RED_SIZE;     data[5] = 1;
 384         data[6] = GLX_GREEN_SIZE;   data[7] = 1;
 385         data[8] = GLX_BLUE_SIZE;    data[9] = 1;
 386         data[10] = GLX_ALPHA_SIZE;  data[11] = 0;
 387         data[12] = None;
 388
 389         attribList = (int*) data;
 390     }
 391     else
 392     {
 393       int arg=0, p=0;
 394
 395       while( (attribList[arg]!=0) && (p<510) )
 396       {
 397         switch( attribList[arg++] )
 398         {
 399           case WX_GL_RGBA: data[p++] = GLX_RGBA; break;
 400           case WX_GL_BUFFER_SIZE:
 401             data[p++]=GLX_BUFFER_SIZE; data[p++]=attribList[arg++]; break;
 402           case WX_GL_LEVEL:
 403             data[p++]=GLX_LEVEL; data[p++]=attribList[arg++]; break;
 404           case WX_GL_DOUBLEBUFFER: data[p++] = GLX_DOUBLEBUFFER; break;
 405           case WX_GL_STEREO: data[p++] = GLX_STEREO; break;
 406           case WX_GL_AUX_BUFFERS:
 407             data[p++]=GLX_AUX_BUFFERS; data[p++]=attribList[arg++]; break;
 408           case WX_GL_MIN_RED:
 409             data[p++]=GLX_RED_SIZE; data[p++]=attribList[arg++]; break;
 410           case WX_GL_MIN_GREEN:
 411             data[p++]=GLX_GREEN_SIZE; data[p++]=attribList[arg++]; break;
 412           case WX_GL_MIN_BLUE:
 413             data[p++]=GLX_BLUE_SIZE; data[p++]=attribList[arg++]; break;
 414           case WX_GL_MIN_ALPHA:
 415             data[p++]=GLX_ALPHA_SIZE; data[p++]=attribList[arg++]; break;
 416           case WX_GL_DEPTH_SIZE:
 417             data[p++]=GLX_DEPTH_SIZE; data[p++]=attribList[arg++]; break;
 418           case WX_GL_STENCIL_SIZE:
 419             data[p++]=GLX_STENCIL_SIZE; data[p++]=attribList[arg++]; break;
 420           case WX_GL_MIN_ACCUM_RED:
 421             data[p++]=GLX_ACCUM_RED_SIZE; data[p++]=attribList[arg++]; break;
 422           case WX_GL_MIN_ACCUM_GREEN:
 423             data[p++]=GLX_ACCUM_GREEN_SIZE; data[p++]=attribList[arg++]; break;
 424           case WX_GL_MIN_ACCUM_BLUE:
 425             data[p++]=GLX_ACCUM_BLUE_SIZE; data[p++]=attribList[arg++]; break;
 426           case WX_GL_MIN_ACCUM_ALPHA:
 427             data[p++]=GLX_ACCUM_ALPHA_SIZE; data[p++]=attribList[arg++]; break;
 428           default:
 429             break;
 430         }
 431       }
 432       data[p] = 0;
 433
 434       attribList = (int*) data;
 435     }
 436
 437
 438     Display *dpy = GDK_DISPLAY();
 439
 440     return glXChooseVisual( dpy, DefaultScreen(dpy), attribList );
 441 }
 442
 443 void wxGLCanvas::SwapBuffers()
 444 {
 445     if (m_glContext)
 446         m_glContext->SwapBuffers();
 447 }
 448
 449 void wxGLCanvas::OnSize(wxSizeEvent& WXUNUSED(event))
 450 {
 451 }
 452
 453 void wxGLCanvas::SetCurrent()
 454 {
 455     if (m_glContext)
 456         m_glContext->SetCurrent();
 457 }
 458
 459 void wxGLCanvas::SetColour( const wxChar *colour )
 460 {
 461     if (m_glContext)
 462         m_glContext->SetColour( colour );
 463 }
 464
 465 void wxGLCanvas::OnInternalIdle()
 466 {
 467     if (m_glContext && m_exposed)
 468     {
 469         wxPaintEvent event( GetId() );
 470         event.SetEventObject( this );
 471         GetEventHandler()->ProcessEvent( event );
 472
 473         m_exposed = FALSE;
 474         GetUpdateRegion().Clear();
 475     }
 476
 477     wxWindow::OnInternalIdle();
 478 }
 479
 480
 481
 482 //---------------------------------------------------------------------------
 483 // wxGLApp
 484 //---------------------------------------------------------------------------
 485
 486 IMPLEMENT_CLASS(wxGLApp, wxApp)
 487
 488 wxGLApp::~wxGLApp()
 489 {
 490     if (m_glVisualInfo)
 491         XFree(m_glVisualInfo);
 492 }
 493
 494 bool wxGLApp::InitGLVisual(int *attribList)
 495 {
 496     if (m_glVisualInfo)
 497         XFree(m_glVisualInfo);
 498
 499     m_glVisualInfo = wxGLCanvas::ChooseGLVisual(attribList);
 500
 501     return m_glVisualInfo != NULL;
 502 }
 503
 504 #endif
 505     // wxUSE_GLCANVAS
 506