X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dc3065a56f1febf3de3b3bbf0904cf8fdc7f7c50..33f3e2b31ed781ba1446b49ec6d3e226c0a5c652:/include/wx/glcanvas.h?ds=sidebyside diff --git a/include/wx/glcanvas.h b/include/wx/glcanvas.h index 9e1c89ea8e..8e7de1f6e9 100644 --- a/include/wx/glcanvas.h +++ b/include/wx/glcanvas.h @@ -20,37 +20,39 @@ #include "wx/palette.h" #include "wx/window.h" -class WXDLLIMPEXP_GL wxGLCanvas; -class WXDLLIMPEXP_GL wxGLContext; +class WXDLLIMPEXP_FWD_GL wxGLCanvas; +class WXDLLIMPEXP_FWD_GL wxGLContext; // ---------------------------------------------------------------------------- // Constants for attributes list // ---------------------------------------------------------------------------- -// The generic OpenGL implementation doesn't support most of these options, -// such as stereo, auxiliary buffers, alpha channel, and accumulator buffer. -// Other implementations may actually support them. +// Notice that not all implementation support options such as stereo, auxiliary +// buffers, alpha channel, and accumulator buffer, use IsDisplaySupported() to +// check for individual attributes support. enum { - WX_GL_RGBA=1, /* use true color palette */ - WX_GL_BUFFER_SIZE, /* bits for buffer if not WX_GL_RGBA */ - WX_GL_LEVEL, /* 0 for main buffer, >0 for overlay, <0 for underlay */ - WX_GL_DOUBLEBUFFER, /* use doublebuffer */ - WX_GL_STEREO, /* use stereoscopic display */ - WX_GL_AUX_BUFFERS, /* number of auxiliary buffers */ - 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) */ - WX_GL_MIN_ALPHA, /* use alpha buffer with most bits (> MIN_ALPHA bits) */ - WX_GL_DEPTH_SIZE, /* bits for Z-buffer (0,16,32) */ - WX_GL_STENCIL_SIZE, /* bits for stencil buffer */ - WX_GL_MIN_ACCUM_RED, /* use red accum buffer with most bits (> MIN_ACCUM_RED bits) */ - WX_GL_MIN_ACCUM_GREEN, /* use green buffer with most bits (> MIN_ACCUM_GREEN bits) */ - WX_GL_MIN_ACCUM_BLUE, /* use blue buffer with most bits (> MIN_ACCUM_BLUE bits) */ - WX_GL_MIN_ACCUM_ALPHA /* use alpha buffer with most bits (> MIN_ACCUM_ALPHA bits) */ + WX_GL_RGBA = 1, // use true color palette (on if no attrs specified) + WX_GL_BUFFER_SIZE, // bits for buffer if not WX_GL_RGBA + WX_GL_LEVEL, // 0 for main buffer, >0 for overlay, <0 for underlay + WX_GL_DOUBLEBUFFER, // use double buffering (on if no attrs specified) + WX_GL_STEREO, // use stereoscopic display + WX_GL_AUX_BUFFERS, // number of auxiliary buffers + 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) + WX_GL_MIN_ALPHA, // use alpha buffer with most bits (> MIN_ALPHA bits) + WX_GL_DEPTH_SIZE, // bits for Z-buffer (0,16,32) + WX_GL_STENCIL_SIZE, // bits for stencil buffer + WX_GL_MIN_ACCUM_RED, // use red accum buffer with most bits (> MIN_ACCUM_RED bits) + WX_GL_MIN_ACCUM_GREEN, // use green buffer with most bits (> MIN_ACCUM_GREEN bits) + WX_GL_MIN_ACCUM_BLUE, // use blue buffer with most bits (> MIN_ACCUM_BLUE bits) + WX_GL_MIN_ACCUM_ALPHA, // use alpha buffer with most bits (> MIN_ACCUM_ALPHA bits) + WX_GL_SAMPLE_BUFFERS, // 1 for multisampling support (antialiasing) + WX_GL_SAMPLES // 4 for 2x2 antialiasing supersampling on most graphics cards }; -#define wxGLCanvasName _T("GLCanvas") +#define wxGLCanvasName wxT("GLCanvas") // ---------------------------------------------------------------------------- // wxGLContextBase: OpenGL rendering context @@ -66,7 +68,7 @@ public: */ // set this context as the current one - virtual void SetCurrent(const wxGLCanvas& win) const = 0; + virtual bool SetCurrent(const wxGLCanvas& win) const = 0; }; // ---------------------------------------------------------------------------- @@ -77,12 +79,7 @@ class WXDLLIMPEXP_GL wxGLCanvasBase : public wxWindow { public: // default ctor doesn't initialize the window, use Create() later - wxGLCanvasBase() - { -#if WXWIN_COMPATIBILITY_2_8 - m_glContext = NULL; -#endif - } + wxGLCanvasBase(); virtual ~wxGLCanvasBase(); @@ -104,25 +101,36 @@ public: // ---------- // set the given context associated with this window as the current one - void SetCurrent(const wxGLContext& context) const; + bool SetCurrent(const wxGLContext& context) const; // flush the back buffer (if we have it) - virtual void SwapBuffers() = 0; + virtual bool SwapBuffers() = 0; // accessors // --------- + // check if the given attributes are supported without creating a canvas + static bool IsDisplaySupported(const int *attribList); + +#if wxUSE_PALETTE const wxPalette *GetPalette() const { return &m_palette; } +#endif // wxUSE_PALETTE // miscellaneous helper functions // ------------------------------ // call glcolor() for the colour with the given name, return false if // colour not found - bool SetColour(const wxChar *colour); - + bool SetColour(const wxString& colour); + // return true if the extension with given name is supported + // + // notice that while this function is implemented for all of GLX, WGL and + // AGL the extensions names are usually not the same for different + // platforms and so the code using it still usually uses conditional + // compilation + static bool IsExtensionSupported(const char *extension); // deprecated methods using the implicit wxGLContext #if WXWIN_COMPATIBILITY_2_8 @@ -135,7 +143,7 @@ public: #ifdef __WXUNIVERSAL__ // resolve the conflict with wxWindowUniv::SetCurrent() - virtual bool SetCurrent(bool doit) { return wxWindow::SetCurrent(doit); }; + virtual bool SetCurrent(bool doit) { return wxWindow::SetCurrent(doit); } #endif protected: @@ -143,18 +151,40 @@ protected: // (currently only implemented in wxX11 and wxMotif ports) virtual int GetColourIndex(const wxColour& WXUNUSED(col)) { return -1; } + // check if the given extension name is present in the space-separated list + // of extensions supported by the current implementation such as returned + // by glXQueryExtensionsString() or glGetString(GL_EXTENSIONS) + static bool IsExtensionInList(const char *list, const char *extension); + +#if wxUSE_PALETTE // create default palette if we're not using RGBA mode // (not supported in most ports) virtual wxPalette CreateDefaultPalette() { return wxNullPalette; } - wxPalette m_palette; +#endif // wxUSE_PALETTE #if WXWIN_COMPATIBILITY_2_8 wxGLContext *m_glContext; #endif // WXWIN_COMPATIBILITY_2_8 }; +// ---------------------------------------------------------------------------- +// wxGLApp: a special wxApp subclass for OpenGL applications which must be used +// to select a visual compatible with the given attributes +// ---------------------------------------------------------------------------- + +class WXDLLIMPEXP_GL wxGLAppBase : public wxApp +{ +public: + wxGLAppBase() : wxApp() { } + + // use this in the constructor of the user-derived wxGLApp class to + // determine if an OpenGL rendering context with these attributes + // is available - returns true if so, false if not. + virtual bool InitGLVisual(const int *attribList) = 0; +}; + #if defined(__WXMSW__) #include "wx/msw/glcanvas.h" #elif defined(__WXMOTIF__) || defined(__WXX11__) @@ -164,27 +194,56 @@ protected: #elif defined(__WXGTK__) #include "wx/gtk1/glcanvas.h" #elif defined(__WXMAC__) - #include "wx/mac/glcanvas.h" + #include "wx/osx/glcanvas.h" #elif defined(__WXCOCOA__) #include "wx/cocoa/glcanvas.h" #else #error "wxGLCanvas not supported in this wxWidgets port" #endif -class WXDLLIMPEXP_GL wxGLApp : public wxApp +// wxMac and wxMSW don't need anything extra in wxGLAppBase, so declare it here +#ifndef wxGL_APP_DEFINED + +class WXDLLIMPEXP_GL wxGLApp : public wxGLAppBase { public: - wxGLApp() : wxApp() { } + wxGLApp() : wxGLAppBase() { } - // use this in the constructor of the user-derived wxGLApp class to - // determine if an OpenGL rendering context with these attributes - // is available - returns true if so, false if not. - bool InitGLVisual(const int *attribList); + virtual bool InitGLVisual(const int *attribList); private: DECLARE_DYNAMIC_CLASS(wxGLApp) }; +#endif // !wxGL_APP_DEFINED + +// ---------------------------------------------------------------------------- +// wxGLAPI: an API wrapper that allows the use of 'old' APIs even on OpenGL +// platforms that don't support it natively anymore, if the APIs are available +// it's a mere redirect +// ---------------------------------------------------------------------------- + +#ifndef wxUSE_OPENGL_EMULATION + #define wxUSE_OPENGL_EMULATION 0 +#endif + +class WXDLLIMPEXP_GL wxGLAPI : public wxObject +{ +public: + wxGLAPI(); + ~wxGLAPI(); + + static void glFrustum(GLfloat left, GLfloat right, GLfloat bottom, + GLfloat top, GLfloat zNear, GLfloat zFar); + static void glBegin(GLenum mode); + static void glTexCoord2f(GLfloat s, GLfloat t); + static void glVertex3f(GLfloat x, GLfloat y, GLfloat z); + static void glNormal3f(GLfloat nx, GLfloat ny, GLfloat nz); + static void glColor4f(GLfloat r, GLfloat g, GLfloat b, GLfloat a); + static void glColor3f(GLfloat r, GLfloat g, GLfloat b); + static void glEnd(); +}; + #endif // wxUSE_GLCANVAS #endif // _WX_GLCANVAS_H_BASE_