/////////////////////////////////////////////////////////////////////////////
-// Name: glcanvas.h
-// Purpose: wxGLCanvas, for using OpenGL with wxWindows under Windows
+// Name: wx/msw/glcanvas.h
+// Purpose: wxGLCanvas, for using OpenGL with wxWidgets under Windows
// Author: Julian Smart
// Modified by:
// Created: 04/01/98
// RCS-ID: $Id$
// Copyright: (c) Julian Smart
-// Licence: wxWindows licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma interface "glcanvas.h"
-#endif
-
#ifndef _WX_GLCANVAS_H_
#define _WX_GLCANVAS_H_
-#include <wx/setup.h>
-
-#if wxUSE_GLCANVAS
-
-#include <wx/scrolwin.h>
+#include "wx/palette.h"
-#include <windows.h>
+#include "wx/msw/wrapwin.h"
-#include "gl/gl.h"
+#include <GL/gl.h>
-//---------------------------------------------------------------------------
-// Constants for attriblist
-//---------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
+// wxGLContext: OpenGL rendering context
+// ----------------------------------------------------------------------------
-enum
-{
- WX_GL_RGBA=1, /* use true color palette */
- WX_GL_DEPTH_SIZE, /* bits for Z-buffer (0,16,32) */
- WX_GL_DOUBLEBUFFER, /* use doublebuffer */
- WX_GL_MIN_RED, /* use red buffer with most bits (> MIN_RED bits) */
- WX_GL_MIN_GREEN, /* use green buffer with most bits (> MIN_GREEN bits) */
- WX_GL_MIN_BLUE /* use blue buffer with most bits (> MIN_BLUE bits) */
-/* these are enough constants for now, the remaining will be added later */
-};
-
-class WXDLLEXPORT wxGLCanvas; /* forward reference */
-
-class WXDLLEXPORT wxGLContext: public wxObject
+class WXDLLIMPEXP_GL wxGLContext : public wxGLContextBase
{
public:
- wxGLContext(bool isRGB, wxGLCanvas *win, const wxPalette& palette = wxNullPalette);
- wxGLContext(
- bool isRGB, wxGLCanvas *win,
- const wxPalette& WXUNUSED(palette),
- const wxGLContext *other /* for sharing display lists */
- );
- ~wxGLContext();
-
- void SetCurrent();
- void SetColour(const char *colour);
- void SwapBuffers();
-
-
- inline wxWindow* GetWindow() const { return m_window; }
- inline WXHDC GetHDC() const { return m_hDC; }
- inline HGLRC GetGLRC() const { return m_glContext; }
-
-public:
- HGLRC m_glContext;
- WXHDC m_hDC;
- wxWindow* m_window;
-};
-
-class WXDLLEXPORT wxGLCanvas: public wxScrolledWindow
-{
- DECLARE_CLASS(wxGLCanvas)
- public:
- wxGLCanvas(wxWindow *parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize, long style = 0,
- const wxString& name = "GLCanvas", int *attribList = 0, const wxPalette& palette = wxNullPalette);
- wxGLCanvas( wxWindow *parent, const wxGLContext *shared = (wxGLContext *)NULL,
- wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize, long style = 0, const wxString& name = "GLCanvas",
- int *attribList = (int*) NULL, const wxPalette& palette = wxNullPalette );
-
- wxGLCanvas( wxWindow *parent, const wxGLCanvas *shared = (wxGLCanvas *)NULL, wxWindowID id = -1,
- const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = 0,
- const wxString& name = "GLCanvas", int *attribList = 0, const wxPalette& palette = wxNullPalette );
+ wxGLContext(wxGLCanvas *win, const wxGLContext* other = NULL);
+ virtual ~wxGLContext();
- ~wxGLCanvas();
+ virtual bool SetCurrent(const wxGLCanvas& win) const;
- // Replaces wxWindow::Create functionality, since we need to use a different window class
- bool Create(wxWindow *parent, wxWindowID id,
- const wxPoint& pos, const wxSize& size, long style, const wxString& name);
-
- void SetCurrent();
- void SetColour(const char *colour);
- void SwapBuffers();
-
- void OnSize(wxSizeEvent& event);
-
- void OnQueryNewPalette(wxQueryNewPaletteEvent& event);
- void OnPaletteChanged(wxPaletteChangedEvent& event);
-
- inline wxGLContext* GetContext() const { return m_glContext; }
-
- inline WXHDC GetHDC() const { return m_hDC; }
- void SetupPixelFormat();
- void SetupPalette(const wxPalette& palette);
- wxPalette CreateDefaultPalette();
-
- inline wxPalette* GetPalette() const { return (wxPalette*) & m_palette; }
+ HGLRC GetGLRC() const { return m_glContext; }
protected:
- wxGLContext* m_glContext; // this is typedef-ed ptr, in fact
- wxPalette m_palette;
- WXHDC m_hDC;
+ HGLRC m_glContext;
-DECLARE_EVENT_TABLE()
+private:
+ DECLARE_CLASS(wxGLContext)
};
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/* Give extensions proper function names. */
-
-/* N.B. - this is not completely implemented as yet */
+// ----------------------------------------------------------------------------
+// wxGLCanvas: OpenGL output window
+// ----------------------------------------------------------------------------
-/* EXT_vertex_array */
-void glArrayElementEXT(GLint i);
-void glColorPointerEXT(GLint size, GLenum type, GLsizei stride, GLsizei count, const GLvoid *pointer);
-void glDrawArraysEXT(GLenum mode, GLint first, GLsizei count);
-void glEdgeFlagPointerEXT(GLsizei stride, GLsizei count, const GLboolean *pointer);
-void glGetPointervEXT(GLenum pname, GLvoid* *params);
-void glIndexPointerEXT(GLenum type, GLsizei stride, GLsizei count, const GLvoid *pointer);
-void glNormalPointerEXT(GLenum type, GLsizei stride, GLsizei count, const GLvoid *pointer);
-void glTexCoordPointerEXT(GLint size, GLenum type, GLsizei stride, GLsizei count, const GLvoid *pointer);
-void glVertexPointerEXT(GLint size, GLenum type, GLsizei stride, GLsizei count, const GLvoid *pointer);
-
-/* EXT_color_subtable */
-void glColorSubtableEXT(GLenum target, GLsizei start, GLsizei count, GLenum format, GLenum type, const GLvoid *table);
+class WXDLLIMPEXP_GL wxGLCanvas : public wxGLCanvasBase
+{
+public:
+ wxEXPLICIT // avoid implicitly converting a wxWindow* to wxGLCanvas
+ wxGLCanvas(wxWindow *parent,
+ wxWindowID id = wxID_ANY,
+ const int *attribList = NULL,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = 0,
+ const wxString& name = wxGLCanvasName,
+ const wxPalette& palette = wxNullPalette);
+
+ bool Create(wxWindow *parent,
+ wxWindowID id = wxID_ANY,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = 0,
+ const wxString& name = wxGLCanvasName,
+ const int *attribList = NULL,
+ const wxPalette& palette = wxNullPalette);
+
+ virtual ~wxGLCanvas();
+
+ // implement wxGLCanvasBase methods
+ virtual bool SwapBuffers();
+
+
+ // MSW-specific helpers
+ // --------------------
+
+ // get the HDC used for OpenGL rendering
+ HDC GetHDC() const { return m_hDC; }
+
+ // try to find pixel format matching the given attributes list for the
+ // specified HDC, return 0 on error, otherwise pfd is filled in with the
+ // information from attribList if non-NULL
+ static int ChooseMatchingPixelFormat(HDC hdc, const int *attribList,
+ PIXELFORMATDESCRIPTOR *pfd = NULL);
+
+#if wxUSE_PALETTE
+ // palette stuff
+ bool SetupPalette(const wxPalette& palette);
+ virtual wxPalette CreateDefaultPalette();
+ void OnQueryNewPalette(wxQueryNewPaletteEvent& event);
+ void OnPaletteChanged(wxPaletteChangedEvent& event);
+#endif // wxUSE_PALETTE
+
+ // deprecated methods using the implicit wxGLContext, associate the context
+ // explicitly with the window instead
+#if WXWIN_COMPATIBILITY_2_8
+ wxDEPRECATED(
+ wxGLCanvas(wxWindow *parent,
+ wxWindowID id = wxID_ANY,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = 0,
+ const wxString& name = wxGLCanvasName,
+ const int *attribList = NULL,
+ const wxPalette& palette = wxNullPalette)
+ );
-/* EXT_color_table */
-void glColorTableEXT(GLenum target, GLenum internalformat, GLsizei width, GLenum format, GLenum type, const GLvoid *table);
-void glCopyColorTableEXT(GLenum target, GLenum internalformat, GLint x, GLint y, GLsizei width);
-void glGetColorTableEXT(GLenum target, GLenum format, GLenum type, GLvoid *table);
-void glGetColorTableParamaterfvEXT(GLenum target, GLenum pname, GLfloat *params);
-void glGetColorTavleParameterivEXT(GLenum target, GLenum pname, GLint *params);
+ wxDEPRECATED(
+ wxGLCanvas(wxWindow *parent,
+ const wxGLContext *shared,
+ wxWindowID id = wxID_ANY,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = 0,
+ const wxString& name = wxGLCanvasName,
+ const int *attribList = NULL,
+ const wxPalette& palette = wxNullPalette)
+ );
-/* SGI_compiled_vertex_array */
-void glLockArraysSGI(GLint first, GLsizei count);
-void glUnlockArraysSGI();
+ wxDEPRECATED(
+ wxGLCanvas(wxWindow *parent,
+ const wxGLCanvas *shared,
+ wxWindowID id = wxID_ANY,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = 0,
+ const wxString& name = wxGLCanvasName,
+ const int *attribList = NULL,
+ const wxPalette& palette = wxNullPalette)
+ );
+#endif // WXWIN_COMPATIBILITY_2_8
-/* SGI_cull_vertex */
-void glCullParameterdvSGI(GLenum pname, GLdouble* params);
-void glCullParameterfvSGI(GLenum pname, GLfloat* params);
+protected:
+ // common part of all ctors
+ void Init();
-/* SGI_index_func */
-void glIndexFuncSGI(GLenum func, GLclampf ref);
+ // the real window creation function, Create() may reuse it twice as we may
+ // need to create an OpenGL window to query the available extensions and
+ // then potentially delete and recreate it with another pixel format
+ bool CreateWindow(wxWindow *parent,
+ wxWindowID id = wxID_ANY,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = 0,
+ const wxString& name = wxGLCanvasName);
-/* SGI_index_material */
-void glIndexMaterialSGI(GLenum face, GLenum mode);
+ // set up the pixel format using the given attributes and palette
+ int DoSetup(PIXELFORMATDESCRIPTOR &pfd, const int *attribList);
-/* WIN_swap_hint */
-void glAddSwapHintRectWin(GLint x, GLint y, GLsizei width, GLsizei height);
-#ifdef __cplusplus
-}
-#endif
+ // HDC for this window, we keep it all the time
+ HDC m_hDC;
-#endif
- // wxUSE_GLCANVAS
-#endif
- // _WX_GLCANVAS_H_
+private:
+ DECLARE_EVENT_TABLE()
+ DECLARE_CLASS(wxGLCanvas)
+};
+#endif // _WX_GLCANVAS_H_