include/wx/msw/glcanvas.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/glcanvas.h
   3 // Purpose:     wxGLCanvas, for using OpenGL with wxWidgets under Windows
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_GLCANVAS_H_
  13 #define _WX_GLCANVAS_H_
  14
  15 #include "wx/palette.h"
  16 #include "wx/scrolwin.h"
  17
  18 #include <windows.h>
  19 #include "wx/msw/winundef.h"
  20
  21 #include <GL/gl.h>
  22
  23 //---------------------------------------------------------------------------
  24 // Constants for attriblist
  25 //---------------------------------------------------------------------------
  26
  27 // The generic GL implementation doesn't support most of these options,
  28 // such as stereo, auxiliary buffers, alpha channel, and accum buffer.
  29 // Other implementations may actually support them.
  30
  31 enum
  32 {
  33     WX_GL_RGBA=1,          /* use true color palette */
  34     WX_GL_BUFFER_SIZE,     /* bits for buffer if not WX_GL_RGBA */
  35     WX_GL_LEVEL,           /* 0 for main buffer, >0 for overlay, <0 for underlay */
  36     WX_GL_DOUBLEBUFFER,    /* use doublebuffer */
  37     WX_GL_STEREO,          /* use stereoscopic display */
  38     WX_GL_AUX_BUFFERS,     /* number of auxiliary buffers */
  39     WX_GL_MIN_RED,         /* use red buffer with most bits (> MIN_RED bits) */
  40     WX_GL_MIN_GREEN,       /* use green buffer with most bits (> MIN_GREEN bits) */
  41     WX_GL_MIN_BLUE,        /* use blue buffer with most bits (> MIN_BLUE bits) */
  42     WX_GL_MIN_ALPHA,       /* use blue buffer with most bits (> MIN_ALPHA bits) */
  43     WX_GL_DEPTH_SIZE,      /* bits for Z-buffer (0,16,32) */
  44     WX_GL_STENCIL_SIZE,    /* bits for stencil buffer */
  45     WX_GL_MIN_ACCUM_RED,   /* use red accum buffer with most bits (> MIN_ACCUM_RED bits) */
  46     WX_GL_MIN_ACCUM_GREEN, /* use green buffer with most bits (> MIN_ACCUM_GREEN bits) */
  47     WX_GL_MIN_ACCUM_BLUE,  /* use blue buffer with most bits (> MIN_ACCUM_BLUE bits) */
  48     WX_GL_MIN_ACCUM_ALPHA  /* use blue buffer with most bits (> MIN_ACCUM_ALPHA bits) */
  49 };
  50
  51 class WXDLLIMPEXP_GL wxGLCanvas;     /* forward reference */
  52
  53 class WXDLLIMPEXP_GL wxGLContext: public wxObject
  54 {
  55 public:
  56     wxGLContext(wxGLCanvas *win, const wxGLContext* other=NULL /* for sharing display lists */ );
  57     virtual ~wxGLContext();
  58
  59     void SetCurrent(const wxGLCanvas& win) const;
  60     inline HGLRC GetGLRC() const { return m_glContext; }
  61
  62 protected:
  63     HGLRC m_glContext;
  64
  65 private:
  66     DECLARE_CLASS(wxGLContext)
  67 };
  68
  69 class WXDLLIMPEXP_GL wxGLCanvas: public wxWindow
  70 {
  71 public:
  72     // This ctor is identical to the next, except for the fact that it
  73     // doesn't create an implicit wxGLContext.
  74     // The attribList parameter has been moved to avoid overload clashes.
  75     wxGLCanvas(wxWindow *parent, wxWindowID id = wxID_ANY,
  76         int* attribList = 0,
  77         const wxPoint& pos = wxDefaultPosition,
  78         const wxSize& size = wxDefaultSize, long style = 0,
  79         const wxString& name = wxGLCanvasName,
  80         const wxPalette& palette = wxNullPalette);
  81
  82     wxGLCanvas(wxWindow *parent, wxWindowID id = wxID_ANY,
  83         const wxPoint& pos = wxDefaultPosition,
  84         const wxSize& size = wxDefaultSize, long style = 0,
  85         const wxString& name = wxGLCanvasName, int *attribList = 0,
  86         const wxPalette& palette = wxNullPalette);
  87
  88     wxGLCanvas(wxWindow *parent,
  89         const wxGLContext *shared,
  90         wxWindowID id = wxID_ANY,
  91         const wxPoint& pos = wxDefaultPosition,
  92         const wxSize& size = wxDefaultSize,
  93         long style = 0,
  94         const wxString& name = wxGLCanvasName,
  95         int *attribList = (int *) NULL,
  96         const wxPalette& palette = wxNullPalette);
  97
  98     wxGLCanvas(wxWindow *parent,
  99         const wxGLCanvas *shared,
 100         wxWindowID id = wxID_ANY,
 101         const wxPoint& pos = wxDefaultPosition,
 102         const wxSize& size = wxDefaultSize,
 103         long style = 0,
 104         const wxString& name = wxGLCanvasName,
 105         int *attribList = 0,
 106         const wxPalette& palette = wxNullPalette);
 107
 108     virtual ~wxGLCanvas();
 109
 110     // Replaces wxWindow::Create functionality, since
 111     // we need to use a different window class
 112     bool Create(wxWindow *parent, wxWindowID id,
 113         const wxPoint& pos, const wxSize& size,
 114         long style, const wxString& name);
 115
 116     void SetCurrent(const wxGLContext& RC) const;
 117     void SetCurrent();
 118
 119 #ifdef __WXUNIVERSAL__
 120     virtual bool SetCurrent(bool doit) { return wxWindow::SetCurrent(doit); };
 121 #endif
 122
 123     void SetColour(const wxChar *colour);
 124
 125     void SwapBuffers();
 126
 127     void OnSize(wxSizeEvent& event);
 128
 129     void OnQueryNewPalette(wxQueryNewPaletteEvent& event);
 130
 131     void OnPaletteChanged(wxPaletteChangedEvent& event);
 132
 133     inline wxGLContext* GetContext() const { return m_glContext; }
 134
 135     inline WXHDC GetHDC() const { return m_hDC; }
 136
 137     void SetupPixelFormat(int *attribList = (int *) NULL);
 138
 139     void SetupPalette(const wxPalette& palette);
 140
 141     wxPalette CreateDefaultPalette();
 142
 143     inline wxPalette* GetPalette() const { return (wxPalette *) &m_palette; }
 144
 145 protected:
 146     wxGLContext*   m_glContext;  // this is typedef-ed ptr, in fact
 147     wxPalette      m_palette;
 148     WXHDC          m_hDC;
 149
 150 private:
 151     DECLARE_EVENT_TABLE()
 152     DECLARE_CLASS(wxGLCanvas)
 153 };
 154
 155 #endif
 156     // _WX_GLCANVAS_H_
 157