1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/msw/glcanvas.h
3 // Purpose: wxGLCanvas, for using OpenGL with wxWidgets under Windows
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_GLCANVAS_H_
13 #define _WX_GLCANVAS_H_
15 #include "wx/palette.h"
16 #include "wx/scrolwin.h"
19 #include "wx/msw/winundef.h"
23 //---------------------------------------------------------------------------
24 // Constants for attriblist
25 //---------------------------------------------------------------------------
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.
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) */
51 class WXDLLIMPEXP_GL wxGLCanvas
; /* forward reference */
53 class WXDLLIMPEXP_GL wxGLContext
: public wxObject
56 wxGLContext(wxGLCanvas
*win
, const wxGLContext
* other
=NULL
/* for sharing display lists */ );
57 virtual ~wxGLContext();
59 inline HGLRC
GetGLRC() const { return m_glContext
; }
65 DECLARE_CLASS(wxGLContext
)
68 class WXDLLIMPEXP_GL wxGLCanvas
: public wxWindow
71 // This ctor is identical to the next, except for the fact that it
72 // doesn't create an implicit wxGLContext.
73 // The attribList parameter has been moved to avoid overload clashes.
74 wxGLCanvas(wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
76 const wxPoint
& pos
= wxDefaultPosition
,
77 const wxSize
& size
= wxDefaultSize
, long style
= 0,
78 const wxString
& name
= wxGLCanvasName
,
79 const wxPalette
& palette
= wxNullPalette
);
81 wxGLCanvas(wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
82 const wxPoint
& pos
= wxDefaultPosition
,
83 const wxSize
& size
= wxDefaultSize
, long style
= 0,
84 const wxString
& name
= wxGLCanvasName
, int *attribList
= 0,
85 const wxPalette
& palette
= wxNullPalette
);
87 wxGLCanvas(wxWindow
*parent
,
88 const wxGLContext
*shared
,
89 wxWindowID id
= wxID_ANY
,
90 const wxPoint
& pos
= wxDefaultPosition
,
91 const wxSize
& size
= wxDefaultSize
,
93 const wxString
& name
= wxGLCanvasName
,
94 int *attribList
= (int *) NULL
,
95 const wxPalette
& palette
= wxNullPalette
);
97 wxGLCanvas(wxWindow
*parent
,
98 const wxGLCanvas
*shared
,
99 wxWindowID id
= wxID_ANY
,
100 const wxPoint
& pos
= wxDefaultPosition
,
101 const wxSize
& size
= wxDefaultSize
,
103 const wxString
& name
= wxGLCanvasName
,
105 const wxPalette
& palette
= wxNullPalette
);
107 virtual ~wxGLCanvas();
109 // Replaces wxWindow::Create functionality, since
110 // we need to use a different window class
111 bool Create(wxWindow
*parent
, wxWindowID id
,
112 const wxPoint
& pos
, const wxSize
& size
,
113 long style
, const wxString
& name
);
115 void SetCurrent(const wxGLContext
& RC
) const;
118 #ifdef __WXUNIVERSAL__
119 virtual bool SetCurrent(bool doit
) { return wxWindow::SetCurrent(doit
); };
122 void SetColour(const wxChar
*colour
);
126 void OnSize(wxSizeEvent
& event
);
128 void OnQueryNewPalette(wxQueryNewPaletteEvent
& event
);
130 void OnPaletteChanged(wxPaletteChangedEvent
& event
);
132 inline wxGLContext
* GetContext() const { return m_glContext
; }
134 inline WXHDC
GetHDC() const { return m_hDC
; }
136 void SetupPixelFormat(int *attribList
= (int *) NULL
);
138 void SetupPalette(const wxPalette
& palette
);
140 wxPalette
CreateDefaultPalette();
142 inline wxPalette
* GetPalette() const { return (wxPalette
*) &m_palette
; }
145 wxGLContext
* m_glContext
; // this is typedef-ed ptr, in fact
150 DECLARE_EVENT_TABLE()
151 DECLARE_CLASS(wxGLCanvas
)