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 // Copyright:   (c) Julian Smart
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_GLCANVAS_H_
  12 #define _WX_GLCANVAS_H_
  13
  14 #include "wx/palette.h"
  15
  16 #include "wx/msw/wrapwin.h"
  17
  18 #include <GL/gl.h>
  19
  20 // ----------------------------------------------------------------------------
  21 // wxGLContext: OpenGL rendering context
  22 // ----------------------------------------------------------------------------
  23
  24 class WXDLLIMPEXP_GL wxGLContext : public wxGLContextBase
  25 {
  26 public:
  27     wxGLContext(wxGLCanvas *win, const wxGLContext* other = NULL);
  28     virtual ~wxGLContext();
  29
  30     virtual bool SetCurrent(const wxGLCanvas& win) const;
  31
  32     HGLRC GetGLRC() const { return m_glContext; }
  33
  34 protected:
  35     HGLRC m_glContext;
  36
  37 private:
  38     DECLARE_CLASS(wxGLContext)
  39 };
  40
  41 // ----------------------------------------------------------------------------
  42 // wxGLCanvas: OpenGL output window
  43 // ----------------------------------------------------------------------------
  44
  45 class WXDLLIMPEXP_GL wxGLCanvas : public wxGLCanvasBase
  46 {
  47 public:
  48     wxEXPLICIT // avoid implicitly converting a wxWindow* to wxGLCanvas
  49     wxGLCanvas(wxWindow *parent,
  50                wxWindowID id = wxID_ANY,
  51                const int *attribList = NULL,
  52                const wxPoint& pos = wxDefaultPosition,
  53                const wxSize& size = wxDefaultSize,
  54                long style = 0,
  55                const wxString& name = wxGLCanvasName,
  56                const wxPalette& palette = wxNullPalette);
  57
  58     bool Create(wxWindow *parent,
  59                 wxWindowID id = wxID_ANY,
  60                 const wxPoint& pos = wxDefaultPosition,
  61                 const wxSize& size = wxDefaultSize,
  62                 long style = 0,
  63                 const wxString& name = wxGLCanvasName,
  64                 const int *attribList = NULL,
  65                 const wxPalette& palette = wxNullPalette);
  66
  67     virtual ~wxGLCanvas();
  68
  69     // implement wxGLCanvasBase methods
  70     virtual bool SwapBuffers();
  71
  72
  73     // MSW-specific helpers
  74     // --------------------
  75
  76     // get the HDC used for OpenGL rendering
  77     HDC GetHDC() const { return m_hDC; }
  78
  79     // try to find pixel format matching the given attributes list for the
  80     // specified HDC, return 0 on error, otherwise pfd is filled in with the
  81     // information from attribList if non-NULL
  82     static int ChooseMatchingPixelFormat(HDC hdc, const int *attribList,
  83                                          PIXELFORMATDESCRIPTOR *pfd = NULL);
  84
  85 #if wxUSE_PALETTE
  86     // palette stuff
  87     bool SetupPalette(const wxPalette& palette);
  88     virtual wxPalette CreateDefaultPalette();
  89     void OnQueryNewPalette(wxQueryNewPaletteEvent& event);
  90     void OnPaletteChanged(wxPaletteChangedEvent& event);
  91 #endif // wxUSE_PALETTE
  92
  93     // deprecated methods using the implicit wxGLContext, associate the context
  94     // explicitly with the window instead
  95 #if WXWIN_COMPATIBILITY_2_8
  96     wxDEPRECATED(
  97     wxGLCanvas(wxWindow *parent,
  98                wxWindowID id = wxID_ANY,
  99                const wxPoint& pos = wxDefaultPosition,
 100                const wxSize& size = wxDefaultSize,
 101                long style = 0,
 102                const wxString& name = wxGLCanvasName,
 103                const int *attribList = NULL,
 104                const wxPalette& palette = wxNullPalette)
 105     );
 106
 107     wxDEPRECATED(
 108     wxGLCanvas(wxWindow *parent,
 109                const wxGLContext *shared,
 110                wxWindowID id = wxID_ANY,
 111                const wxPoint& pos = wxDefaultPosition,
 112                const wxSize& size = wxDefaultSize,
 113                long style = 0,
 114                const wxString& name = wxGLCanvasName,
 115                const int *attribList = NULL,
 116                const wxPalette& palette = wxNullPalette)
 117     );
 118
 119     wxDEPRECATED(
 120     wxGLCanvas(wxWindow *parent,
 121                const wxGLCanvas *shared,
 122                wxWindowID id = wxID_ANY,
 123                const wxPoint& pos = wxDefaultPosition,
 124                const wxSize& size = wxDefaultSize,
 125                long style = 0,
 126                const wxString& name = wxGLCanvasName,
 127                const int *attribList = NULL,
 128                const wxPalette& palette = wxNullPalette)
 129     );
 130 #endif // WXWIN_COMPATIBILITY_2_8
 131
 132 protected:
 133     // common part of all ctors
 134     void Init();
 135
 136     // the real window creation function, Create() may reuse it twice as we may
 137     // need to create an OpenGL window to query the available extensions and
 138     // then potentially delete and recreate it with another pixel format
 139     bool CreateWindow(wxWindow *parent,
 140                       wxWindowID id = wxID_ANY,
 141                       const wxPoint& pos = wxDefaultPosition,
 142                       const wxSize& size = wxDefaultSize,
 143                       long style = 0,
 144                       const wxString& name = wxGLCanvasName);
 145
 146     // set up the pixel format using the given attributes and palette
 147     int DoSetup(PIXELFORMATDESCRIPTOR &pfd, const int *attribList);
 148
 149
 150     // HDC for this window, we keep it all the time
 151     HDC m_hDC;
 152
 153 private:
 154     DECLARE_EVENT_TABLE()
 155     DECLARE_CLASS(wxGLCanvas)
 156 };
 157
 158 #endif // _WX_GLCANVAS_H_