include/wx/glcanvas.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/glcanvas.h
   3 // Purpose:     wxGLCanvas base header
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:
   7 // Copyright:   (c) Julian Smart
   8 // RCS-ID:      $Id$
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_GLCANVAS_H_BASE_
  13 #define _WX_GLCANVAS_H_BASE_
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_GLCANVAS
  18
  19 #include "wx/app.h"
  20 #include "wx/palette.h"
  21 #include "wx/window.h"
  22
  23 class WXDLLIMPEXP_FWD_GL wxGLCanvas;
  24 class WXDLLIMPEXP_FWD_GL wxGLContext;
  25
  26 // ----------------------------------------------------------------------------
  27 // Constants for attributes list
  28 // ----------------------------------------------------------------------------
  29
  30 // Notice that not all implementation support options such as stereo, auxiliary
  31 // buffers, alpha channel, and accumulator buffer, use IsDisplaySupported() to
  32 // check for individual attributes support.
  33 enum
  34 {
  35     WX_GL_RGBA = 1,        // use true color palette (on if no attrs specified)
  36     WX_GL_BUFFER_SIZE,     // bits for buffer if not WX_GL_RGBA
  37     WX_GL_LEVEL,           // 0 for main buffer, >0 for overlay, <0 for underlay
  38     WX_GL_DOUBLEBUFFER,    // use double buffering (on if no attrs specified)
  39     WX_GL_STEREO,          // use stereoscopic display
  40     WX_GL_AUX_BUFFERS,     // number of auxiliary buffers
  41     WX_GL_MIN_RED,         // use red buffer with most bits (> MIN_RED bits)
  42     WX_GL_MIN_GREEN,       // use green buffer with most bits (> MIN_GREEN bits)
  43     WX_GL_MIN_BLUE,        // use blue buffer with most bits (> MIN_BLUE bits)
  44     WX_GL_MIN_ALPHA,       // use alpha buffer with most bits (> MIN_ALPHA bits)
  45     WX_GL_DEPTH_SIZE,      // bits for Z-buffer (0,16,32)
  46     WX_GL_STENCIL_SIZE,    // bits for stencil buffer
  47     WX_GL_MIN_ACCUM_RED,   // use red accum buffer with most bits (> MIN_ACCUM_RED bits)
  48     WX_GL_MIN_ACCUM_GREEN, // use green buffer with most bits (> MIN_ACCUM_GREEN bits)
  49     WX_GL_MIN_ACCUM_BLUE,  // use blue buffer with most bits (> MIN_ACCUM_BLUE bits)
  50     WX_GL_MIN_ACCUM_ALPHA, // use alpha buffer with most bits (> MIN_ACCUM_ALPHA bits)
  51     WX_GL_SAMPLE_BUFFERS,  // 1 for multisampling support (antialiasing)
  52     WX_GL_SAMPLES          // 4 for 2x2 antialising supersampling on most graphics cards
  53 };
  54
  55 #define wxGLCanvasName wxT("GLCanvas")
  56
  57 // ----------------------------------------------------------------------------
  58 // wxGLContextBase: OpenGL rendering context
  59 // ----------------------------------------------------------------------------
  60
  61 class WXDLLIMPEXP_GL wxGLContextBase : public wxObject
  62 {
  63 public:
  64     /*
  65         The derived class should provide a ctor with this signature:
  66
  67         wxGLContext(wxGLCanvas *win, const wxGLContext *other = NULL);
  68      */
  69
  70     // set this context as the current one
  71     virtual bool SetCurrent(const wxGLCanvas& win) const = 0;
  72 };
  73
  74 // ----------------------------------------------------------------------------
  75 // wxGLCanvasBase: window which can be used for OpenGL rendering
  76 // ----------------------------------------------------------------------------
  77
  78 class WXDLLIMPEXP_GL wxGLCanvasBase : public wxWindow
  79 {
  80 public:
  81     // default ctor doesn't initialize the window, use Create() later
  82     wxGLCanvasBase();
  83
  84     virtual ~wxGLCanvasBase();
  85
  86
  87     /*
  88        The derived class should provide a ctor with this signature:
  89
  90     wxGLCanvas(wxWindow *parent,
  91                wxWindowID id = wxID_ANY,
  92                int* attribList = 0,
  93                const wxPoint& pos = wxDefaultPosition,
  94                const wxSize& size = wxDefaultSize,
  95                long style = 0,
  96                const wxString& name = wxGLCanvasName,
  97                const wxPalette& palette = wxNullPalette);
  98      */
  99
 100     // operations
 101     // ----------
 102
 103     // set the given context associated with this window as the current one
 104     bool SetCurrent(const wxGLContext& context) const;
 105
 106     // flush the back buffer (if we have it)
 107     virtual bool SwapBuffers() = 0;
 108
 109
 110     // accessors
 111     // ---------
 112
 113     // check if the given attributes are supported without creating a canvas
 114     static bool IsDisplaySupported(const int *attribList);
 115
 116     const wxPalette *GetPalette() const { return &m_palette; }
 117
 118     // miscellaneous helper functions
 119     // ------------------------------
 120
 121 #ifndef wxHAS_OPENGL_ES
 122     // call glcolor() for the colour with the given name, return false if
 123     // colour not found
 124     bool SetColour(const wxString& colour);
 125 #endif
 126
 127     // return true if the extension with given name is supported
 128     //
 129     // notice that while this function is implemented for all of GLX, WGL and
 130     // AGL the extensions names are usually not the same for different
 131     // platforms and so the code using it still usually uses conditional
 132     // compilation
 133     static bool IsExtensionSupported(const char *extension);
 134
 135     // deprecated methods using the implicit wxGLContext
 136 #if WXWIN_COMPATIBILITY_2_8
 137     wxDEPRECATED( wxGLContext* GetContext() const );
 138
 139     wxDEPRECATED( void SetCurrent() );
 140
 141     wxDEPRECATED( void OnSize(wxSizeEvent& event) );
 142 #endif // WXWIN_COMPATIBILITY_2_8
 143
 144 #ifdef __WXUNIVERSAL__
 145     // resolve the conflict with wxWindowUniv::SetCurrent()
 146     virtual bool SetCurrent(bool doit) { return wxWindow::SetCurrent(doit); };
 147 #endif
 148
 149 protected:
 150     // override this to implement SetColour() in GL_INDEX_MODE
 151     // (currently only implemented in wxX11 and wxMotif ports)
 152     virtual int GetColourIndex(const wxColour& WXUNUSED(col)) { return -1; }
 153
 154     // create default palette if we're not using RGBA mode
 155     // (not supported in most ports)
 156     virtual wxPalette CreateDefaultPalette() { return wxNullPalette; }
 157
 158     // check if the given extension name is present in the space-separated list
 159     // of extensions supported by the current implementation such as returned
 160     // by glXQueryExtensionsString() or glGetString(GL_EXTENSIONS)
 161     static bool IsExtensionInList(const char *list, const char *extension);
 162
 163     wxPalette m_palette;
 164
 165 #if WXWIN_COMPATIBILITY_2_8
 166     wxGLContext *m_glContext;
 167 #endif // WXWIN_COMPATIBILITY_2_8
 168 };
 169
 170 // ----------------------------------------------------------------------------
 171 // wxGLApp: a special wxApp subclass for OpenGL applications which must be used
 172 //          to select a visual compatible with the given attributes
 173 // ----------------------------------------------------------------------------
 174
 175 class WXDLLIMPEXP_GL wxGLAppBase : public wxApp
 176 {
 177 public:
 178     wxGLAppBase() : wxApp() { }
 179
 180     // use this in the constructor of the user-derived wxGLApp class to
 181     // determine if an OpenGL rendering context with these attributes
 182     // is available - returns true if so, false if not.
 183     virtual bool InitGLVisual(const int *attribList) = 0;
 184 };
 185
 186 #if defined(__WXMSW__)
 187     #include "wx/msw/glcanvas.h"
 188 #elif defined(__WXMOTIF__) || defined(__WXX11__)
 189     #include "wx/x11/glcanvas.h"
 190 #elif defined(__WXGTK20__)
 191     #include "wx/gtk/glcanvas.h"
 192 #elif defined(__WXGTK__)
 193     #include "wx/gtk1/glcanvas.h"
 194 #elif defined(__WXMAC__)
 195     #include "wx/osx/glcanvas.h"
 196 #elif defined(__WXCOCOA__)
 197     #include "wx/cocoa/glcanvas.h"
 198 #else
 199     #error "wxGLCanvas not supported in this wxWidgets port"
 200 #endif
 201
 202 // wxMac and wxMSW don't need anything extra in wxGLAppBase, so declare it here
 203 #ifndef wxGL_APP_DEFINED
 204
 205 class WXDLLIMPEXP_GL wxGLApp : public wxGLAppBase
 206 {
 207 public:
 208     wxGLApp() : wxGLAppBase() { }
 209
 210     virtual bool InitGLVisual(const int *attribList);
 211
 212 private:
 213     DECLARE_DYNAMIC_CLASS(wxGLApp)
 214 };
 215
 216 #endif // !wxGL_APP_DEFINED
 217
 218 #endif // wxUSE_GLCANVAS
 219
 220 #endif // _WX_GLCANVAS_H_BASE_