Correct spelling and signature of FixIndexesOfChildren

[wxWidgets.git] / include / wx / glcanvas.h

diff --git a/include/wx/glcanvas.h b/include/wx/glcanvas.h
index 2a40221169142e0c36364ee3b840621cdec894ac..4722a99a9483ae9b6b3effd7288e4b719c576865 100644 (file)
--- a/include/wx/glcanvas.h
+++ b/include/wx/glcanvas.h
@@ -20,34 +20,36 @@
 #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 antialising supersampling on most graphics cards
 };
 
 #define wxGLCanvasName _T("GLCanvas")
@@ -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;
 };
 
 // ----------------------------------------------------------------------------
@@ -99,15 +101,18 @@ 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);
+
     const wxPalette *GetPalette() const { return &m_palette; }
 
     // miscellaneous helper functions
@@ -115,9 +120,16 @@ public:
 
     // 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
@@ -142,6 +154,10 @@ protected:
     // (not supported in most ports)
     virtual wxPalette CreateDefaultPalette() { return wxNullPalette; }
 
+    // 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);
 
     wxPalette m_palette;
 
@@ -175,7 +191,7 @@ public:
 #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