replace use of 'long/int bitmapType' with 'wxBitmapType bitmapType' in richtext and...

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

diff --git a/include/wx/glcanvas.h b/include/wx/glcanvas.h
index 9e1c89ea8e297ce15dc9cb2ff3805699db870a32..a7043a70d89d7e72353f35bb81a546a5024c4194 100644 (file)
--- a/include/wx/glcanvas.h
+++ b/include/wx/glcanvas.h
@@ -20,34 +20,34 @@
 #include "wx/palette.h"
 #include "wx/window.h"
 
 #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
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // 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
 {
 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)

 };
 
 #define wxGLCanvasName _T("GLCanvas")
 };
 
 #define wxGLCanvasName _T("GLCanvas")


@@ -66,7 +66,7 @@ public:
      */
 
     // set this context as the current one
      */
 
     // 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 +77,7 @@ class WXDLLIMPEXP_GL wxGLCanvasBase : public wxWindow
 {
 public:
     // default ctor doesn't initialize the window, use Create() later
 {
 public:
     // default ctor doesn't initialize the window, use Create() later

-    wxGLCanvasBase()
-    {
-#if WXWIN_COMPATIBILITY_2_8
-        m_glContext = NULL;
-#endif
-    }
+    wxGLCanvasBase();

 
     virtual ~wxGLCanvasBase();
 
 
     virtual ~wxGLCanvasBase();
 


@@ -104,15 +99,18 @@ public:
     // ----------
 
     // set the given context associated with this window as the current one
     // ----------
 
     // 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)
 
     // flush the back buffer (if we have it)

-    virtual void SwapBuffers() = 0;
+    virtual bool SwapBuffers() = 0;

 
 
     // accessors
     // ---------
 
 
 
     // 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
     const wxPalette *GetPalette() const { return &m_palette; }
 
     // miscellaneous helper functions


@@ -120,7 +118,7 @@ public:
 
     // call glcolor() for the colour with the given name, return false if
     // colour not found
 
     // 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);

 
 
 
 
 
 


@@ -155,6 +153,22 @@ protected:
 #endif // WXWIN_COMPATIBILITY_2_8
 };
 
 #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__)
 #if defined(__WXMSW__)
     #include "wx/msw/glcanvas.h"
 #elif defined(__WXMOTIF__) || defined(__WXX11__)


@@ -171,20 +185,22 @@ protected:
     #error "wxGLCanvas not supported in this wxWidgets port"
 #endif
 
     #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:
 {
 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)
 };
 
 
 private:
     DECLARE_DYNAMIC_CLASS(wxGLApp)
 };
 

+#endif // !wxGL_APP_DEFINED
+

 #endif // wxUSE_GLCANVAS
 
 #endif // _WX_GLCANVAS_H_BASE_
 #endif // wxUSE_GLCANVAS
 
 #endif // _WX_GLCANVAS_H_BASE_