1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/glcanvas.cpp
3 // Purpose: wxGLCanvas, for using OpenGL with wxWidgets under MS Windows
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 #include "wx/wxprec.h"
22 #if defined(__BORLANDC__)
32 #include "wx/module.h"
35 #include "wx/msw/private.h"
37 #include "wx/glcanvas.h"
39 // from src/msw/window.cpp
40 LRESULT WXDLLEXPORT APIENTRY _EXPORT
wxWndProc(HWND hWnd
, UINT message
,
41 WPARAM wParam
, LPARAM lParam
);
43 #ifdef GL_EXT_vertex_array
44 #define WXUNUSED_WITHOUT_GL_EXT_vertex_array(name) name
46 #define WXUNUSED_WITHOUT_GL_EXT_vertex_array(name) WXUNUSED(name)
49 // ----------------------------------------------------------------------------
51 // ----------------------------------------------------------------------------
54 The following two compiler directives are specific to the Microsoft Visual
55 C++ family of compilers
57 Fundementally what they do is instruct the linker to use these two libraries
58 for the resolution of symbols. In essence, this is the equivalent of adding
59 these two libraries to either the Makefile or project file.
61 This is NOT a recommended technique, and certainly is unlikely to be used
62 anywhere else in wxWidgets given it is so specific to not only wxMSW, but
63 also the VC compiler. However, in the case of opengl support, it's an
64 applicable technique as opengl is optional in setup.h This code (wrapped by
65 wxUSE_GLCANVAS), now allows opengl support to be added purely by modifying
66 setup.h rather than by having to modify either the project or DSP fle.
68 See MSDN for further information on the exact usage of these commands.
71 # pragma comment( lib, "opengl32" )
72 # pragma comment( lib, "glu32" )
75 // ----------------------------------------------------------------------------
77 // ----------------------------------------------------------------------------
79 static const wxChar
*wxGLCanvasClassName
= wxT("wxGLCanvasClass");
80 static const wxChar
*wxGLCanvasClassNameNoRedraw
= wxT("wxGLCanvasClassNR");
82 // ============================================================================
84 // ============================================================================
86 // ----------------------------------------------------------------------------
87 // wxGLModule is responsible for unregistering wxGLCanvasClass Windows class
88 // ----------------------------------------------------------------------------
90 class wxGLModule
: public wxModule
93 bool OnInit() { return true; }
94 void OnExit() { UnregisterClasses(); }
96 // register the GL classes if not done yet, return true if ok, false if
97 // registration failed
98 static bool RegisterClasses();
100 // unregister the classes, done automatically on program termination
101 static void UnregisterClasses();
104 // wxGLCanvas is only used from the main thread so this is MT-ok
105 static bool ms_registeredGLClasses
;
107 DECLARE_DYNAMIC_CLASS(wxGLModule
)
110 IMPLEMENT_DYNAMIC_CLASS(wxGLModule
, wxModule
)
112 bool wxGLModule::ms_registeredGLClasses
= false;
115 bool wxGLModule::RegisterClasses()
117 if ( ms_registeredGLClasses
)
120 // We have to register a special window class because we need the CS_OWNDC
121 // style for GLCanvas: some OpenGL drivers are buggy and don't work with
122 // windows without this style
125 // the fields which are common to all classes
126 wndclass
.lpfnWndProc
= (WNDPROC
)wxWndProc
;
127 wndclass
.cbClsExtra
= 0;
128 wndclass
.cbWndExtra
= sizeof( DWORD
); // VZ: what is this DWORD used for?
129 wndclass
.hInstance
= wxhInstance
;
130 wndclass
.hIcon
= (HICON
) NULL
;
131 wndclass
.hCursor
= ::LoadCursor((HINSTANCE
)NULL
, IDC_ARROW
);
132 wndclass
.lpszMenuName
= NULL
;
134 // Register the GLCanvas class name
135 wndclass
.hbrBackground
= (HBRUSH
)NULL
;
136 wndclass
.lpszClassName
= wxGLCanvasClassName
;
137 wndclass
.style
= CS_HREDRAW
| CS_VREDRAW
| CS_DBLCLKS
| CS_OWNDC
;
139 if ( !::RegisterClass(&wndclass
) )
141 wxLogLastError(wxT("RegisterClass(wxGLCanvasClass)"));
145 // Register the GLCanvas class name for windows which don't do full repaint
147 wndclass
.lpszClassName
= wxGLCanvasClassNameNoRedraw
;
148 wndclass
.style
&= ~(CS_HREDRAW
| CS_VREDRAW
);
150 if ( !::RegisterClass(&wndclass
) )
152 wxLogLastError(wxT("RegisterClass(wxGLCanvasClassNameNoRedraw)"));
154 ::UnregisterClass(wxGLCanvasClassName
, wxhInstance
);
159 ms_registeredGLClasses
= true;
165 void wxGLModule::UnregisterClasses()
167 // we need to unregister the classes in case we're in a DLL which is
168 // unloaded and then loaded again because if we don't, the registration is
169 // going to fail in wxGLCanvas::Create() the next time we're loaded
170 if ( ms_registeredGLClasses
)
172 ::UnregisterClass(wxGLCanvasClassName
, wxhInstance
);
173 ::UnregisterClass(wxGLCanvasClassNameNoRedraw
, wxhInstance
);
175 ms_registeredGLClasses
= false;
179 // ----------------------------------------------------------------------------
181 // ----------------------------------------------------------------------------
183 IMPLEMENT_CLASS(wxGLContext
, wxObject
)
185 wxGLContext::wxGLContext(wxGLCanvas
*win
, const wxGLContext
* other
)
187 m_glContext
= wglCreateContext(win
->GetHDC());
188 wxCHECK_RET( m_glContext
, wxT("Couldn't create OpenGL context") );
192 if ( !wglShareLists(other
->m_glContext
, m_glContext
) )
193 wxLogLastError(_T("wglShareLists"));
197 wxGLContext::~wxGLContext()
199 // note that it's ok to delete the context even if it's the current one
200 wglDeleteContext(m_glContext
);
203 bool wxGLContext::SetCurrent(const wxGLCanvas
& win
) const
205 if ( !wglMakeCurrent(win
.GetHDC(), m_glContext
) )
207 wxLogLastError(_T("wglMakeCurrent"));
213 // ============================================================================
215 // ============================================================================
217 IMPLEMENT_CLASS(wxGLCanvas
, wxWindow
)
219 BEGIN_EVENT_TABLE(wxGLCanvas
, wxWindow
)
220 EVT_PALETTE_CHANGED(wxGLCanvas::OnPaletteChanged
)
221 EVT_QUERY_NEW_PALETTE(wxGLCanvas::OnQueryNewPalette
)
224 // ----------------------------------------------------------------------------
225 // wxGLCanvas construction
226 // ----------------------------------------------------------------------------
228 void wxGLCanvas::Init()
230 #if WXWIN_COMPATIBILITY_2_8
236 wxGLCanvas::wxGLCanvas(wxWindow
*parent
,
238 const int *attribList
,
242 const wxString
& name
,
243 const wxPalette
& palette
)
247 (void)Create(parent
, id
, pos
, size
, style
, name
, attribList
, palette
);
250 wxGLCanvas::~wxGLCanvas()
252 ::ReleaseDC(GetHwnd(), m_hDC
);
255 // Replaces wxWindow::Create functionality, since we need to use a different
257 bool wxGLCanvas::Create(wxWindow
*parent
,
262 const wxString
& name
,
263 const int *attribList
,
264 const wxPalette
& palette
)
266 wxCHECK_MSG( parent
, false, wxT("can't create wxWindow without parent") );
268 if ( !wxGLModule::RegisterClasses() )
270 wxLogError(_("Failed to register OpenGL window class."));
275 if ( !CreateBase(parent
, id
, pos
, size
, style
, wxDefaultValidator
, name
) )
278 parent
->AddChild(this);
281 A general rule with OpenGL and Win32 is that any window that will have a
282 HGLRC built for it must have two flags: WS_CLIPCHILDREN & WS_CLIPSIBLINGS.
283 You can find references about this within the knowledge base and most OpenGL
284 books that contain the wgl function descriptions.
287 DWORD msflags
= WS_CHILD
| WS_VISIBLE
| WS_CLIPSIBLINGS
| WS_CLIPCHILDREN
;
288 msflags
|= MSWGetStyle(style
, &exStyle
);
290 if ( !MSWCreate(wxGLCanvasClassName
, NULL
, pos
, size
, msflags
, exStyle
) )
293 m_hDC
= ::GetDC(GetHwnd());
297 if ( !DoSetup(attribList
) )
301 if ( !SetupPalette(palette
) )
303 #else // !wxUSE_PALETTE
304 wxUnusedVar(palette
);
305 #endif // wxUSE_PALETTE/!wxUSE_PALETTE
310 // ----------------------------------------------------------------------------
312 // ----------------------------------------------------------------------------
314 bool wxGLCanvas::SwapBuffers()
316 if ( !::SwapBuffers(m_hDC
) )
318 wxLogLastError(_T("SwapBuffers"));
325 // ----------------------------------------------------------------------------
326 // pixel format stuff
327 // ----------------------------------------------------------------------------
330 AdjustPFDForAttributes(PIXELFORMATDESCRIPTOR
& pfd
, const int *attribList
)
335 pfd
.dwFlags
&= ~PFD_DOUBLEBUFFER
;
336 pfd
.iPixelType
= PFD_TYPE_COLORINDEX
;
340 while ( attribList
[arg
] )
342 switch ( attribList
[arg
++] )
345 pfd
.iPixelType
= PFD_TYPE_RGBA
;
347 case WX_GL_BUFFER_SIZE
:
348 pfd
.cColorBits
= attribList
[arg
++];
351 // this member looks like it may be obsolete
352 if ( attribList
[arg
] > 0 )
353 pfd
.iLayerType
= PFD_OVERLAY_PLANE
;
354 else if ( attribList
[arg
] < 0 )
355 pfd
.iLayerType
= (BYTE
)PFD_UNDERLAY_PLANE
;
357 pfd
.iLayerType
= PFD_MAIN_PLANE
;
360 case WX_GL_DOUBLEBUFFER
:
361 pfd
.dwFlags
|= PFD_DOUBLEBUFFER
;
364 pfd
.dwFlags
|= PFD_STEREO
;
366 case WX_GL_AUX_BUFFERS
:
367 pfd
.cAuxBuffers
= attribList
[arg
++];
370 pfd
.cColorBits
= (pfd
.cColorBits
+
371 (pfd
.cRedBits
= attribList
[arg
++]));
373 case WX_GL_MIN_GREEN
:
374 pfd
.cColorBits
= (pfd
.cColorBits
+
375 (pfd
.cGreenBits
= attribList
[arg
++]));
378 pfd
.cColorBits
= (pfd
.cColorBits
+
379 (pfd
.cBlueBits
= attribList
[arg
++]));
381 case WX_GL_MIN_ALPHA
:
382 // doesn't count in cColorBits
383 pfd
.cAlphaBits
= attribList
[arg
++];
385 case WX_GL_DEPTH_SIZE
:
386 pfd
.cDepthBits
= attribList
[arg
++];
388 case WX_GL_STENCIL_SIZE
:
389 pfd
.cStencilBits
= attribList
[arg
++];
391 case WX_GL_MIN_ACCUM_RED
:
392 pfd
.cAccumBits
= (pfd
.cAccumBits
+
393 (pfd
.cAccumRedBits
= attribList
[arg
++]));
395 case WX_GL_MIN_ACCUM_GREEN
:
396 pfd
.cAccumBits
= (pfd
.cAccumBits
+
397 (pfd
.cAccumGreenBits
= attribList
[arg
++]));
399 case WX_GL_MIN_ACCUM_BLUE
:
400 pfd
.cAccumBits
= (pfd
.cAccumBits
+
401 (pfd
.cAccumBlueBits
= attribList
[arg
++]));
403 case WX_GL_MIN_ACCUM_ALPHA
:
404 pfd
.cAccumBits
= (pfd
.cAccumBits
+
405 (pfd
.cAccumAlphaBits
= attribList
[arg
++]));
413 wxGLCanvas::ChooseMatchingPixelFormat(HDC hdc
,
414 const int *attribList
,
415 PIXELFORMATDESCRIPTOR
*ppfd
)
417 // default neutral pixel format
418 PIXELFORMATDESCRIPTOR pfd
=
420 sizeof(PIXELFORMATDESCRIPTOR
), // size
424 PFD_DOUBLEBUFFER
, // support double-buffering
425 PFD_TYPE_RGBA
, // color type
426 16, // preferred color depth
427 0, 0, 0, 0, 0, 0, // color bits (ignored)
428 0, // no alpha buffer
429 0, // alpha bits (ignored)
430 0, // no accumulation buffer
431 0, 0, 0, 0, // accumulator bits (ignored)
433 0, // no stencil buffer
434 0, // no auxiliary buffers
435 PFD_MAIN_PLANE
, // main layer
437 0, 0, 0, // no layer, visible, damage masks
445 AdjustPFDForAttributes(*ppfd
, attribList
);
447 return ::ChoosePixelFormat(hdc
, ppfd
);
451 bool wxGLCanvasBase::IsDisplaySupported(const int *attribList
)
453 // We need a device context to test the pixel format, so get one
454 // for the root window.
455 return wxGLCanvas::ChooseMatchingPixelFormat(ScreenHDC(), attribList
) > 0;
458 bool wxGLCanvas::DoSetup(const int *attribList
)
460 PIXELFORMATDESCRIPTOR pfd
;
461 const int pixelFormat
= ChooseMatchingPixelFormat(m_hDC
, attribList
, &pfd
);
464 wxLogLastError(_T("ChoosePixelFormat"));
468 if ( !::SetPixelFormat(m_hDC
, pixelFormat
, &pfd
) )
470 wxLogLastError(_T("SetPixelFormat"));
477 // ----------------------------------------------------------------------------
479 // ----------------------------------------------------------------------------
483 bool wxGLCanvas::SetupPalette(const wxPalette
& palette
)
485 const int pixelFormat
= ::GetPixelFormat(m_hDC
);
488 wxLogLastError(_T("GetPixelFormat"));
492 PIXELFORMATDESCRIPTOR pfd
;
493 if ( !::DescribePixelFormat(m_hDC
, pixelFormat
, sizeof(pfd
), &pfd
) )
495 wxLogLastError(_T("DescribePixelFormat"));
499 if ( !(pfd
.dwFlags
& PFD_NEED_PALETTE
) )
504 if ( !m_palette
.Ok() )
506 m_palette
= CreateDefaultPalette();
507 if ( !m_palette
.Ok() )
511 if ( !::SelectPalette(m_hDC
, GetHpaletteOf(m_palette
), FALSE
) )
513 wxLogLastError(_T("SelectPalette"));
517 if ( ::RealizePalette(m_hDC
) == GDI_ERROR
)
519 wxLogLastError(_T("RealizePalette"));
526 wxPalette
wxGLCanvas::CreateDefaultPalette()
528 PIXELFORMATDESCRIPTOR pfd
;
530 int pixelFormat
= GetPixelFormat(m_hDC
);
532 DescribePixelFormat(m_hDC
, pixelFormat
, sizeof(PIXELFORMATDESCRIPTOR
), &pfd
);
534 paletteSize
= 1 << pfd
.cColorBits
;
537 (LOGPALETTE
*) malloc(sizeof(LOGPALETTE
) + paletteSize
* sizeof(PALETTEENTRY
));
538 pPal
->palVersion
= 0x300;
539 pPal
->palNumEntries
= (WORD
)paletteSize
;
541 /* build a simple RGB color palette */
543 int redMask
= (1 << pfd
.cRedBits
) - 1;
544 int greenMask
= (1 << pfd
.cGreenBits
) - 1;
545 int blueMask
= (1 << pfd
.cBlueBits
) - 1;
548 for (i
=0; i
<paletteSize
; ++i
) {
549 pPal
->palPalEntry
[i
].peRed
=
550 (BYTE
)((((i
>> pfd
.cRedShift
) & redMask
) * 255) / redMask
);
551 pPal
->palPalEntry
[i
].peGreen
=
552 (BYTE
)((((i
>> pfd
.cGreenShift
) & greenMask
) * 255) / greenMask
);
553 pPal
->palPalEntry
[i
].peBlue
=
554 (BYTE
)((((i
>> pfd
.cBlueShift
) & blueMask
) * 255) / blueMask
);
555 pPal
->palPalEntry
[i
].peFlags
= 0;
559 HPALETTE hPalette
= CreatePalette(pPal
);
563 palette
.SetHPALETTE((WXHPALETTE
) hPalette
);
568 void wxGLCanvas::OnQueryNewPalette(wxQueryNewPaletteEvent
& event
)
570 /* realize palette if this is the current window */
571 if ( GetPalette()->Ok() ) {
572 ::UnrealizeObject((HPALETTE
) GetPalette()->GetHPALETTE());
573 ::SelectPalette(GetHDC(), (HPALETTE
) GetPalette()->GetHPALETTE(), FALSE
);
574 ::RealizePalette(GetHDC());
576 event
.SetPaletteRealized(true);
579 event
.SetPaletteRealized(false);
582 void wxGLCanvas::OnPaletteChanged(wxPaletteChangedEvent
& event
)
584 /* realize palette if this is *not* the current window */
586 GetPalette()->Ok() && (this != event
.GetChangedWindow()) )
588 ::UnrealizeObject((HPALETTE
) GetPalette()->GetHPALETTE());
589 ::SelectPalette(GetHDC(), (HPALETTE
) GetPalette()->GetHPALETTE(), FALSE
);
590 ::RealizePalette(GetHDC());
595 #endif // wxUSE_PALETTE
597 // ----------------------------------------------------------------------------
598 // deprecated wxGLCanvas methods using implicit wxGLContext
599 // ----------------------------------------------------------------------------
601 // deprecated constructors creating an implicit m_glContext
602 #if WXWIN_COMPATIBILITY_2_8
604 wxGLCanvas::wxGLCanvas(wxWindow
*parent
,
609 const wxString
& name
,
610 const int *attribList
,
611 const wxPalette
& palette
)
615 if ( Create(parent
, id
, pos
, size
, style
, name
, attribList
, palette
) )
616 m_glContext
= new wxGLContext(this);
619 wxGLCanvas::wxGLCanvas(wxWindow
*parent
,
620 const wxGLContext
*shared
,
625 const wxString
& name
,
626 const int *attribList
,
627 const wxPalette
& palette
)
631 if ( Create(parent
, id
, pos
, size
, style
, name
, attribList
, palette
) )
632 m_glContext
= new wxGLContext(this, shared
);
635 wxGLCanvas::wxGLCanvas(wxWindow
*parent
,
636 const wxGLCanvas
*shared
,
641 const wxString
& name
,
642 const int *attribList
,
643 const wxPalette
& palette
)
647 if ( Create(parent
, id
, pos
, size
, style
, name
, attribList
, palette
) )
648 m_glContext
= new wxGLContext(this, shared
? shared
->m_glContext
: NULL
);
651 #endif // WXWIN_COMPATIBILITY_2_8
654 // ----------------------------------------------------------------------------
656 // ----------------------------------------------------------------------------
658 bool wxGLApp::InitGLVisual(const int *attribList
)
660 if ( !wxGLCanvas::ChooseMatchingPixelFormat(ScreenHDC(), attribList
) )
662 wxLogError(_("Failed to initialize OpenGL"));
669 #endif // wxUSE_GLCANVAS