1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/glcanvas.cpp
3 // Purpose: wxGLCanvas, for using OpenGL with wxWindows under MS Windows
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
13 #pragma implementation "glcanvas.h"
16 #include "wx/wxprec.h"
18 #if defined(__BORLANDC__)
26 #include "wx/settings.h"
31 #include "wx/msw/private.h"
33 #include "wx/glcanvas.h"
35 static const wxChar
*wxGLCanvasClassName
= wxT("wxGLCanvasClass");
36 static const wxChar
*wxGLCanvasClassNameNoRedraw
= wxT("wxGLCanvasClassNR");
38 LRESULT WXDLLEXPORT APIENTRY _EXPORT
wxWndProc(HWND hWnd
, UINT message
,
39 WPARAM wParam
, LPARAM lParam
);
42 * GLContext implementation
45 wxGLContext::wxGLContext(bool isRGB
, wxGLCanvas
*win
, const wxPalette
& palette
)
49 m_hDC
= win
->GetHDC();
51 m_glContext
= wglCreateContext((HDC
) m_hDC
);
52 wxCHECK_RET( m_glContext
, wxT("Couldn't create OpenGl context") );
54 wglMakeCurrent((HDC
) m_hDC
, m_glContext
);
57 wxGLContext::wxGLContext(
58 bool isRGB
, wxGLCanvas
*win
,
59 const wxPalette
& palette
,
60 const wxGLContext
*other
/* for sharing display lists */
65 m_hDC
= win
->GetHDC();
67 m_glContext
= wglCreateContext((HDC
) m_hDC
);
68 wxCHECK_RET( m_glContext
, wxT("Couldn't create OpenGl context") );
71 wglShareLists( other
->m_glContext
, m_glContext
);
73 wglMakeCurrent((HDC
) m_hDC
, m_glContext
);
76 wxGLContext::~wxGLContext()
80 wglMakeCurrent(NULL
, NULL
);
81 wglDeleteContext(m_glContext
);
85 void wxGLContext::SwapBuffers()
89 wglMakeCurrent((HDC
) m_hDC
, m_glContext
);
90 ::SwapBuffers((HDC
) m_hDC
); //blits the backbuffer into DC
94 void wxGLContext::SetCurrent()
98 wglMakeCurrent((HDC
) m_hDC
, m_glContext
);
102 setupPixelFormat(hDC);
107 void wxGLContext::SetColour(const char *colour
)
112 wxColour
*col
= wxTheColourDatabase
->FindColour(colour
);
115 r
= (float)(col
->Red()/256.0);
116 g
= (float)(col
->Green()/256.0);
117 b
= (float)(col
->Blue()/256.0);
124 * wxGLCanvas implementation
127 IMPLEMENT_CLASS(wxGLCanvas
, wxWindow
)
129 BEGIN_EVENT_TABLE(wxGLCanvas
, wxWindow
)
130 EVT_SIZE(wxGLCanvas::OnSize
)
131 EVT_PALETTE_CHANGED(wxGLCanvas::OnPaletteChanged
)
132 EVT_QUERY_NEW_PALETTE(wxGLCanvas::OnQueryNewPalette
)
135 wxGLCanvas::wxGLCanvas(wxWindow
*parent
, wxWindowID id
,
136 const wxPoint
& pos
, const wxSize
& size
, long style
, const wxString
& name
,
137 int *attribList
, const wxPalette
& palette
) : wxWindow()
139 m_glContext
= (wxGLContext
*) NULL
;
141 bool ret
= Create(parent
, id
, pos
, size
, style
, name
);
145 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE
));
146 SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
));
149 m_hDC
= (WXHDC
) ::GetDC((HWND
) GetHWND());
151 SetupPixelFormat(attribList
);
152 SetupPalette(palette
);
154 m_glContext
= new wxGLContext(TRUE
, this, palette
);
157 wxGLCanvas::wxGLCanvas( wxWindow
*parent
,
158 const wxGLContext
*shared
, wxWindowID id
,
159 const wxPoint
& pos
, const wxSize
& size
, long style
, const wxString
& name
,
160 int *attribList
, const wxPalette
& palette
)
163 m_glContext
= (wxGLContext
*) NULL
;
165 bool ret
= Create(parent
, id
, pos
, size
, style
, name
);
169 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE
));
170 SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
));
173 m_hDC
= (WXHDC
) ::GetDC((HWND
) GetHWND());
175 SetupPixelFormat(attribList
);
176 SetupPalette(palette
);
178 m_glContext
= new wxGLContext(TRUE
, this, palette
, shared
);
181 // Not very useful for wxMSW, but this is to be wxGTK compliant
183 wxGLCanvas::wxGLCanvas( wxWindow
*parent
, const wxGLCanvas
*shared
, wxWindowID id
,
184 const wxPoint
& pos
, const wxSize
& size
, long style
, const wxString
& name
,
185 int *attribList
, const wxPalette
& palette
):
188 m_glContext
= (wxGLContext
*) NULL
;
190 bool ret
= Create(parent
, id
, pos
, size
, style
, name
);
194 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE
));
195 SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
));
198 m_hDC
= (WXHDC
) ::GetDC((HWND
) GetHWND());
200 SetupPixelFormat(attribList
);
201 SetupPalette(palette
);
203 wxGLContext
*sharedContext
=0;
204 if (shared
) sharedContext
=shared
->GetContext();
205 m_glContext
= new wxGLContext(TRUE
, this, palette
, sharedContext
);
208 wxGLCanvas::~wxGLCanvas()
213 ::ReleaseDC((HWND
) GetHWND(), (HDC
) m_hDC
);
216 // Replaces wxWindow::Create functionality, since we need to use a different
218 bool wxGLCanvas::Create(wxWindow
*parent
,
223 const wxString
& name
)
225 static bool s_registeredGLCanvasClass
= FALSE
;
227 // We have to register a special window class because we need
228 // the CS_OWNDC style for GLCanvas.
231 From Angel Popov <jumpo@bitex.com>
233 Here are two snips from a dicussion in the OpenGL Gamedev list that explains
234 how this problem can be fixed:
236 "There are 5 common DCs available in Win95. These are aquired when you call
237 GetDC or GetDCEx from a window that does _not_ have the OWNDC flag.
238 OWNDC flagged windows do not get their DC from the common DC pool, the issue
239 is they require 800 bytes each from the limited 64Kb local heap for GDI."
241 "The deal is, if you hold onto one of the 5 shared DC's too long (as GL apps
242 do), Win95 will actually "steal" it from you. MakeCurrent fails,
243 apparently, because Windows re-assigns the HDC to a different window. The
244 only way to prevent this, the only reliable means, is to set CS_OWNDC."
247 if (!s_registeredGLCanvasClass
)
251 // the fields which are common to all classes
252 wndclass
.lpfnWndProc
= (WNDPROC
)wxWndProc
;
253 wndclass
.cbClsExtra
= 0;
254 wndclass
.cbWndExtra
= sizeof( DWORD
); // VZ: what is this DWORD used for?
255 wndclass
.hInstance
= wxhInstance
;
256 wndclass
.hIcon
= (HICON
) NULL
;
257 wndclass
.hCursor
= ::LoadCursor((HINSTANCE
)NULL
, IDC_ARROW
);
258 wndclass
.lpszMenuName
= NULL
;
260 // Register the GLCanvas class name
261 wndclass
.hbrBackground
= (HBRUSH
)NULL
;
262 wndclass
.lpszClassName
= wxGLCanvasClassName
;
263 wndclass
.style
= CS_HREDRAW
| CS_VREDRAW
| CS_DBLCLKS
| CS_OWNDC
;
265 if ( !::RegisterClass(&wndclass
) )
267 wxLogLastError(wxT("RegisterClass(wxGLCanvasClass)"));
271 // Register the GLCanvas class name for windows which don't do full repaint
273 wndclass
.lpszClassName
= wxGLCanvasClassNameNoRedraw
;
274 wndclass
.style
&= ~(CS_HREDRAW
| CS_VREDRAW
);
276 if ( !::RegisterClass(&wndclass
) )
278 wxLogLastError(wxT("RegisterClass(wxGLCanvasClassNameNoRedraw)"));
280 ::UnregisterClass(wxGLCanvasClassName
, wxhInstance
);
285 s_registeredGLCanvasClass
= TRUE
;
288 wxCHECK_MSG( parent
, FALSE
, wxT("can't create wxWindow without parent") );
290 if ( !CreateBase(parent
, id
, pos
, size
, style
, wxDefaultValidator
, name
) )
293 parent
->AddChild(this);
296 if ( style
& wxBORDER
)
297 msflags
|= WS_BORDER
;
298 if ( style
& wxTHICK_FRAME
)
299 msflags
|= WS_THICKFRAME
;
302 A general rule with OpenGL and Win32 is that any window that will have a
303 HGLRC built for it must have two flags: WS_CLIPCHILDREN & WS_CLIPSIBLINGS.
304 You can find references about this within the knowledge base and most OpenGL
305 books that contain the wgl function descriptions.
308 msflags
|= WS_CHILD
| WS_VISIBLE
| WS_CLIPSIBLINGS
| WS_CLIPCHILDREN
;
311 WXDWORD exStyle
= Determine3DEffects(WS_EX_CLIENTEDGE
, &want3D
);
313 // Even with extended styles, need to combine with WS_BORDER
314 // for them to look right.
315 if ( want3D
|| (m_windowStyle
& wxSIMPLE_BORDER
) || (m_windowStyle
& wxRAISED_BORDER
) ||
316 (m_windowStyle
& wxSUNKEN_BORDER
) || (m_windowStyle
& wxDOUBLE_BORDER
))
318 msflags
|= WS_BORDER
;
321 return MSWCreate(wxGLCanvasClassName
, NULL
, pos
, size
, msflags
, exStyle
);
324 static void AdjustPFDForAttributes(PIXELFORMATDESCRIPTOR
& pfd
, int *attribList
)
327 pfd
.dwFlags
&= ~PFD_DOUBLEBUFFER
;
328 pfd
.iPixelType
= PFD_TYPE_COLORINDEX
;
332 while( (attribList
[arg
]!=0) )
334 switch( attribList
[arg
++] )
337 pfd
.iPixelType
= PFD_TYPE_RGBA
;
339 case WX_GL_BUFFER_SIZE
:
340 pfd
.cColorBits
= attribList
[arg
++];
343 // this member looks like it may be obsolete
344 if (attribList
[arg
] > 0) {
345 pfd
.iLayerType
= (BYTE
)PFD_OVERLAY_PLANE
;
346 } else if (attribList
[arg
] < 0) {
347 pfd
.iLayerType
= (BYTE
)PFD_UNDERLAY_PLANE
;
349 pfd
.iLayerType
= (BYTE
)PFD_MAIN_PLANE
;
353 case WX_GL_DOUBLEBUFFER
:
354 pfd
.dwFlags
|= PFD_DOUBLEBUFFER
;
357 pfd
.dwFlags
|= PFD_STEREO
;
359 case WX_GL_AUX_BUFFERS
:
360 pfd
.cAuxBuffers
= attribList
[arg
++];
363 pfd
.cColorBits
+= (pfd
.cRedBits
= attribList
[arg
++]);
365 case WX_GL_MIN_GREEN
:
366 pfd
.cColorBits
+= (pfd
.cGreenBits
= attribList
[arg
++]);
369 pfd
.cColorBits
+= (pfd
.cBlueBits
= attribList
[arg
++]);
371 case WX_GL_MIN_ALPHA
:
372 // doesn't count in cColorBits
373 pfd
.cAlphaBits
= attribList
[arg
++];
375 case WX_GL_DEPTH_SIZE
:
376 pfd
.cDepthBits
= attribList
[arg
++];
378 case WX_GL_STENCIL_SIZE
:
379 pfd
.cStencilBits
= attribList
[arg
++];
381 case WX_GL_MIN_ACCUM_RED
:
382 pfd
.cAccumBits
+= (pfd
.cAccumRedBits
= attribList
[arg
++]);
384 case WX_GL_MIN_ACCUM_GREEN
:
385 pfd
.cAccumBits
+= (pfd
.cAccumGreenBits
= attribList
[arg
++]);
387 case WX_GL_MIN_ACCUM_BLUE
:
388 pfd
.cAccumBits
+= (pfd
.cAccumBlueBits
= attribList
[arg
++]);
390 case WX_GL_MIN_ACCUM_ALPHA
:
391 pfd
.cAccumBits
+= (pfd
.cAccumAlphaBits
= attribList
[arg
++]);
400 void wxGLCanvas::SetupPixelFormat(int *attribList
) // (HDC hDC)
403 PIXELFORMATDESCRIPTOR pfd
= {
404 sizeof(PIXELFORMATDESCRIPTOR
), /* size */
408 PFD_DOUBLEBUFFER
, /* support double-buffering */
409 PFD_TYPE_RGBA
, /* color type */
410 16, /* prefered color depth */
411 0, 0, 0, 0, 0, 0, /* color bits (ignored) */
412 0, /* no alpha buffer */
413 0, /* alpha bits (ignored) */
414 0, /* no accumulation buffer */
415 0, 0, 0, 0, /* accum bits (ignored) */
416 16, /* depth buffer */
417 0, /* no stencil buffer */
418 0, /* no auxiliary buffers */
419 PFD_MAIN_PLANE
, /* main layer */
421 0, 0, 0, /* no layer, visible, damage masks */
424 AdjustPFDForAttributes(pfd
, attribList
);
426 pixelFormat
= ChoosePixelFormat((HDC
) m_hDC
, &pfd
);
427 if (pixelFormat
== 0) {
428 wxLogWarning(_("ChoosePixelFormat failed."));
431 if (SetPixelFormat((HDC
) m_hDC
, pixelFormat
, &pfd
) != TRUE
) {
432 wxLogWarning(_("SetPixelFormat failed."));
437 void wxGLCanvas::SetupPalette(const wxPalette
& palette
)
439 int pixelFormat
= GetPixelFormat((HDC
) m_hDC
);
440 PIXELFORMATDESCRIPTOR pfd
;
442 DescribePixelFormat((HDC
) m_hDC
, pixelFormat
, sizeof(PIXELFORMATDESCRIPTOR
), &pfd
);
444 if (pfd
.dwFlags
& PFD_NEED_PALETTE
)
454 if ( !m_palette
.Ok() )
456 m_palette
= CreateDefaultPalette();
461 SelectPalette((HDC
) m_hDC
, (HPALETTE
) m_palette
.GetHPALETTE(), FALSE
);
462 RealizePalette((HDC
) m_hDC
);
466 wxPalette
wxGLCanvas::CreateDefaultPalette()
468 PIXELFORMATDESCRIPTOR pfd
;
470 int pixelFormat
= GetPixelFormat((HDC
) m_hDC
);
472 DescribePixelFormat((HDC
) m_hDC
, pixelFormat
, sizeof(PIXELFORMATDESCRIPTOR
), &pfd
);
474 paletteSize
= 1 << pfd
.cColorBits
;
477 (LOGPALETTE
*) malloc(sizeof(LOGPALETTE
) + paletteSize
* sizeof(PALETTEENTRY
));
478 pPal
->palVersion
= 0x300;
479 pPal
->palNumEntries
= paletteSize
;
481 /* build a simple RGB color palette */
483 int redMask
= (1 << pfd
.cRedBits
) - 1;
484 int greenMask
= (1 << pfd
.cGreenBits
) - 1;
485 int blueMask
= (1 << pfd
.cBlueBits
) - 1;
488 for (i
=0; i
<paletteSize
; ++i
) {
489 pPal
->palPalEntry
[i
].peRed
=
490 (((i
>> pfd
.cRedShift
) & redMask
) * 255) / redMask
;
491 pPal
->palPalEntry
[i
].peGreen
=
492 (((i
>> pfd
.cGreenShift
) & greenMask
) * 255) / greenMask
;
493 pPal
->palPalEntry
[i
].peBlue
=
494 (((i
>> pfd
.cBlueShift
) & blueMask
) * 255) / blueMask
;
495 pPal
->palPalEntry
[i
].peFlags
= 0;
499 HPALETTE hPalette
= CreatePalette(pPal
);
503 palette
.SetHPALETTE((WXHPALETTE
) hPalette
);
508 void wxGLCanvas::SwapBuffers()
511 m_glContext
->SwapBuffers();
514 void wxGLCanvas::OnSize(wxSizeEvent
& event
)
518 void wxGLCanvas::SetCurrent()
522 m_glContext
->SetCurrent();
526 void wxGLCanvas::SetColour(const char *colour
)
529 m_glContext
->SetColour(colour
);
532 // TODO: Have to have this called by parent frame (?)
533 // So we need wxFrame to call OnQueryNewPalette for all children...
534 void wxGLCanvas::OnQueryNewPalette(wxQueryNewPaletteEvent
& event
)
536 /* realize palette if this is the current window */
537 if ( GetPalette()->Ok() ) {
538 ::UnrealizeObject((HPALETTE
) GetPalette()->GetHPALETTE());
539 ::SelectPalette((HDC
) GetHDC(), (HPALETTE
) GetPalette()->GetHPALETTE(), FALSE
);
540 ::RealizePalette((HDC
) GetHDC());
542 event
.SetPaletteRealized(TRUE
);
545 event
.SetPaletteRealized(FALSE
);
548 // I think this doesn't have to be propagated to child windows.
549 void wxGLCanvas::OnPaletteChanged(wxPaletteChangedEvent
& event
)
551 /* realize palette if this is *not* the current window */
553 GetPalette()->Ok() && (this != event
.GetChangedWindow()) )
555 ::UnrealizeObject((HPALETTE
) GetPalette()->GetHPALETTE());
556 ::SelectPalette((HDC
) GetHDC(), (HPALETTE
) GetPalette()->GetHPALETTE(), FALSE
);
557 ::RealizePalette((HDC
) GetHDC());
562 /* Give extensions proper function names. */
564 /* EXT_vertex_array */
565 void glArrayElementEXT(GLint i
)
569 void glColorPointerEXT(GLint size
, GLenum type
, GLsizei stride
, GLsizei count
, const GLvoid
*pointer
)
573 void glDrawArraysEXT(GLenum mode
, GLint first
, GLsizei count
)
575 #ifdef GL_EXT_vertex_array
576 static PFNGLDRAWARRAYSEXTPROC proc
= 0;
580 proc
= (PFNGLDRAWARRAYSEXTPROC
) wglGetProcAddress("glDrawArraysEXT");
584 (* proc
) (mode
, first
, count
);
588 void glEdgeFlagPointerEXT(GLsizei stride
, GLsizei count
, const GLboolean
*pointer
)
592 void glGetPointervEXT(GLenum pname
, GLvoid
* *params
)
596 void glIndexPointerEXT(GLenum type
, GLsizei stride
, GLsizei count
, const GLvoid
*pointer
)
600 void glNormalPointerEXT(GLenum type
, GLsizei stride
, GLsizei count
, const GLvoid
*pointer
)
602 #ifdef GL_EXT_vertex_array
603 static PFNGLNORMALPOINTEREXTPROC proc
= 0;
607 proc
= (PFNGLNORMALPOINTEREXTPROC
) wglGetProcAddress("glNormalPointerEXT");
611 (* proc
) (type
, stride
, count
, pointer
);
615 void glTexCoordPointerEXT(GLint size
, GLenum type
, GLsizei stride
, GLsizei count
, const GLvoid
*pointer
)
619 void glVertexPointerEXT(GLint size
, GLenum type
, GLsizei stride
, GLsizei count
, const GLvoid
*pointer
)
621 #ifdef GL_EXT_vertex_array
622 static PFNGLVERTEXPOINTEREXTPROC proc
= 0;
626 proc
= (PFNGLVERTEXPOINTEREXTPROC
) wglGetProcAddress("glVertexPointerEXT");
629 (* proc
) (size
, type
, stride
, count
, pointer
);
633 /* EXT_color_subtable */
634 void glColorSubtableEXT(GLenum target
, GLsizei start
, GLsizei count
, GLenum format
, GLenum type
, const GLvoid
*table
)
638 /* EXT_color_table */
639 void glColorTableEXT(GLenum target
, GLenum internalformat
, GLsizei width
, GLenum format
, GLenum type
, const GLvoid
*table
)
643 void glCopyColorTableEXT(GLenum target
, GLenum internalformat
, GLint x
, GLint y
, GLsizei width
)
647 void glGetColorTableEXT(GLenum target
, GLenum format
, GLenum type
, GLvoid
*table
)
651 void glGetColorTableParamaterfvEXT(GLenum target
, GLenum pname
, GLfloat
*params
)
655 void glGetColorTavleParameterivEXT(GLenum target
, GLenum pname
, GLint
*params
)
659 /* SGI_compiled_vertex_array */
660 void glLockArraysSGI(GLint first
, GLsizei count
)
664 void glUnlockArraysSGI()
669 /* SGI_cull_vertex */
670 void glCullParameterdvSGI(GLenum pname
, GLdouble
* params
)
674 void glCullParameterfvSGI(GLenum pname
, GLfloat
* params
)
679 void glIndexFuncSGI(GLenum func
, GLclampf ref
)
683 /* SGI_index_material */
684 void glIndexMaterialSGI(GLenum face
, GLenum mode
)
689 void glAddSwapHintRectWin(GLint x
, GLint y
, GLsizei width
, GLsizei height
)
694 //---------------------------------------------------------------------------
696 //---------------------------------------------------------------------------
698 IMPLEMENT_CLASS(wxGLApp
, wxApp
)
700 bool wxGLApp::InitGLVisual(int *attribList
)
703 PIXELFORMATDESCRIPTOR pfd
= {
704 sizeof(PIXELFORMATDESCRIPTOR
), /* size */
708 PFD_DOUBLEBUFFER
, /* support double-buffering */
709 PFD_TYPE_RGBA
, /* color type */
710 16, /* prefered color depth */
711 0, 0, 0, 0, 0, 0, /* color bits (ignored) */
712 0, /* no alpha buffer */
713 0, /* alpha bits (ignored) */
714 0, /* no accumulation buffer */
715 0, 0, 0, 0, /* accum bits (ignored) */
716 16, /* depth buffer */
717 0, /* no stencil buffer */
718 0, /* no auxiliary buffers */
719 PFD_MAIN_PLANE
, /* main layer */
721 0, 0, 0, /* no layer, visible, damage masks */
724 AdjustPFDForAttributes(pfd
, attribList
);
726 // use DC for whole (root) screen, since no windows have yet been created
727 pixelFormat
= ChoosePixelFormat(ScreenHDC(), &pfd
);
729 if (pixelFormat
== 0) {
730 wxLogError(_("Failed to initialize OpenGL"));