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
) )
319 wxLogLastError(_T("SwapBuffers"));
324 // ----------------------------------------------------------------------------
325 // pixel format stuff
326 // ----------------------------------------------------------------------------
329 AdjustPFDForAttributes(PIXELFORMATDESCRIPTOR
& pfd
, const int *attribList
)
334 pfd
.dwFlags
&= ~PFD_DOUBLEBUFFER
;
335 pfd
.iPixelType
= PFD_TYPE_COLORINDEX
;
339 while ( attribList
[arg
] )
341 switch ( attribList
[arg
++] )
344 pfd
.iPixelType
= PFD_TYPE_RGBA
;
346 case WX_GL_BUFFER_SIZE
:
347 pfd
.cColorBits
= attribList
[arg
++];
350 // this member looks like it may be obsolete
351 if ( attribList
[arg
] > 0 )
352 pfd
.iLayerType
= PFD_OVERLAY_PLANE
;
353 else if ( attribList
[arg
] < 0 )
354 pfd
.iLayerType
= (BYTE
)PFD_UNDERLAY_PLANE
;
356 pfd
.iLayerType
= PFD_MAIN_PLANE
;
359 case WX_GL_DOUBLEBUFFER
:
360 pfd
.dwFlags
|= PFD_DOUBLEBUFFER
;
363 pfd
.dwFlags
|= PFD_STEREO
;
365 case WX_GL_AUX_BUFFERS
:
366 pfd
.cAuxBuffers
= attribList
[arg
++];
369 pfd
.cColorBits
= (pfd
.cColorBits
+
370 (pfd
.cRedBits
= attribList
[arg
++]));
372 case WX_GL_MIN_GREEN
:
373 pfd
.cColorBits
= (pfd
.cColorBits
+
374 (pfd
.cGreenBits
= attribList
[arg
++]));
377 pfd
.cColorBits
= (pfd
.cColorBits
+
378 (pfd
.cBlueBits
= attribList
[arg
++]));
380 case WX_GL_MIN_ALPHA
:
381 // doesn't count in cColorBits
382 pfd
.cAlphaBits
= attribList
[arg
++];
384 case WX_GL_DEPTH_SIZE
:
385 pfd
.cDepthBits
= attribList
[arg
++];
387 case WX_GL_STENCIL_SIZE
:
388 pfd
.cStencilBits
= attribList
[arg
++];
390 case WX_GL_MIN_ACCUM_RED
:
391 pfd
.cAccumBits
= (pfd
.cAccumBits
+
392 (pfd
.cAccumRedBits
= attribList
[arg
++]));
394 case WX_GL_MIN_ACCUM_GREEN
:
395 pfd
.cAccumBits
= (pfd
.cAccumBits
+
396 (pfd
.cAccumGreenBits
= attribList
[arg
++]));
398 case WX_GL_MIN_ACCUM_BLUE
:
399 pfd
.cAccumBits
= (pfd
.cAccumBits
+
400 (pfd
.cAccumBlueBits
= attribList
[arg
++]));
402 case WX_GL_MIN_ACCUM_ALPHA
:
403 pfd
.cAccumBits
= (pfd
.cAccumBits
+
404 (pfd
.cAccumAlphaBits
= attribList
[arg
++]));
412 wxGLCanvas::ChooseMatchingPixelFormat(HDC hdc
,
413 const int *attribList
,
414 PIXELFORMATDESCRIPTOR
*ppfd
)
416 // default neutral pixel format
417 PIXELFORMATDESCRIPTOR pfd
=
419 sizeof(PIXELFORMATDESCRIPTOR
), // size
423 PFD_DOUBLEBUFFER
, // support double-buffering
424 PFD_TYPE_RGBA
, // color type
425 16, // preferred color depth
426 0, 0, 0, 0, 0, 0, // color bits (ignored)
427 0, // no alpha buffer
428 0, // alpha bits (ignored)
429 0, // no accumulation buffer
430 0, 0, 0, 0, // accumulator bits (ignored)
432 0, // no stencil buffer
433 0, // no auxiliary buffers
434 PFD_MAIN_PLANE
, // main layer
436 0, 0, 0, // no layer, visible, damage masks
444 AdjustPFDForAttributes(*ppfd
, attribList
);
446 return ::ChoosePixelFormat(hdc
, ppfd
);
450 bool wxGLCanvasBase::IsDisplaySupported(const int *attribList
)
452 // We need a device context to test the pixel format, so get one
453 // for the root window.
454 return wxGLCanvas::ChooseMatchingPixelFormat(ScreenHDC(), attribList
) > 0;
457 bool wxGLCanvas::DoSetup(const int *attribList
)
459 PIXELFORMATDESCRIPTOR pfd
;
460 const int pixelFormat
= ChooseMatchingPixelFormat(m_hDC
, attribList
, &pfd
);
463 wxLogLastError(_T("ChoosePixelFormat"));
467 if ( !::SetPixelFormat(m_hDC
, pixelFormat
, &pfd
) )
469 wxLogLastError(_T("SetPixelFormat"));
476 // ----------------------------------------------------------------------------
478 // ----------------------------------------------------------------------------
482 bool wxGLCanvas::SetupPalette(const wxPalette
& palette
)
484 const int pixelFormat
= ::GetPixelFormat(m_hDC
);
487 wxLogLastError(_T("GetPixelFormat"));
491 PIXELFORMATDESCRIPTOR pfd
;
492 if ( !::DescribePixelFormat(m_hDC
, pixelFormat
, sizeof(pfd
), &pfd
) )
494 wxLogLastError(_T("DescribePixelFormat"));
498 if ( !(pfd
.dwFlags
& PFD_NEED_PALETTE
) )
503 if ( !m_palette
.Ok() )
505 m_palette
= CreateDefaultPalette();
506 if ( !m_palette
.Ok() )
510 if ( !::SelectPalette(m_hDC
, GetHpaletteOf(m_palette
), FALSE
) )
512 wxLogLastError(_T("SelectPalette"));
516 if ( ::RealizePalette(m_hDC
) == GDI_ERROR
)
518 wxLogLastError(_T("RealizePalette"));
525 wxPalette
wxGLCanvas::CreateDefaultPalette()
527 PIXELFORMATDESCRIPTOR pfd
;
529 int pixelFormat
= GetPixelFormat(m_hDC
);
531 DescribePixelFormat(m_hDC
, pixelFormat
, sizeof(PIXELFORMATDESCRIPTOR
), &pfd
);
533 paletteSize
= 1 << pfd
.cColorBits
;
536 (LOGPALETTE
*) malloc(sizeof(LOGPALETTE
) + paletteSize
* sizeof(PALETTEENTRY
));
537 pPal
->palVersion
= 0x300;
538 pPal
->palNumEntries
= (WORD
)paletteSize
;
540 /* build a simple RGB color palette */
542 int redMask
= (1 << pfd
.cRedBits
) - 1;
543 int greenMask
= (1 << pfd
.cGreenBits
) - 1;
544 int blueMask
= (1 << pfd
.cBlueBits
) - 1;
547 for (i
=0; i
<paletteSize
; ++i
) {
548 pPal
->palPalEntry
[i
].peRed
=
549 (BYTE
)((((i
>> pfd
.cRedShift
) & redMask
) * 255) / redMask
);
550 pPal
->palPalEntry
[i
].peGreen
=
551 (BYTE
)((((i
>> pfd
.cGreenShift
) & greenMask
) * 255) / greenMask
);
552 pPal
->palPalEntry
[i
].peBlue
=
553 (BYTE
)((((i
>> pfd
.cBlueShift
) & blueMask
) * 255) / blueMask
);
554 pPal
->palPalEntry
[i
].peFlags
= 0;
558 HPALETTE hPalette
= CreatePalette(pPal
);
562 palette
.SetHPALETTE((WXHPALETTE
) hPalette
);
567 void wxGLCanvas::OnQueryNewPalette(wxQueryNewPaletteEvent
& event
)
569 /* realize palette if this is the current window */
570 if ( GetPalette()->Ok() ) {
571 ::UnrealizeObject((HPALETTE
) GetPalette()->GetHPALETTE());
572 ::SelectPalette(GetHDC(), (HPALETTE
) GetPalette()->GetHPALETTE(), FALSE
);
573 ::RealizePalette(GetHDC());
575 event
.SetPaletteRealized(true);
578 event
.SetPaletteRealized(false);
581 void wxGLCanvas::OnPaletteChanged(wxPaletteChangedEvent
& event
)
583 /* realize palette if this is *not* the current window */
585 GetPalette()->Ok() && (this != event
.GetChangedWindow()) )
587 ::UnrealizeObject((HPALETTE
) GetPalette()->GetHPALETTE());
588 ::SelectPalette(GetHDC(), (HPALETTE
) GetPalette()->GetHPALETTE(), FALSE
);
589 ::RealizePalette(GetHDC());
594 #endif // wxUSE_PALETTE
596 // ----------------------------------------------------------------------------
597 // deprecated wxGLCanvas methods using implicit wxGLContext
598 // ----------------------------------------------------------------------------
600 // deprecated constructors creating an implicit m_glContext
601 #if WXWIN_COMPATIBILITY_2_8
603 wxGLCanvas::wxGLCanvas(wxWindow
*parent
,
608 const wxString
& name
,
609 const int *attribList
,
610 const wxPalette
& palette
)
614 if ( Create(parent
, id
, pos
, size
, style
, name
, attribList
, palette
) )
615 m_glContext
= new wxGLContext(this);
618 wxGLCanvas::wxGLCanvas(wxWindow
*parent
,
619 const wxGLContext
*shared
,
624 const wxString
& name
,
625 const int *attribList
,
626 const wxPalette
& palette
)
630 if ( Create(parent
, id
, pos
, size
, style
, name
, attribList
, palette
) )
631 m_glContext
= new wxGLContext(this, shared
);
634 wxGLCanvas::wxGLCanvas(wxWindow
*parent
,
635 const wxGLCanvas
*shared
,
640 const wxString
& name
,
641 const int *attribList
,
642 const wxPalette
& palette
)
646 if ( Create(parent
, id
, pos
, size
, style
, name
, attribList
, palette
) )
647 m_glContext
= new wxGLContext(this, shared
? shared
->m_glContext
: NULL
);
650 #endif // WXWIN_COMPATIBILITY_2_8
653 // ----------------------------------------------------------------------------
655 // ----------------------------------------------------------------------------
657 bool wxGLApp::InitGLVisual(const int *attribList
)
659 if ( !wxGLCanvas::ChooseMatchingPixelFormat(ScreenHDC(), attribList
) )
661 wxLogError(_("Failed to initialize OpenGL"));
668 #endif // wxUSE_GLCANVAS