include/wx/gtk/glcanvas.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        glcanvas.h
   3 // Purpose:     wxGLCanvas, for using OpenGL/Mesa with wxWidgets and GTK
   4 // Author:      Robert Roebling
   5 // Modified by:
   6 // Created:     17/8/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 interface "glcanvas.h"
  14 #endif
  15
  16 #ifndef _WX_GLCANVAS_H_
  17 #define _WX_GLCANVAS_H_
  18
  19 #include "wx/scrolwin.h"
  20 #include "wx/app.h"
  21
  22 extern "C" {
  23 #include <GL/gl.h>
  24 #include <GL/glx.h>
  25 #include <GL/glu.h>
  26 }
  27
  28 //---------------------------------------------------------------------------
  29 // Constants for attriblist
  30 //---------------------------------------------------------------------------
  31
  32 enum
  33 {
  34   WX_GL_RGBA=1,          /* use true color palette */
  35   WX_GL_BUFFER_SIZE,     /* bits for buffer if not WX_GL_RGBA */
  36   WX_GL_LEVEL,           /* 0 for main buffer, >0 for overlay, <0 for underlay */
  37   WX_GL_DOUBLEBUFFER,    /* use doublebuffer */
  38   WX_GL_STEREO,          /* use stereoscopic display */
  39   WX_GL_AUX_BUFFERS,     /* number of auxiliary buffers */
  40   WX_GL_MIN_RED,         /* use red buffer with most bits (> MIN_RED bits) */
  41   WX_GL_MIN_GREEN,       /* use green buffer with most bits (> MIN_GREEN bits) */
  42   WX_GL_MIN_BLUE,        /* use blue buffer with most bits (> MIN_BLUE bits) */
  43   WX_GL_MIN_ALPHA,       /* use blue buffer with most bits (> MIN_ALPHA bits) */
  44   WX_GL_DEPTH_SIZE,      /* bits for Z-buffer (0,16,32) */
  45   WX_GL_STENCIL_SIZE,    /* bits for stencil buffer */
  46   WX_GL_MIN_ACCUM_RED,   /* use red accum buffer with most bits (> MIN_ACCUM_RED bits) */
  47   WX_GL_MIN_ACCUM_GREEN, /* use green buffer with most bits (> MIN_ACCUM_GREEN bits) */
  48   WX_GL_MIN_ACCUM_BLUE,  /* use blue buffer with most bits (> MIN_ACCUM_BLUE bits) */
  49   WX_GL_MIN_ACCUM_ALPHA  /* use blue buffer with most bits (> MIN_ACCUM_ALPHA bits) */
  50 };
  51
  52 //---------------------------------------------------------------------------
  53 // classes
  54 //---------------------------------------------------------------------------
  55
  56 class WXDLLEXPORT wxGLContext;
  57 class WXDLLEXPORT wxGLCanvas;
  58
  59 //---------------------------------------------------------------------------
  60 // wxGLContext
  61 //---------------------------------------------------------------------------
  62
  63
  64 class WXDLLEXPORT wxGLContext: public wxObject
  65 {
  66 public:
  67     wxGLContext( bool isRGB, wxWindow *win, const wxPalette& palette = wxNullPalette );
  68     wxGLContext(
  69                bool WXUNUSED(isRGB), wxWindow *win,
  70                const wxPalette& WXUNUSED(palette),
  71                const wxGLContext *other        /* for sharing display lists */
  72     );
  73     ~wxGLContext();
  74
  75     void SetCurrent();
  76     void SetColour(const wxChar *colour);
  77     void SwapBuffers();
  78
  79     void SetupPixelFormat();
  80     void SetupPalette(const wxPalette& palette);
  81     wxPalette CreateDefaultPalette();
  82
  83     inline wxPalette* GetPalette() const { return (wxPalette*) & m_palette; }
  84     inline wxWindow* GetWindow() const { return m_window; }
  85     inline GtkWidget* GetWidget() const { return m_widget; }
  86     inline GLXContext GetContext() const { return m_glContext; }
  87
  88 public:
  89    GLXContext       m_glContext;
  90
  91    GtkWidget       *m_widget;
  92    wxPalette        m_palette;
  93    wxWindow*        m_window;
  94
  95 private:
  96   DECLARE_CLASS(wxGLContext)
  97 };
  98
  99 //---------------------------------------------------------------------------
 100 // wxGLCanvas
 101 //---------------------------------------------------------------------------
 102
 103 class WXDLLEXPORT wxGLCanvas: public wxWindow
 104 {
 105 public:
 106    inline wxGLCanvas() {
 107       m_glContext = (wxGLContext*) NULL;
 108       m_sharedContext = (wxGLContext*) NULL;
 109       m_glWidget = (GtkWidget*) NULL;
 110       m_vi = (void*) NULL;
 111       m_exposed = FALSE;
 112    }
 113    wxGLCanvas( wxWindow *parent, wxWindowID id = -1,
 114         const wxPoint& pos = wxDefaultPosition,
 115         const wxSize& size = wxDefaultSize,
 116         long style = 0, const wxString& name = wxGLCanvasName,
 117         int *attribList = (int*) NULL,
 118         const wxPalette& palette = wxNullPalette );
 119    wxGLCanvas( wxWindow *parent, const wxGLContext *shared = (wxGLContext *)NULL,
 120         wxWindowID id = -1,
 121         const wxPoint& pos = wxDefaultPosition,
 122         const wxSize& size = wxDefaultSize,
 123         long style = 0, const wxString& name = wxGLCanvasName,
 124         int *attribList = (int*) NULL,
 125         const wxPalette& palette = wxNullPalette );
 126    wxGLCanvas( wxWindow *parent, const wxGLCanvas *shared = (wxGLCanvas *)NULL,
 127         wxWindowID id = -1,
 128         const wxPoint& pos = wxDefaultPosition,
 129         const wxSize& size = wxDefaultSize,
 130         long style = 0, const wxString& name = wxGLCanvasName,
 131         int *attribList = (int*) NULL,
 132         const wxPalette& palette = wxNullPalette );
 133
 134    bool Create( wxWindow *parent,
 135                 const wxGLContext *shared = (wxGLContext*)NULL,
 136                 const wxGLCanvas *shared_context_of = (wxGLCanvas*)NULL,
 137                 wxWindowID id = -1,
 138                 const wxPoint& pos = wxDefaultPosition,
 139                 const wxSize& size = wxDefaultSize,
 140                 long style = 0,
 141                 const wxString& name = wxGLCanvasName,
 142                 int *attribList = (int*) NULL,
 143                 const wxPalette& palette = wxNullPalette );
 144
 145    ~wxGLCanvas();
 146
 147    void SetCurrent();
 148    void SetColour(const wxChar *colour);
 149    void SwapBuffers();
 150
 151    void OnSize(wxSizeEvent& event);
 152
 153    void OnInternalIdle();
 154
 155    inline wxGLContext* GetContext() const { return m_glContext; }
 156
 157  // implementation
 158
 159     wxGLContext      *m_glContext,
 160                      *m_sharedContext;
 161     wxGLCanvas       *m_sharedContextOf;
 162     void             *m_vi; // actually an XVisualInfo*
 163     bool              m_canFreeVi;
 164     GtkWidget        *m_glWidget;
 165     bool              m_exposed;
 166
 167     // returns an XVisualInfo* based on desired GL attributes;
 168     // returns NULL if an appropriate visual is not found. The
 169     // caller is reponsible for using XFree() to deallocate
 170     // the returned structure.
 171     static void* ChooseGLVisual(int *attribList);
 172
 173 private:
 174     DECLARE_EVENT_TABLE()
 175     DECLARE_CLASS(wxGLCanvas)
 176 };
 177
 178 #endif
 179     // _WX_GLCANVAS_H_
 180