Improve wxGLCanvas to be more type safe and better support modern OpenGL

Add wxGLAttribsBase, wxGLAttributes and wxGLContextAttrs replacing the old
untyped "int attributes[]".

Don't use global object for creating OpenGL > 3.0 contexts.

Closes #16909.
This commit is contained in:
Manuel Martin
2016-02-23 00:30:49 +01:00
committed by Vadim Zeitlin
parent fb5ff50eda
commit bdc95f5766
17 changed files with 2964 additions and 1089 deletions

View File

@@ -59,6 +59,8 @@ Changes in behaviour which may result in build errors
- Added wxNativeWindow allowing to embed native widgets in wxWidgets programs. - Added wxNativeWindow allowing to embed native widgets in wxWidgets programs.
- Improve wxGLCanvas to be more type safe and better support modern OpenGL.
All: All:
- Add UTF-8 and ZIP 64 support to wxZip{Input,Output}Stream (Tobias Taschner). - Add UTF-8 and ZIP 64 support to wxZip{Input,Output}Stream (Tobias Taschner).

View File

@@ -49,13 +49,120 @@ enum
WX_GL_MIN_ACCUM_ALPHA, // use alpha buffer with most bits (> MIN_ACCUM_ALPHA 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_SAMPLE_BUFFERS, // 1 for multisampling support (antialiasing)
WX_GL_SAMPLES, // 4 for 2x2 antialiasing supersampling on most graphics cards WX_GL_SAMPLES, // 4 for 2x2 antialiasing supersampling on most graphics cards
WX_GL_FRAMEBUFFER_SRGB,// capability for sRGB framebuffer
// Context attributes
WX_GL_CORE_PROFILE, // use an OpenGL core profile WX_GL_CORE_PROFILE, // use an OpenGL core profile
WX_GL_MAJOR_VERSION, // major OpenGL version of the core profile WX_GL_MAJOR_VERSION, // major OpenGL version of the core profile
WX_GL_MINOR_VERSION // minor OpenGL version of the core profile WX_GL_MINOR_VERSION, // minor OpenGL version of the core profile
wx_GL_COMPAT_PROFILE, // use compatible profile (use all versions features)
WX_GL_FORWARD_COMPAT, // forward compatible context. OpenGL >= 3.0
WX_GL_ES2, // ES or ES2 context.
WX_GL_DEBUG, // create a debug context
WX_GL_ROBUST_ACCESS, // robustness.
WX_GL_NO_RESET_NOTIFY, // never deliver notification of reset events
WX_GL_LOSE_ON_RESET, // if graphics reset, all context state is lost
WX_GL_RESET_ISOLATION, // protect other apps or share contexts from reset side-effects
WX_GL_RELEASE_FLUSH, // on context release, flush pending commands
WX_GL_RELEASE_NONE // on context release, pending commands are not flushed
}; };
#define wxGLCanvasName wxT("GLCanvas") #define wxGLCanvasName wxT("GLCanvas")
// ----------------------------------------------------------------------------
// wxGLAttribsBase: OpenGL rendering attributes
// ----------------------------------------------------------------------------
class WXDLLIMPEXP_GL wxGLAttribsBase
{
public:
wxGLAttribsBase() { Reset(); }
// Setters
void AddAttribute(int attribute) { m_GLValues.push_back(attribute); }
// Search for searchVal and combine the next value with combineVal
void AddAttribBits(int searchVal, int combineVal);
// ARB functions necessity
void SetNeedsARB(bool needsARB = true) { m_needsARB = needsARB; }
// Delete contents
void Reset()
{
m_GLValues.clear();
m_needsARB = false;
}
// Accessors
const int* GetGLAttrs() const
{
return (m_GLValues.empty() || !m_GLValues[0]) ? NULL : &*m_GLValues.begin();
}
int GetSize() const { return (int)(m_GLValues.size()); }
// ARB function (e.g. wglCreateContextAttribsARB) is needed
bool NeedsARB() const { return m_needsARB; }
private:
wxVector<int> m_GLValues;
bool m_needsARB;
};
// ----------------------------------------------------------------------------
// wxGLContextAttrs: OpenGL rendering context attributes
// ----------------------------------------------------------------------------
class WXDLLIMPEXP_GL wxGLContextAttrs : public wxGLAttribsBase
{
public:
// Setters, allowing chained calls
wxGLContextAttrs& CoreProfile();
wxGLContextAttrs& MajorVersion(int val);
wxGLContextAttrs& MinorVersion(int val);
wxGLContextAttrs& OGLVersion(int vmayor, int vminor)
{ return MajorVersion(vmayor).MinorVersion(vminor); }
wxGLContextAttrs& CompatibilityProfile();
wxGLContextAttrs& ForwardCompatible();
wxGLContextAttrs& ES2();
wxGLContextAttrs& DebugCtx();
wxGLContextAttrs& Robust();
wxGLContextAttrs& NoResetNotify();
wxGLContextAttrs& LoseOnReset();
wxGLContextAttrs& ResetIsolation();
wxGLContextAttrs& ReleaseFlush(int val = 1); //'int' allows future values
wxGLContextAttrs& PlatformDefaults();
void EndList(); // No more values can be chained
// Currently only used for X11 context creation
bool x11Direct; // X11 direct render
bool renderTypeRGBA;
};
// ----------------------------------------------------------------------------
// wxGLAttributes: canvas configuration
// ----------------------------------------------------------------------------
class WXDLLIMPEXP_GL wxGLAttributes : public wxGLAttribsBase
{
public:
// Setters, allowing chained calls
wxGLAttributes& RGBA();
wxGLAttributes& BufferSize(int val);
wxGLAttributes& Level(int val);
wxGLAttributes& DoubleBuffer();
wxGLAttributes& Stereo();
wxGLAttributes& AuxBuffers(int val);
wxGLAttributes& MinRGBA(int mRed, int mGreen, int mBlue, int mAlpha);
wxGLAttributes& Depth(int val);
wxGLAttributes& Stencil(int val);
wxGLAttributes& MinAcumRGBA(int mRed, int mGreen, int mBlue, int mAlpha);
wxGLAttributes& PlatformDefaults();
wxGLAttributes& Defaults();
wxGLAttributes& SampleBuffers(int val);
wxGLAttributes& Samplers(int val);
wxGLAttributes& FrameBuffersRGB();
void EndList(); // No more values can be chained
};
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
// wxGLContextBase: OpenGL rendering context // wxGLContextBase: OpenGL rendering context
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
@@ -63,14 +170,20 @@ enum
class WXDLLIMPEXP_GL wxGLContextBase : public wxObject class WXDLLIMPEXP_GL wxGLContextBase : public wxObject
{ {
public: public:
/*
The derived class should provide a ctor with this signature:
wxGLContext(wxGLCanvas *win, const wxGLContext *other = NULL); // The derived class should provide a ctor with this signature:
*/ //
// wxGLContext(wxGLCanvas *win,
// const wxGLContext *other = NULL,
// const wxGLContextAttrs *ctxAttrs = NULL);
// set this context as the current one // set this context as the current one
virtual bool SetCurrent(const wxGLCanvas& win) const = 0; virtual bool SetCurrent(const wxGLCanvas& win) const = 0;
bool IsOK() { return m_isOk; }
protected:
bool m_isOk;
}; };
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
@@ -90,8 +203,8 @@ public:
The derived class should provide a ctor with this signature: The derived class should provide a ctor with this signature:
wxGLCanvas(wxWindow *parent, wxGLCanvas(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id = wxID_ANY, wxWindowID id = wxID_ANY,
int* attribList = 0,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize,
long style = 0, long style = 0,
@@ -113,6 +226,7 @@ public:
// --------- // ---------
// check if the given attributes are supported without creating a canvas // check if the given attributes are supported without creating a canvas
static bool IsDisplaySupported(const wxGLAttributes& dispAttrs);
static bool IsDisplaySupported(const int *attribList); static bool IsDisplaySupported(const int *attribList);
#if wxUSE_PALETTE #if wxUSE_PALETTE
@@ -134,6 +248,11 @@ public:
// compilation // compilation
static bool IsExtensionSupported(const char *extension); static bool IsExtensionSupported(const char *extension);
// Get the wxGLContextAttrs object filled with the context-related values
// of the list of attributes passed at ctor when no wxGLAttributes is used
// as a parameter
wxGLContextAttrs& GetGLCTXAttrs() { return m_GLCTXAttrs; }
// deprecated methods using the implicit wxGLContext // deprecated methods using the implicit wxGLContext
#if WXWIN_COMPATIBILITY_2_8 #if WXWIN_COMPATIBILITY_2_8
wxDEPRECATED( wxGLContext* GetContext() const ); wxDEPRECATED( wxGLContext* GetContext() const );
@@ -158,6 +277,15 @@ protected:
// by glXQueryExtensionsString() or glGetString(GL_EXTENSIONS) // by glXQueryExtensionsString() or glGetString(GL_EXTENSIONS)
static bool IsExtensionInList(const char *list, const char *extension); static bool IsExtensionInList(const char *list, const char *extension);
// For the case of "int* attribList" at ctor is != 0
wxGLContextAttrs m_GLCTXAttrs;
// Extract pixel format and context attributes.
// Return false if an unknown attribute is found.
static bool ParseAttribList(const int* attribList,
wxGLAttributes& dispAttrs,
wxGLContextAttrs* ctxAttrs = NULL);
#if wxUSE_PALETTE #if wxUSE_PALETTE
// create default palette if we're not using RGBA mode // create default palette if we're not using RGBA mode
// (not supported in most ports) // (not supported in most ports)

View File

@@ -20,6 +20,16 @@
class WXDLLIMPEXP_GL wxGLCanvas : public wxGLCanvasX11 class WXDLLIMPEXP_GL wxGLCanvas : public wxGLCanvasX11
{ {
public: public:
wxGLCanvas(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxGLCanvasName,
const wxPalette& palette = wxNullPalette);
wxEXPLICIT // avoid implicitly converting a wxWindow* to wxGLCanvas
wxGLCanvas(wxWindow *parent, wxGLCanvas(wxWindow *parent,
wxWindowID id = wxID_ANY, wxWindowID id = wxID_ANY,
const int *attribList = NULL, const int *attribList = NULL,
@@ -29,6 +39,15 @@ public:
const wxString& name = wxGLCanvasName, const wxString& name = wxGLCanvasName,
const wxPalette& palette = wxNullPalette); const wxPalette& palette = wxNullPalette);
bool Create(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxGLCanvasName,
const wxPalette& palette = wxNullPalette);
bool Create(wxWindow *parent, bool Create(wxWindow *parent,
wxWindowID id = wxID_ANY, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,

View File

@@ -20,6 +20,16 @@
class WXDLLIMPEXP_GL wxGLCanvas : public wxGLCanvasX11 class WXDLLIMPEXP_GL wxGLCanvas : public wxGLCanvasX11
{ {
public: public:
wxGLCanvas(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxGLCanvasName,
const wxPalette& palette = wxNullPalette);
wxEXPLICIT // avoid implicitly converting a wxWindow* to wxGLCanvas
wxGLCanvas(wxWindow *parent, wxGLCanvas(wxWindow *parent,
wxWindowID id = wxID_ANY, wxWindowID id = wxID_ANY,
const int *attribList = NULL, const int *attribList = NULL,
@@ -29,6 +39,15 @@ public:
const wxString& name = wxGLCanvasName, const wxString& name = wxGLCanvasName,
const wxPalette& palette = wxNullPalette); const wxPalette& palette = wxNullPalette);
bool Create(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxGLCanvasName,
const wxPalette& palette = wxNullPalette);
bool Create(wxWindow *parent, bool Create(wxWindow *parent,
wxWindowID id = wxID_ANY, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,

View File

@@ -24,7 +24,9 @@
class WXDLLIMPEXP_GL wxGLContext : public wxGLContextBase class WXDLLIMPEXP_GL wxGLContext : public wxGLContextBase
{ {
public: public:
wxGLContext(wxGLCanvas *win, const wxGLContext* other = NULL); wxGLContext(wxGLCanvas *win,
const wxGLContext *other = NULL,
const wxGLContextAttrs *ctxAttrs = NULL);
virtual ~wxGLContext(); virtual ~wxGLContext();
virtual bool SetCurrent(const wxGLCanvas& win) const; virtual bool SetCurrent(const wxGLCanvas& win) const;
@@ -46,6 +48,16 @@ class WXDLLIMPEXP_GL wxGLCanvas : public wxGLCanvasBase
{ {
public: public:
wxEXPLICIT // avoid implicitly converting a wxWindow* to wxGLCanvas wxEXPLICIT // avoid implicitly converting a wxWindow* to wxGLCanvas
wxGLCanvas(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxGLCanvasName,
const wxPalette& palette = wxNullPalette);
wxEXPLICIT
wxGLCanvas(wxWindow *parent, wxGLCanvas(wxWindow *parent,
wxWindowID id = wxID_ANY, wxWindowID id = wxID_ANY,
const int *attribList = NULL, const int *attribList = NULL,
@@ -55,6 +67,15 @@ public:
const wxString& name = wxGLCanvasName, const wxString& name = wxGLCanvasName,
const wxPalette& palette = wxNullPalette); const wxPalette& palette = wxNullPalette);
bool Create(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxGLCanvasName,
const wxPalette& palette = wxNullPalette);
bool Create(wxWindow *parent, bool Create(wxWindow *parent,
wxWindowID id = wxID_ANY, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
@@ -76,9 +97,12 @@ public:
// get the HDC used for OpenGL rendering // get the HDC used for OpenGL rendering
HDC GetHDC() const { return m_hDC; } HDC GetHDC() const { return m_hDC; }
// try to find pixel format matching the given attributes list for the // 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 // specified HDC, return 0 on error, otherwise ppfd is filled in with the
// information from attribList if non-NULL // information from dispAttrs
static int FindMatchingPixelFormat(const wxGLAttributes& dispAttrs,
PIXELFORMATDESCRIPTOR* ppfd = NULL);
// Same as FindMatchingPixelFormat
static int ChooseMatchingPixelFormat(HDC hdc, const int *attribList, static int ChooseMatchingPixelFormat(HDC hdc, const int *attribList,
PIXELFORMATDESCRIPTOR *pfd = NULL); PIXELFORMATDESCRIPTOR *pfd = NULL);

View File

@@ -29,13 +29,18 @@ WXDLLIMPEXP_GL void WXGLDestroyContext( WXGLContext context );
WXDLLIMPEXP_GL WXGLContext WXGLGetCurrentContext(); WXDLLIMPEXP_GL WXGLContext WXGLGetCurrentContext();
WXDLLIMPEXP_GL bool WXGLSetCurrentContext(WXGLContext context); WXDLLIMPEXP_GL bool WXGLSetCurrentContext(WXGLContext context);
WXDLLIMPEXP_GL WXGLPixelFormat WXGLChoosePixelFormat(const int *attribList); WXDLLIMPEXP_GL WXGLPixelFormat WXGLChoosePixelFormat(const int *GLAttrs = NULL,
int n1 = 0,
const int *ctxAttrs = NULL,
int n2 = 0);
WXDLLIMPEXP_GL void WXGLDestroyPixelFormat( WXGLPixelFormat pixelFormat ); WXDLLIMPEXP_GL void WXGLDestroyPixelFormat( WXGLPixelFormat pixelFormat );
class WXDLLIMPEXP_GL wxGLContext : public wxGLContextBase class WXDLLIMPEXP_GL wxGLContext : public wxGLContextBase
{ {
public: public:
wxGLContext(wxGLCanvas *win, const wxGLContext *other = NULL); wxGLContext(wxGLCanvas *win,
const wxGLContext *other = NULL,
const wxGLContextAttrs *ctxAttrs = NULL);
virtual ~wxGLContext(); virtual ~wxGLContext();
virtual bool SetCurrent(const wxGLCanvas& win) const; virtual bool SetCurrent(const wxGLCanvas& win) const;
@@ -52,6 +57,15 @@ private:
class WXDLLIMPEXP_GL wxGLCanvas : public wxGLCanvasBase class WXDLLIMPEXP_GL wxGLCanvas : public wxGLCanvasBase
{ {
public: public:
wxGLCanvas(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxGLCanvasName,
const wxPalette& palette = wxNullPalette);
wxGLCanvas(wxWindow *parent, wxGLCanvas(wxWindow *parent,
wxWindowID id = wxID_ANY, wxWindowID id = wxID_ANY,
const int *attribList = NULL, const int *attribList = NULL,
@@ -61,6 +75,15 @@ public:
const wxString& name = wxGLCanvasName, const wxString& name = wxGLCanvasName,
const wxPalette& palette = wxNullPalette); const wxPalette& palette = wxNullPalette);
bool Create(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxGLCanvasName,
const wxPalette& palette = wxNullPalette);
bool Create(wxWindow *parent, bool Create(wxWindow *parent,
wxWindowID id = wxID_ANY, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
@@ -85,6 +108,9 @@ public:
// return the pixel format used by this window // return the pixel format used by this window
WXGLPixelFormat GetWXGLPixelFormat() const { return m_glFormat; } WXGLPixelFormat GetWXGLPixelFormat() const { return m_glFormat; }
// Return the copy of attributes passed at ctor
wxGLAttributes& GetGLDispAttrs() { return m_GLAttrs; }
// update the view port of the current context to match this window // update the view port of the current context to match this window
void SetViewport(); void SetViewport();
@@ -133,6 +159,7 @@ public:
protected: protected:
WXGLPixelFormat m_glFormat; WXGLPixelFormat m_glFormat;
wxGLAttributes m_GLAttrs;
#if wxOSX_USE_CARBON #if wxOSX_USE_CARBON
bool m_macCanvasIsShown, bool m_macCanvasIsShown,

View File

@@ -12,6 +12,9 @@
#include <GL/glx.h> #include <GL/glx.h>
class wxGLContextAttrs;
class wxGLAttributes;
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
// wxGLContext // wxGLContext
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
@@ -19,7 +22,9 @@
class WXDLLIMPEXP_GL wxGLContext : public wxGLContextBase class WXDLLIMPEXP_GL wxGLContext : public wxGLContextBase
{ {
public: public:
wxGLContext(wxGLCanvas *win, const wxGLContext *other = NULL); wxGLContext(wxGLCanvas *win,
const wxGLContext *other = NULL,
const wxGLContextAttrs *ctxAttrs = NULL);
virtual ~wxGLContext(); virtual ~wxGLContext();
virtual bool SetCurrent(const wxGLCanvas& win) const wxOVERRIDE; virtual bool SetCurrent(const wxGLCanvas& win) const wxOVERRIDE;
@@ -46,8 +51,8 @@ public:
// default ctor doesn't do anything, InitVisual() must be called // default ctor doesn't do anything, InitVisual() must be called
wxGLCanvasX11(); wxGLCanvasX11();
// initializes the XVisualInfo corresponding to the given attributes // initializes GLXFBConfig and XVisualInfo corresponding to the given attributes
bool InitVisual(const int *attribList); bool InitVisual(const wxGLAttributes& dispAttrs);
// frees XVisualInfo info // frees XVisualInfo info
virtual ~wxGLCanvasX11(); virtual ~wxGLCanvasX11();
@@ -75,10 +80,6 @@ public:
// GLX-specific methods // GLX-specific methods
// -------------------- // --------------------
// return attribs for glXCreateContextAttribsARB
const int *GetGLXContextAttribs() const { return m_glxContextAttribs; }
// override some wxWindow methods // override some wxWindow methods
// ------------------------------ // ------------------------------
@@ -108,22 +109,10 @@ public:
// //
// returns false if XVisualInfo couldn't be initialized, otherwise caller // returns false if XVisualInfo couldn't be initialized, otherwise caller
// is responsible for freeing the pointers // is responsible for freeing the pointers
static bool InitXVisualInfo(const int *attribList, static bool InitXVisualInfo(const wxGLAttributes& dispAttrs,
GLXFBConfig **pFBC, XVisualInfo **pXVisual); GLXFBConfig **pFBC, XVisualInfo **pXVisual);
private: private:
// initializes glxContextAttribs as defined by wxattrs which must be
// 0-terminated
static void InitGLXContextAttribs(const int *wxattrs, int *glxctxattribs);
// fills in glattrs with attributes defined by wxattrs which must be
// 0-terminated if it is non-NULL
// will ignore any gl context attribs
//
// n is the max size of glattrs, false is returned if we overflow it, it
// should be at least 16 to accommodate the default attributes
static bool ConvertWXAttrsToGL(const int *wxattrs, int *glattrs, size_t n);
// this is only used if it's supported i.e. if GL >= 1.3 // this is only used if it's supported i.e. if GL >= 1.3
GLXFBConfig *m_fbc; GLXFBConfig *m_fbc;
@@ -134,10 +123,6 @@ private:
// the global/default versions of the above // the global/default versions of the above
static GLXFBConfig *ms_glFBCInfo; static GLXFBConfig *ms_glFBCInfo;
static XVisualInfo *ms_glVisualInfo; static XVisualInfo *ms_glVisualInfo;
// max 8 attributes plus terminator
// if first is 0, create legacy context
int m_glxContextAttribs[9];
}; };
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------

View File

@@ -17,6 +17,16 @@
class WXDLLIMPEXP_GL wxGLCanvas : public wxGLCanvasX11 class WXDLLIMPEXP_GL wxGLCanvas : public wxGLCanvasX11
{ {
public: public:
wxGLCanvas(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxGLCanvasName,
const wxPalette& palette = wxNullPalette);
wxEXPLICIT // avoid implicitly converting a wxWindow* to wxGLCanvas
wxGLCanvas(wxWindow *parent, wxGLCanvas(wxWindow *parent,
wxWindowID id = wxID_ANY, wxWindowID id = wxID_ANY,
const int *attribList = NULL, const int *attribList = NULL,
@@ -26,6 +36,15 @@ public:
const wxString& name = wxGLCanvasName, const wxString& name = wxGLCanvasName,
const wxPalette& palette = wxNullPalette); const wxPalette& palette = wxNullPalette);
bool Create(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxGLCanvasName,
const wxPalette& palette = wxNullPalette);
bool Create(wxWindow *parent, bool Create(wxWindow *parent,
wxWindowID id = wxID_ANY, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,

View File

@@ -5,6 +5,433 @@
// Licence: wxWindows licence // Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/**
@class wxGLAttribsBase
This is the base class for wxGLAttributes and wxGLContextAttrs.
It stores internally the list required by OS and OpenGL driver for setting
display and rendering context attributes.
Normally this class is not used directly. But there's a case where it its
member functions are useful: setting attributes not handled by wxWidgets.
Suppose the OpenGL Board sets a new functionality of the context, by adding
a new attribute (let's call it NEW_CTX_F) and also a new type of context by
allowing a new bit value (let's call it NEW_BITS) for the CONTEXT_PROFILE_MASK_ARB
value. These new values can be added to the list using code like this:
@code
wxGLContextAttrs cxtAttrs;
// Some values
cxtAttrs.CoreProfile().OGLVersion(5, 0); // OGL 5.0, whenever available
cxtAttrs.PlatformDefaults();
// Values usually are platform-dependant named (even value assigned!)
#if defined(__WXMSW__)
cxtAttrs.AddAttribute(WGL_NEW_CTX_F);
cxtAttrs.AddAttribBits(WGL_CONTEXT_PROFILE_MASK_ARB, WGL_NEW_BITS);
#elif defined(__WXX11__)
cxtAttrs.AddAttribute(GLX_NEW_CTX_F);
cxtAttrs.AddAttribBits(GLX_CONTEXT_PROFILE_MASK_ARB, GLX_NEW_BITS);
#else
// Other platforms
#endif
cxtAttrs.EndList(); // Don't forget this
cxtAttrs.SetNeedsARB(true); // Context attributes are set by an ARB-function
@endcode
@since 3.1.0
@library{wxgl}
@category{gl}
@see wxGLCanvas, wxGLContext, wxGLContextAttrs, wxGLAttributes
*/
class WXDLLIMPEXP_GL wxGLAttribsBase
{
public:
/// Constructor.
wxGLAttribsBase();
/**
Adds an integer value to the list of attributes.
@param attribute
The value to add.
*/
void AddAttribute(int attribute);
/**
Combine (bitwise OR) a given value with the existing one, if any.
This function first searches for an identifier and then combines the
given value with the value right after the identifier.
If the identifier is not found, two new values (i.e. the identifier and
the given value) are added to the list.
@param searchVal
The identifier to search for.
@param combineVal
The value to combine with the existing one.
*/
void AddAttribBits(int searchVal, int combineVal);
/**
Sets the necessity of using special ARB-functions
(e.g. wglCreateContextAttribsARB in MSW) for some of the attributes of
the list.
Multi-sampling and modern context require these ARB-functions.
@param needsARB
@true if an ARB-function is needed for any of the attributes.
@see NeedsARB
*/
void SetNeedsARB(bool needsARB = true);
/// Delete contents and sets ARB-flag to false.
void Reset();
/**
Returns a pointer to the internal list of attributes. It's very unlikely
you need this function.
If the list is empty the returned value is @NULL.
*/
const int* GetGLAttrs() const;
/** Returns the size of the internal list of attributes.
Remember that the last value in the list must be a '0' (zero). So, a
minimal list is of size = 2, the first value is meaningful and the last is '0'.
*/
int GetSize();
/**
Returns the current value of the ARB-flag.
@see SetNeedsARB
*/
bool NeedsARB() const;
};
/**
@class wxGLAttributes
This class is used for setting display attributes when drawing through
OpenGL ("Pixel format" in MSW and OSX parlance, "Configs" in X11).
While framebuffer depth and samplers are still common, attributes
like layers overlay or not using true colour are rarely used nowadays.
Attributes can be chained. For example:
@code
wxGLAttributes dispAttrs;
dispAttrs.PlatformDefaults().MinRGBA(8, 8, 8, 8).DoubleBuffer().Depth(32).EndList();
@endcode
Notice that EndList() must be used as the last attribute. Not adding it will
likely result in nothing displayed at all.
@note Not all of platform-dependant available attributes are implemented in
wxWidgets. You can set other attributes by using AddAttribute() and
AddAttribBits() functions inherited from the base wxGLAttribsBase class.
@since 3.1.0
@library{wxgl}
@category{gl}
@see wxGLCanvas, wxGLContext, wxGLAttribsBase, wxGLContextAttrs
*/
class wxGLAttributes : public wxGLAttribsBase
{
public:
/**
Use true color (8 bits for each color plus 8 bits for alpha channel).
*/
wxGLAttributes& RGBA();
/**
Specifies the number of bits for buffer when it isn't a RGBA buffer.
It makes no effect for OS X.
@param val
The number of bits.
*/
wxGLAttributes& BufferSize(int val);
/**
Specifies the framebuffer level. It makes no effect for OS X.
@param val
0 for main buffer, >0 for overlay, <0 for underlay.
*/
wxGLAttributes& Level(int val);
/**
Requests using double buffering if present.
*/
wxGLAttributes& DoubleBuffer();
/**
Use stereoscopic display if present.
*/
wxGLAttributes& Stereo();
/**
Specifies the number of auxiliary buffers.
@param val
The number of auxiliary buffers.
*/
wxGLAttributes& AuxBuffers(int val);
/**
Specifies the minimal number of bits for colour buffers.
@param mRed
The minimal number of bits for colour red.
@param mGreen
The minimal number of bits for colour green.
@param mBlue
The minimal number of bits for colour blue.
@param mAlpha
The minimal number of bits for alpha channel.
*/
wxGLAttributes& MinRGBA(int mRed, int mGreen, int mBlue, int mAlpha);
/**
Specifies number of bits for Z-buffer.
@param val
Number of bits for Z-buffer (typically 0, 16 or 32).
*/
wxGLAttributes& Depth(int val);
/**
Specifies number of bits for stencil buffer.
@param val
Number of bits.
*/
wxGLAttributes& Stencil(int val);
/**
Specifies the minimal number of bits for the accumulation buffer.
@param mRed
The minimal number of bits for red accumulator.
@param mGreen
The minimal number of bits for green accumulator.
@param mBlue
The minimal number of bits for blue accumulator.
@param mAlpha
The minimal number of bits for alpha accumulator.
*/
wxGLAttributes& MinAcumRGBA(int mRed, int mGreen, int mBlue, int mAlpha);
/**
Use multi-sampling support (antialiasing).
@param val
Number of sample buffers, usually 1.
*/
wxGLAttributes& SampleBuffers(int val);
/**
Specifies the number of samplers per pixel.
@param val
Number of samplers, e.g. 4 for 2x2 antialiasing.
*/
wxGLAttributes& Samplers(int val);
/**
Used to request a frame buffer sRGB capable. It makes no effect for OS X.
*/
wxGLAttributes& FrameBuffersRGB();
/**
Set some typically needed attributes. E.g. full-acceleration on MSW.
@see Defaults()
*/
wxGLAttributes& PlatformDefaults();
/**
wxWidgets defaults:
RGBA, Z-depth 16 bits, double buffering, 1 sample buffer, 4 samplers.
@see PlatformDefaults()
*/
wxGLAttributes& Defaults();
/**
The set of attributes must end with this one; otherwise, the GPU may
display nothing at all.
*/
void EndList();
};
/**
@class wxGLContextAttrs
This class is used for setting context attributes.
Since OpenGL version 3.0 the ARB adds attributes time to time to the rendering
context functionality. wxWidgets implements attributes up to OGL 4.5, but
you can set new attributes by using AddAttribute() and AddAttribBits()
functions inherited from the base wxGLAttribsBase class.
Attributes can be chained. For example:
@code
wxGLContextAttrs cxtAttrs;
cxtAttrs.CoreProfile().OGLVersion(4, 5).Robust().ResetIsolation().EndList();
@endcode
Notice that EndList() must be used as the last attribute. Not adding it will
likely result in nothing displayed at all.
@since 3.1.0
@library{wxgl}
@category{gl}
@see wxGLCanvas, wxGLContext, wxGLAttribsBase, wxGLAttributes
*/
class wxGLContextAttrs : public wxGLAttribsBase
{
public:
/**
Request an OpenGL core profile for the context.
If the requested OpenGL version is less than 3.2, this attribute is
ignored and the functionality of the context is determined solely by
the requested version.
*/
wxGLContextAttrs& CoreProfile();
/**
Request specific OpenGL core major version number (>= 3).
@param val
The major version number requested.
It has no effect under OS X where specifying CoreProfile() will
result in using OpenGL version at least 3.2.
*/
wxGLContextAttrs& MajorVersion(int val);
/**
Request specific OpenGL core minor version number.
@param val
The minor version number requested, e.g. 2 if OpenGL 3.2 is requested.
It has no effect under OS X where specifying CoreProfile() will
result in using OpenGL version at least 3.2.
*/
wxGLContextAttrs& MinorVersion(int val);
/**
An easy way of requesting an OpenGL version.
@param vmayor
The major version number requested, e.g. 4 if OpenGL 4.5 is requested.
@param vminor
The minor version number requested, e.g. 5 if OpenGL 4.5 is requested.
It has no effect under OS X where specifying CoreProfile() will
result in using OpenGL version at least 3.2.
*/
wxGLContextAttrs& OGLVersion(int vmayor, int vminor);
/**
Request a type of context with all OpenGL features from version 1.0 to
the newest available by the GPU driver. In this mode the GPU may be some
slower than it would be without this compatibility attribute.
*/
wxGLContextAttrs& CompatibilityProfile();
/**
Request a forward-compatible context.
Forward-compatible contexts are defined only for OpenGL versions 3.0 and
later. They must not support functionality marked as deprecated or
removed by the requested version of the OpenGL API.
It has no effect under OS X.
*/
wxGLContextAttrs& ForwardCompatible();
/**
Request an ES or ES2 ("Embedded Subsystem") context. These are special
subsets of OpenGL, lacking some features of the full specification.
Used mainly in embedded devices such as mobile phones.
It has no effect under OS X.
*/
wxGLContextAttrs& ES2();
/**
Request debugging functionality. This tells OpenGL to prepare a set where
some logs are enabled and also allows OGL to send debug messages through
a callback function.
It has no effect under OS X.
*/
wxGLContextAttrs& DebugCtx();
/**
Request robustness, or how OpenGL handles out-of-bounds buffer object
accesses and graphics reset notification behaviours.
It has no effect under OS X.
*/
wxGLContextAttrs& Robust();
/**
With robustness enabled, never deliver notification of reset events.
It has no effect under OS X.
*/
wxGLContextAttrs& NoResetNotify();
/**
With robustness enabled, if graphics reset happens, all context state is
lost.
It has no effect under OS X.
*/
wxGLContextAttrs& LoseOnReset();
/**
Request OpenGL to protect other applications or shared contexts from reset
side-effects.
It has no effect under OS X.
*/
wxGLContextAttrs& ResetIsolation();
/**
Request OpenGL to avoid or not flushing pending commands when the context
is made no longer current (released). If you don't specify this attribute,
the GPU driver default is 'flushing'.
@param val
0 for not flushing, 1 (wxWidgets default) for flushing pending commands.
It has no effect under OS X.
*/
wxGLContextAttrs& ReleaseFlush(int val = 1);
/**
Set platform specific defaults. Currently only Unix defaults are
implemented: use X11 direct rendering and use X11 RGBA type.
*/
wxGLContextAttrs& PlatformDefaults();
/**
The set of attributes must end with this one; otherwise, the GPU may
display nothing at all.
*/
void EndList();
};
/** /**
@class wxGLContext @class wxGLContext
@@ -12,33 +439,46 @@
machine and the connection between OpenGL and the system. machine and the connection between OpenGL and the system.
The OpenGL state includes everything that can be set with the OpenGL API: The OpenGL state includes everything that can be set with the OpenGL API:
colors, rendering variables, display lists, texture objects, etc. Although colors, rendering variables, buffer data ids, texture objects, etc. It is
it is possible to have multiple rendering contexts share display lists in possible to have multiple rendering contexts share buffer data and textures.
order to save resources, this method is hardly used today any more, because This feature is specially useful when the application use multiple threads
display lists are only a tiny fraction of the overall state. for updating data into the memory of the graphics card.
Therefore, one rendering context is usually used with or bound to multiple Whether one only rendering context is used with or bound to multiple output
output windows in turn, so that the application has access to the complete windows or if each window has its own bound context is a developer decision.
and identical state while rendering into each window. It is important to take into account that GPU makers may set different pointers
to the same OGL function for different contexts. The way these pointers are
retrieved from the OGL driver should be used again for each new context.
Binding (making current) a rendering context with another instance of a Binding (making current) a rendering context with another instance of a
wxGLCanvas however works only if the other wxGLCanvas was created with the wxGLCanvas however works only if the both wxGLCanvas instances were created
same attributes as the wxGLCanvas from which the wxGLContext was with the same attributes.
initialized. (This applies to sharing display lists among contexts
analogously.)
Note that some wxGLContext features are extremely platform-specific - its OpenGL version 3 introduced a new type of specification profile, the modern
best to check your native platform's glcanvas header (on windows core profile. The old compatibility profile maintains all legacy features.
include/wx/msw/glcanvas.h) to see what features your native platform Since wxWidgets 3.1.0 you can choose the type of context and even ask for a
provides. specified OGL version number. However, its advised to use only core profile
as the compatibility profile may run a bit slower.
OpenGL core profile specification defines several flags at context creation
that determine not only the type of context but also some features. Some of
these flags can be set in the list of attributes used at wxGLCanvas ctor.
But since wxWidgets 3.1.0 it is strongly encouraged to use the new mechanism:
setting the context attributes with a wxGLContextAttrs object and the canvas
attributes with a wxGLAttributes object.
The best way of knowing if your OpenGL environment supports a specific type
of context is creating a wxGLContext instance and checking wxGLContext::IsOK().
If it returns false, then simply delete that instance and create a new one
with other attributes.
wxHAS_OPENGL_ES is defined on platforms that only have this implementation wxHAS_OPENGL_ES is defined on platforms that only have this implementation
available (eg the iPhone) und don't support the full specification. available (e.g. the iPhone) and don't support the full specification.
@library{wxgl} @library{wxgl}
@category{gl} @category{gl}
@see wxGLCanvas @see wxGLCanvas, wxGLContextAttrs, wxGLAttributes
*/ */
class wxGLContext : public wxObject class wxGLContext : public wxObject
{ {
@@ -54,10 +494,31 @@ public:
other wxGLCanvas that has been created with equivalent attributes other wxGLCanvas that has been created with equivalent attributes
as win. as win.
@param other @param other
Context to share display lists with or @NULL (the default) for no Context to share some data with or @NULL (the default) for no
sharing. sharing.
@param ctxAttrs
A wxGLContextAttrs pointer to the attributes used for defining the
flags when OGL >= 3.2 is requested. This is the preferred method
since wxWidgets 3.1.0. The previous method (still available for
backwards compatibility) is to define the attributes at wxGLCanvas
ctor. If this parameter is @NULL (the default) then that previous
method is taken.
If no attributes are defined at all, then those provided by the GPU
driver defaults will be used.
*/ */
wxGLContext(wxGLCanvas* win, const wxGLContext* other = NULL); wxGLContext(wxGLCanvas* win,
const wxGLContext* other = NULL,
const wxGLContextAttrs* ctxAttrs = NULL);
/**
Checks if the underlying OpenGL rendering context was correctly created
by the system with the requested attributes. If this function returns
@false then the wxGLContext object is useless and should be deleted and
recreated with different attributes.
@since 3.1.0
*/
bool IsOK();
/** /**
Makes the OpenGL state that is represented by this rendering context Makes the OpenGL state that is represented by this rendering context
@@ -75,12 +536,15 @@ public:
/** /**
@anchor wxGL_FLAGS @anchor wxGL_FLAGS
Constants for use with wxGLCanvas. Constants for use with wxGLCanvas. Most of the constants must be followed
by a value. This is indicated by "(F)".
Instead of these flags, the use of wxGLAttributes and wxGLContextAttrs is
preferred since wxWidgets 3.1.0.
@note Not all implementations support options such as stereo, auxiliary @note Not all implementations support options such as stereo, auxiliary
buffers, alpha channel, and accumulator buffer, use buffers, alpha channel, and accumulator buffer, use
wxGLCanvas::IsDisplaySupported() to check for individual attributes wxGLCanvas::IsDisplaySupported() to check for individual visual
support. attributes support.
*/ */
enum enum
{ {
@@ -88,72 +552,66 @@ enum
/// do not use a palette. /// do not use a palette.
WX_GL_RGBA = 1, WX_GL_RGBA = 1,
/// Specifies the number of bits for buffer if not WX_GL_RGBA. /// (F) Specifies the number of bits for buffer if not WX_GL_RGBA.
WX_GL_BUFFER_SIZE, WX_GL_BUFFER_SIZE,
/// Must be followed by 0 for main buffer, >0 for overlay, <0 for underlay. /// (F) 0 for main buffer, >0 for overlay, <0 for underlay.
WX_GL_LEVEL, WX_GL_LEVEL,
/// Use double buffering if present (on if no attributes specified). /// Use double buffering if present ("on" if no attributes specified).
WX_GL_DOUBLEBUFFER, WX_GL_DOUBLEBUFFER,
/// Use stereoscopic display. /// Use stereoscopic display.
WX_GL_STEREO, WX_GL_STEREO,
/// Specifies number of auxiliary buffers. /// (F) The number of auxiliary buffers.
WX_GL_AUX_BUFFERS, WX_GL_AUX_BUFFERS,
/// Use red buffer with most bits (> MIN_RED bits) /// (F) Use red buffer with most bits (> MIN_RED bits)
WX_GL_MIN_RED, WX_GL_MIN_RED,
/// Use green buffer with most bits (> MIN_GREEN bits) /// (F) Use green buffer with most bits (> MIN_GREEN bits)
WX_GL_MIN_GREEN, WX_GL_MIN_GREEN,
/// Use blue buffer with most bits (> MIN_BLUE bits) /// (F) Use blue buffer with most bits (> MIN_BLUE bits)
WX_GL_MIN_BLUE, WX_GL_MIN_BLUE,
/// Use alpha buffer with most bits (> MIN_ALPHA bits) /// (F) Use alpha buffer with most bits (> MIN_ALPHA bits)
WX_GL_MIN_ALPHA, WX_GL_MIN_ALPHA,
/// Specifies number of bits for Z-buffer (typically 0, 16 or 32). /// (F) Specifies number of bits for Z-buffer (typically 0, 16 or 32).
WX_GL_DEPTH_SIZE, WX_GL_DEPTH_SIZE,
/// Specifies number of bits for stencil buffer. /// (F) Specifies number of bits for stencil buffer.
WX_GL_STENCIL_SIZE, WX_GL_STENCIL_SIZE,
/// Specifies minimal number of red accumulator bits. /// (F) Specifies minimal number of red accumulator bits.
WX_GL_MIN_ACCUM_RED, WX_GL_MIN_ACCUM_RED,
/// Specifies minimal number of green accumulator bits. /// (F) Specifies minimal number of green accumulator bits.
WX_GL_MIN_ACCUM_GREEN, WX_GL_MIN_ACCUM_GREEN,
/// Specifies minimal number of blue accumulator bits. /// (F) Specifies minimal number of blue accumulator bits.
WX_GL_MIN_ACCUM_BLUE, WX_GL_MIN_ACCUM_BLUE,
/// Specifies minimal number of alpha accumulator bits. /// (F) Specifies minimal number of alpha accumulator bits.
WX_GL_MIN_ACCUM_ALPHA, WX_GL_MIN_ACCUM_ALPHA,
/// 1 for multisampling support (antialiasing) /// (F) 1 for multi-sampling support (antialiasing)
WX_GL_SAMPLE_BUFFERS, WX_GL_SAMPLE_BUFFERS,
/// 4 for 2x2 antialiasing supersampling on most graphics cards /// (F) 4 for 2x2 antialiasing supersampling on most graphics cards
WX_GL_SAMPLES, WX_GL_SAMPLES,
/** /**
Request an OpenGL core profile. Used to request a frame buffer sRGB capable
Notice that using this attribute will result in also requesting OpenGL @since 3.1.0
at least version 3.0.
See ::WX_GL_MAJOR_VERSION and ::WX_GL_MINOR_VERSION for more precise
version selection.
@since 3.0.3
*/ */
WX_GL_CORE_PROFILE, WX_GL_FRAMEBUFFER_SRGB,
/** /**
Request specific OpenGL core major version number (>= 3). (F) Request specific OpenGL core major version number (>= 3).
This attribute should be followed by the major version number This attribute should be followed by the major version number
requested. requested.
@@ -167,15 +625,107 @@ enum
WX_GL_MAJOR_VERSION, WX_GL_MAJOR_VERSION,
/** /**
Request specific OpenGL core minor version number. (F) Request specific OpenGL core minor version number.
This attribute has the same semantics as ::WX_GL_MAJOR_VERSION but is This attribute has the same semantics as ::WX_GL_MAJOR_VERSION but is
for the minor OpenGL version, e.g. 2 if OpenGL 3.2 is requested. for the minor OpenGL version, e.g. 2 if OpenGL 3.2 is requested.
@since 3.0.3 @since 3.0.3
*/ */
WX_GL_MINOR_VERSION WX_GL_MINOR_VERSION,
/**
Request an OpenGL core profile for the context.
If the requested OpenGL version is less than 3.2, this attribute is
ignored and the functionality of the context is determined solely by
the requested version.
@since 3.0.3
*/
WX_GL_CORE_PROFILE,
/**
Request a type of context with all OpenGL features from version 1.0 to
the newest available by the GPU driver. In this mode the GPU may be some
slower than it would be without this compatibility attribute.
@since 3.1.0
*/
wx_GL_COMPAT_PROFILE,
/**
Request a forward-compatible context.
Forward-compatible contexts are defined only for OpenGL versions 3.0 and
later. They must not support functionality marked as deprecated by that
version of the OpenGL API.
@since 3.1.0
*/
WX_GL_FORWARD_COMPAT,
/**
Request an ES or ES2 ("Embedded Subsystem") context. These are special
subsets of OpenGL, lacking some features of the full specification.
Used mainly in embedded devices such as mobile phones.
@since 3.1.0
*/
WX_GL_ES2,
/**
Request debugging functionality. This tells OpenGL to prepare a set where
some logs are enabled and also allows OGL to send debug messages through
a callback function.
@since 3.1.0
*/
WX_GL_DEBUG,
/**
Request robustness, or how OpenGL handles out-of-bounds buffer object
accesses and graphics reset notification behaviours.
@since 3.1.0
*/
WX_GL_ROBUST_ACCESS,
/**
With robustness enabled, never deliver notification of reset events.
@since 3.1.0
*/
WX_GL_NO_RESET_NOTIFY,
/**
With robustness enabled, if graphics reset happens, all context state is
lost.
@since 3.1.0
*/
WX_GL_LOSE_ON_RESET,
/**
Request OpenGL to protect other apps or shared contexts from reset
side-effects.
@since 3.1.0
*/
WX_GL_RESET_ISOLATION,
/**
Request OpenGL to flush pending commands when the context is released.
@since 3.1.0
*/
WX_GL_RELEASE_FLUSH,
/**
Request OpenGL to avoid flushing pending commands when the context is released.
@since 3.1.0
*/
WX_GL_RELEASE_NONE
}; };
/** /**
@@ -200,9 +750,10 @@ enum
please update your code to create the rendering contexts explicitly. please update your code to create the rendering contexts explicitly.
To set up the attributes for the canvas (number of bits for the depth To set up the attributes for the canvas (number of bits for the depth
buffer, number of bits for the stencil buffer and so on) you should set up buffer, number of bits for the stencil buffer and so on) you pass them
the correct values of the @e attribList parameter. The values that should in the constructor using a wxGLAttributes instance. You can still use
be set up and their meanings will be described below. the way before 3.1.0 (setting up the correct values of the @e attribList
parameter) but it's discouraged.
@note @note
On those platforms which use a configure script (e.g. Linux and Mac OS) On those platforms which use a configure script (e.g. Linux and Mac OS)
@@ -211,12 +762,13 @@ enum
To switch it on under the other platforms (e.g. Windows), you need to edit To switch it on under the other platforms (e.g. Windows), you need to edit
the @c setup.h file and set @c wxUSE_GLCANVAS to @c 1 and then also pass the @c setup.h file and set @c wxUSE_GLCANVAS to @c 1 and then also pass
@c USE_OPENGL=1 to the make utility. You may also need to add @c opengl32.lib @c USE_OPENGL=1 to the make utility. You may also need to add @c opengl32.lib
and @c glu32.lib to the list of the libraries your program is linked with. (and @c glu32.lib for old OpenGL versions) to the list of the libraries
your program is linked with.
@library{wxgl} @library{wxgl}
@category{gl} @category{gl}
@see wxGLContext @see wxGLContext, wxGLAttributes, wxGLContextAttrs
*/ */
class wxGLCanvas : public wxWindow class wxGLCanvas : public wxWindow
{ {
@@ -225,10 +777,11 @@ public:
Creates a window with the given parameters. Notice that you need to Creates a window with the given parameters. Notice that you need to
create and use a wxGLContext to output to this window. create and use a wxGLContext to output to this window.
If @a attribList is not specified, double buffered RGBA mode is used.
@param parent @param parent
Pointer to a parent window. Pointer to a parent window.
@param dispAttrs
The wxGLAttributes used for setting display attributes (not for
rendering context attributes).
@param id @param id
Window identifier. If -1, will automatically create an identifier. Window identifier. If -1, will automatically create an identifier.
@param pos @param pos
@@ -244,6 +797,27 @@ public:
Window style. Window style.
@param name @param name
Window name. Window name.
@param palette
Palette for indexed colour (i.e. non WX_GL_RGBA) mode. Ignored
under most platforms.
@since 3.1.0
*/
wxGLCanvas(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxGLCanvasName,
const wxPalette& palette = wxNullPalette);
/**
This constructor is still available only for compatibility reasons.
Please use the constructor with wxGLAttributes instead.
If @a attribList is not specified, wxGLAttributes::Defaults() is used.
@param attribList @param attribList
Array of integers. With this parameter you can set the device Array of integers. With this parameter you can set the device
context attributes associated to this window. This array is context attributes associated to this window. This array is
@@ -262,9 +836,6 @@ public:
WX_GL_DOUBLEBUFFER are used. But notice that if you do specify some WX_GL_DOUBLEBUFFER are used. But notice that if you do specify some
attributes you also need to explicitly include these two default attributes you also need to explicitly include these two default
attributes in the list if you need them. attributes in the list if you need them.
@param palette
Palette for indexed colour (i.e. non WX_GL_RGBA) mode. Ignored
under most platforms.
*/ */
wxGLCanvas(wxWindow* parent, wxWindowID id = wxID_ANY, wxGLCanvas(wxWindow* parent, wxWindowID id = wxID_ANY,
const int* attribList = NULL, const int* attribList = NULL,
@@ -276,6 +847,21 @@ public:
/** /**
Determines if a canvas having the specified attributes is available. Determines if a canvas having the specified attributes is available.
This only applies for visual attributes, not rendering context attributes.
@param dispAttrs
The requested attributes.
@return @true if attributes are supported.
@since 3.1.0
*/
static bool IsDisplaySupported(const wxGLAttributes& dispAttrs);
/**
Determines if a canvas having the specified attributes is available.
This only applies for visual attributes, not rendering context attributes.
Please, use the new form of this method, using wxGLAttributes.
@param attribList @param attribList
See @a attribList for wxGLCanvas(). See @a attribList for wxGLCanvas().

View File

@@ -40,6 +40,34 @@ wxIMPLEMENT_CLASS(wxGLApp, wxApp);
// implementation // implementation
// ============================================================================ // ============================================================================
void wxGLAttribsBase::AddAttribBits(int searchVal, int combineVal)
{
// Search for searchVal
wxVector<int>::iterator it = m_GLValues.begin();
while ( it != m_GLValues.end() && *it != searchVal )
it++;
// Have we searchVal?
if ( it != m_GLValues.end() )
{
if ( ++it == m_GLValues.end() )
{
m_GLValues.push_back(combineVal);
}
else
{
*it |= combineVal;
}
}
else
{
// Add the identifier and the bits
m_GLValues.push_back(searchVal);
m_GLValues.push_back(combineVal);
}
}
// ============================================================================
wxGLCanvasBase::wxGLCanvasBase() wxGLCanvasBase::wxGLCanvasBase()
{ {
#if WXWIN_COMPATIBILITY_2_8 #if WXWIN_COMPATIBILITY_2_8
@@ -147,6 +175,207 @@ bool wxGLCanvasBase::IsExtensionInList(const char *list, const char *extension)
return false; return false;
} }
/* static */
bool wxGLCanvasBase::ParseAttribList(const int *attribList,
wxGLAttributes& dispAttrs,
wxGLContextAttrs* ctxAttrs)
{
// Some attributes are usually needed
dispAttrs.PlatformDefaults();
if ( ctxAttrs )
ctxAttrs->PlatformDefaults();
if ( !attribList )
{
// Set default attributes
dispAttrs.Defaults();
dispAttrs.EndList();
if ( ctxAttrs )
ctxAttrs->EndList();
return true;
}
int src = 0;
int minColo[4] = {0, 0, 0, 0};
int minAcum[4] = {0, 0, 0, 0};
int num = 0;
while ( attribList[src] )
{
// Check a non zero-terminated list. This may help a bit with malformed lists.
if ( ++num > 200 )
{
wxFAIL_MSG("The attributes list is not zero-terminated");
}
switch ( attribList[src++] )
{
// Pixel format attributes
case WX_GL_RGBA:
dispAttrs.RGBA();
break;
case WX_GL_BUFFER_SIZE:
dispAttrs.BufferSize(attribList[src++]);
break;
case WX_GL_LEVEL:
dispAttrs.Level(attribList[src++]);
break;
case WX_GL_DOUBLEBUFFER:
dispAttrs.DoubleBuffer();
break;
case WX_GL_STEREO:
dispAttrs.Stereo();
break;
case WX_GL_AUX_BUFFERS:
dispAttrs.AuxBuffers(attribList[src++]);
break;
case WX_GL_MIN_RED:
minColo[0] = attribList[src++];
break;
case WX_GL_MIN_GREEN:
minColo[1] = attribList[src++];
break;
case WX_GL_MIN_BLUE:
minColo[2] = attribList[src++];
break;
case WX_GL_MIN_ALPHA:
minColo[3] = attribList[src++];
break;
case WX_GL_DEPTH_SIZE:
dispAttrs.Depth(attribList[src++]);
break;
case WX_GL_STENCIL_SIZE:
dispAttrs.Stencil(attribList[src++]);
break;
case WX_GL_MIN_ACCUM_RED:
minAcum[0] = attribList[src++];
break;
case WX_GL_MIN_ACCUM_GREEN:
minAcum[1] = attribList[src++];
break;
case WX_GL_MIN_ACCUM_BLUE:
minAcum[2] = attribList[src++];
break;
case WX_GL_MIN_ACCUM_ALPHA:
minAcum[3] = attribList[src++];
break;
case WX_GL_SAMPLE_BUFFERS:
dispAttrs.SampleBuffers(attribList[src++]);
break;
case WX_GL_SAMPLES:
dispAttrs.Samplers(attribList[src++]);
break;
case WX_GL_FRAMEBUFFER_SRGB:
dispAttrs.FrameBuffersRGB();
break;
// Context attributes
case WX_GL_CORE_PROFILE:
if ( ctxAttrs )
ctxAttrs->CoreProfile();
break;
case WX_GL_MAJOR_VERSION:
if ( ctxAttrs )
ctxAttrs->MajorVersion(attribList[src]);
src++;
break;
case WX_GL_MINOR_VERSION:
if ( ctxAttrs )
ctxAttrs->MinorVersion(attribList[src]);
src++;
break;
case wx_GL_COMPAT_PROFILE:
if ( ctxAttrs )
ctxAttrs->CompatibilityProfile();
break;
case WX_GL_FORWARD_COMPAT:
if ( ctxAttrs )
ctxAttrs->ForwardCompatible();
break;
case WX_GL_ES2:
if ( ctxAttrs )
ctxAttrs->ES2();
break;
case WX_GL_DEBUG:
if ( ctxAttrs )
ctxAttrs->DebugCtx();
break;
case WX_GL_ROBUST_ACCESS:
if ( ctxAttrs )
ctxAttrs->Robust();
break;
case WX_GL_NO_RESET_NOTIFY:
if ( ctxAttrs )
ctxAttrs->NoResetNotify();
break;
case WX_GL_LOSE_ON_RESET:
if ( ctxAttrs )
ctxAttrs->LoseOnReset();
break;
case WX_GL_RESET_ISOLATION:
if ( ctxAttrs )
ctxAttrs->ResetIsolation();
break;
case WX_GL_RELEASE_FLUSH:
if ( ctxAttrs )
ctxAttrs->ReleaseFlush(1);
break;
case WX_GL_RELEASE_NONE:
if ( ctxAttrs )
ctxAttrs->ReleaseFlush(0);
break;
default:
wxFAIL_MSG("Unexpected value in attributes list");
return false;
}
}
// Set color and accumulation
if ( minColo[0] || minColo[1] || minColo[2] || minColo[3] )
dispAttrs.MinRGBA(minColo[0], minColo[1], minColo[2], minColo[3]);
if ( minAcum[0] || minAcum[1] || minAcum[2] || minAcum[3] )
dispAttrs.MinAcumRGBA(minAcum[0], minAcum[1], minAcum[2], minAcum[3]);
// The attributes lists must be zero-terminated
dispAttrs.EndList();
if ( ctxAttrs )
ctxAttrs->EndList();
return true;
}
// ============================================================================ // ============================================================================
// compatibility layer for OpenGL 3 and OpenGL ES // compatibility layer for OpenGL 3 and OpenGL ES
// ============================================================================ // ============================================================================

View File

@@ -142,6 +142,21 @@ parent_set_hook(GSignalInvocationHint*, guint, const GValue* param_values, void*
wxIMPLEMENT_CLASS(wxGLCanvas, wxWindow); wxIMPLEMENT_CLASS(wxGLCanvas, wxWindow);
wxGLCanvas::wxGLCanvas(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
long style,
const wxString& name,
const wxPalette& palette)
#if WXWIN_COMPATIBILITY_2_8
: m_createImplicitContext(false)
#endif
{
Create(parent, dispAttrs, id, pos, size, style, name, palette);
}
wxGLCanvas::wxGLCanvas(wxWindow *parent, wxGLCanvas::wxGLCanvas(wxWindow *parent,
wxWindowID id, wxWindowID id,
const int *attribList, const int *attribList,
@@ -216,6 +231,24 @@ bool wxGLCanvas::Create(wxWindow *parent,
const wxString& name, const wxString& name,
const int *attribList, const int *attribList,
const wxPalette& palette) const wxPalette& palette)
{
// Separate 'GLXFBConfig/XVisual' attributes.
// Also store context attributes for wxGLContext ctor
wxGLAttributes dispAttrs;
if ( ! ParseAttribList(attribList, dispAttrs, &m_GLCTXAttrs) )
return false;
return Create(parent, dispAttrs, id, pos, size, style, name, palette);
}
bool wxGLCanvas::Create(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
long style,
const wxString& name,
const wxPalette& palette)
{ {
#if wxUSE_PALETTE #if wxUSE_PALETTE
wxASSERT_MSG( !palette.IsOk(), wxT("palettes not supported") ); wxASSERT_MSG( !palette.IsOk(), wxT("palettes not supported") );
@@ -230,7 +263,7 @@ bool wxGLCanvas::Create(wxWindow *parent,
m_backgroundStyle = wxBG_STYLE_PAINT; m_backgroundStyle = wxBG_STYLE_PAINT;
#endif #endif
if ( !InitVisual(attribList) ) if ( !InitVisual(dispAttrs) )
return false; return false;
// watch for the "parent-set" signal on m_wxwindow so we can set colormap // watch for the "parent-set" signal on m_wxwindow so we can set colormap

View File

@@ -135,6 +135,21 @@ gtk_glcanvas_size_callback( GtkWidget *WXUNUSED(widget), GtkAllocation* alloc, w
wxIMPLEMENT_CLASS(wxGLCanvas, wxWindow); wxIMPLEMENT_CLASS(wxGLCanvas, wxWindow);
wxGLCanvas::wxGLCanvas(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
long style,
const wxString& name,
const wxPalette& palette)
#if WXWIN_COMPATIBILITY_2_8
: m_createImplicitContext(false)
#endif
{
Create(parent, dispAttrs, id, pos, size, style, name, palette);
}
wxGLCanvas::wxGLCanvas(wxWindow *parent, wxGLCanvas::wxGLCanvas(wxWindow *parent,
wxWindowID id, wxWindowID id,
const int *attribList, const int *attribList,
@@ -206,10 +221,29 @@ bool wxGLCanvas::Create(wxWindow *parent,
const int *attribList, const int *attribList,
const wxPalette& palette) const wxPalette& palette)
{ {
// Separate 'GLXFBConfig/XVisual' attributes.
// Also store context attributes for wxGLContext ctor
wxGLAttributes dispAttrs;
if ( ! ParseAttribList(attribList, dispAttrs, &m_GLCTXAttrs) )
return false;
return Create(parent, dispAttrs, id, pos, size, style, name, palette);
}
bool wxGLCanvas::Create(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
long style,
const wxString& name,
const wxPalette& palette)
{
m_noExpose = true; m_noExpose = true;
m_nativeSizeEvent = true; m_nativeSizeEvent = true;
if ( !InitVisual(attribList) ) if ( !InitVisual(dispAttrs) )
return false; return false;
GdkVisual *visual = gdkx_visual_get( GetXVisualInfo()->visualid ); GdkVisual *visual = gdkx_visual_get( GetXVisualInfo()->visualid );

File diff suppressed because it is too large Load Diff

View File

@@ -37,10 +37,6 @@
WXGLContext WXGLCreateContext( WXGLPixelFormat pixelFormat, WXGLContext shareContext ) WXGLContext WXGLCreateContext( WXGLPixelFormat pixelFormat, WXGLContext shareContext )
{ {
WXGLContext context = [[NSOpenGLContext alloc] initWithFormat:pixelFormat shareContext: shareContext]; WXGLContext context = [[NSOpenGLContext alloc] initWithFormat:pixelFormat shareContext: shareContext];
if ( !context )
{
wxFAIL_MSG("NSOpenGLContext creation failed");
}
return context ; return context ;
} }
@@ -77,177 +73,38 @@ void WXGLDestroyPixelFormat( WXGLPixelFormat pixelFormat )
} }
} }
// Form a list of attributes by joining canvas attributes and context attributes.
WXGLPixelFormat WXGLChoosePixelFormat(const int *attribList) // OS X uses just one list to find a suitable pixel format.
WXGLPixelFormat WXGLChoosePixelFormat(const int *GLAttrs,
int n1,
const int *ctxAttrs,
int n2)
{ {
NSOpenGLPixelFormatAttribute data[512]; NSOpenGLPixelFormatAttribute data[128];
unsigned p = 0;
data[p++] = NSOpenGLPFAMinimumPolicy; // make _SIZE tags behave more like GLX
// Test if we support hardware acceleration, we always want to use it if it
// is available and, apparently, in spite of the Apple docs explicitly
// saying the contrary:
//
// If present, this attribute indicates that only hardware-accelerated
// renderers are considered. If not present, accelerated renderers are
// still preferred.
//
// hardware acceleration is not always used without it, so we do need to
// specify it. But we shouldn't do it if acceleration is really not
// available.
const NSOpenGLPixelFormatAttribute
attrsAccel[] = { NSOpenGLPFAAccelerated, 0 };
if ( WXGLPixelFormat testFormat = [[NSOpenGLPixelFormat alloc]
initWithAttributes: attrsAccel] )
{
// Hardware acceleration is available, use it.
data[p++] = NSOpenGLPFAAccelerated;
[testFormat release];
}
const NSOpenGLPixelFormatAttribute *attribs; const NSOpenGLPixelFormatAttribute *attribs;
if ( !attribList ) unsigned p = 0;
// The list should have at least one value and the '0' at end. So the
// minimum size is 2.
if ( GLAttrs && n1 > 1 )
{ {
// Default attributes n1--; // skip the ending '0'
data[p++] = NSOpenGLPFADoubleBuffer; while ( p < n1 )
data[p++] = NSOpenGLPFAColorSize; data[p++] = (NSOpenGLPixelFormatAttribute) GLAttrs[p];
data[p++] = (NSOpenGLPixelFormatAttribute)8;
data[p++] = NSOpenGLPFAAlphaSize;
data[p++] = (NSOpenGLPixelFormatAttribute)0;
data[p++] = NSOpenGLPFADepthSize;
data[p++] = (NSOpenGLPixelFormatAttribute)8;
data[p] = 0;
attribs = data;
}
else
{
for ( unsigned arg = 0; attribList[arg] !=0 && p < WXSIZEOF(data); )
{
switch ( attribList[arg++] )
{
case WX_GL_RGBA:
//data[p++] = AGL_RGBA;
break;
case WX_GL_BUFFER_SIZE:
//data[p++] = AGL_BUFFER_SIZE;
//data[p++] = attribList[arg++];
break;
case WX_GL_LEVEL:
//data[p++]=AGL_LEVEL;
//data[p++]=attribList[arg++];
break;
case WX_GL_DOUBLEBUFFER:
data[p++] = NSOpenGLPFADoubleBuffer;
break;
case WX_GL_STEREO:
data[p++] = NSOpenGLPFAStereo;
break;
case WX_GL_AUX_BUFFERS:
data[p++] = NSOpenGLPFAAuxBuffers;
data[p++] = (NSOpenGLPixelFormatAttribute) attribList[arg++];
break;
case WX_GL_MIN_RED:
data[p++] = NSOpenGLPFAColorSize;
data[p++] = (NSOpenGLPixelFormatAttribute) attribList[arg++];
break;
case WX_GL_MIN_GREEN:
//data[p++] = AGL_GREEN_SIZE;
//data[p++] = attribList[arg++];
break;
case WX_GL_MIN_BLUE:
//data[p++] = AGL_BLUE_SIZE;
//data[p++] = attribList[arg++];
break;
case WX_GL_MIN_ALPHA:
data[p++] = NSOpenGLPFAAlphaSize;
data[p++] = (NSOpenGLPixelFormatAttribute) attribList[arg++];
break;
case WX_GL_DEPTH_SIZE:
data[p++] = NSOpenGLPFADepthSize;
data[p++] = (NSOpenGLPixelFormatAttribute) attribList[arg++];
break;
case WX_GL_STENCIL_SIZE:
data[p++] = NSOpenGLPFAStencilSize;
data[p++] = (NSOpenGLPixelFormatAttribute) attribList[arg++];
break;
case WX_GL_MIN_ACCUM_RED:
data[p++] = NSOpenGLPFAAccumSize;
data[p++] = (NSOpenGLPixelFormatAttribute) attribList[arg++];
break;
case WX_GL_MIN_ACCUM_GREEN:
//data[p++] = AGL_ACCUM_GREEN_SIZE;
//data[p++] = attribList[arg++];
break;
case WX_GL_MIN_ACCUM_BLUE:
//data[p++] = AGL_ACCUM_BLUE_SIZE;
//data[p++] = attribList[arg++];
break;
case WX_GL_MIN_ACCUM_ALPHA:
//data[p++] = AGL_ACCUM_ALPHA_SIZE;
//data[p++] = attribList[arg++];
break;
case WX_GL_SAMPLE_BUFFERS:
if ( !wxGLCanvas::IsAGLMultiSampleAvailable() )
{
if ( !attribList[arg++] )
break;
return nil;
} }
data[p++] = NSOpenGLPFASampleBuffers; if ( ctxAttrs && n2 > 1 )
if ( (data[p++] = (NSOpenGLPixelFormatAttribute) attribList[arg++]) == true )
{ {
// don't use software fallback n2--; // skip the ending '0'
data[p++] = NSOpenGLPFANoRecovery; unsigned p2 = 0;
} while ( p2 < n2 )
break; data[p++] = (NSOpenGLPixelFormatAttribute) ctxAttrs[p2++];
case WX_GL_SAMPLES:
if ( !wxGLCanvas::IsAGLMultiSampleAvailable() )
{
if ( !attribList[arg++] )
break;
return nil;
} }
data[p++] = NSOpenGLPFASamples; // End the list
data[p++] = (NSOpenGLPixelFormatAttribute) attribList[arg++]; data[p] = (NSOpenGLPixelFormatAttribute) 0;
break;
case WX_GL_CORE_PROFILE:
data[p++] = NSOpenGLPFAOpenGLProfile;
// request an OpenGL core profile
// will use the highest available OpenGL version
// which will be at least 3.2
data[p++] = NSOpenGLProfileVersion3_2Core;
break;
}
}
data[p] = 0;
attribs = data; attribs = data;
}
return [[NSOpenGLPixelFormat alloc] initWithAttributes:(NSOpenGLPixelFormatAttribute*) attribs]; return [[NSOpenGLPixelFormat alloc] initWithAttributes:(NSOpenGLPixelFormatAttribute*) attribs];
} }
@@ -278,34 +135,6 @@ WXGLPixelFormat WXGLChoosePixelFormat(const int *attribList)
@end @end
bool wxGLCanvas::Create(wxWindow *parent,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
long style,
const wxString& name,
const int *attribList,
const wxPalette& WXUNUSED(palette))
{
m_glFormat = WXGLChoosePixelFormat(attribList);
if ( !m_glFormat )
return false;
// DontCreatePeer();
if ( !wxWindow::Create(parent, id, pos, size, style, name) )
return false;
/*
NSRect r = wxOSXGetFrameForControl( this, pos , size ) ;
wxNSCustomOpenGLView* v = [[wxNSCustomOpenGLView alloc] initWithFrame:r];
m_peer = new wxWidgetCocoaImpl( this, v );
MacPostControlCreate(pos, size) ;
*/
return true;
}
wxGLCanvas::~wxGLCanvas() wxGLCanvas::~wxGLCanvas()
{ {
if ( m_glFormat ) if ( m_glFormat )

View File

@@ -34,14 +34,367 @@
#include "wx/osx/private.h" #include "wx/osx/private.h"
// These 'WX' values are the same as 'NS' ones
// Source: https://developer.apple.com/library/mac/documentation/
// Cocoa/Reference/ApplicationKit/Classes/NSOpenGLPixelFormat_Class/index.html
#define WXOpenGLPFAAllRenderers 1
#define WXOpenGLPFATripleBuffer 3
#define WXOpenGLPFADoubleBuffer 5
#define WXOpenGLPFAStereo 6
#define WXOpenGLPFAAuxBuffers 7
#define WXOpenGLPFAColorSize 8
#define WXOpenGLPFAAlphaSize 11
#define WXOpenGLPFADepthSize 12
#define WXOpenGLPFAStencilSize 13
#define WXOpenGLPFAAccumSize 14
#define WXOpenGLPFAMinimumPolicy 51
#define WXOpenGLPFAMaximumPolicy 52
#define WXOpenGLPFAOffScreen 53
#define WXOpenGLPFAFullScreen 54
#define WXOpenGLPFASampleBuffers 55
#define WXOpenGLPFASamples 56
#define WXOpenGLPFAAuxDepthStencil 57
#define WXOpenGLPFAColorFloat 58
#define WXOpenGLPFAMultisample 59
#define WXOpenGLPFASupersample 60
#define WXOpenGLPFASampleAlpha 61
#define WXOpenGLPFARendererID 70
#define WXOpenGLPFASingleRenderer 71
#define WXOpenGLPFANoRecovery 72
#define WXOpenGLPFAAccelerated 73
#define WXOpenGLPFAClosestPolicy 74
#define WXOpenGLPFARobust 75
#define WXOpenGLPFABackingStore 76
#define WXOpenGLPFAMPSafe 78
#define WXOpenGLPFAWindow 80
#define WXOpenGLPFAMultiScreen 81
#define WXOpenGLPFACompliant 83
#define WXOpenGLPFAScreenMask 84
#define WXOpenGLPFAPixelBuffer 90
#define WXOpenGLPFARemotePixelBuffer 91
#define WXOpenGLPFAAllowOfflineRenderers 96
#define WXOpenGLPFAAcceleratedCompute 97
#define WXOpenGLPFAOpenGLProfile 99
#define WXOpenGLPFAVirtualScreenCount 128
#define WXOpenGLProfileVersionLegacy 0x1000
#define WXOpenGLProfileVersion3_2Core 0x3200
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
// wxGLCanvas // wxGLContextAttrs: OpenGL rendering context attributes
// ----------------------------------------------------------------------------
// OSX specific values
wxGLContextAttrs& wxGLContextAttrs::CoreProfile()
{
AddAttribute(WXOpenGLPFAOpenGLProfile);
AddAttribute(WXOpenGLProfileVersion3_2Core);
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::MajorVersion(int val)
{
// No effect
wxUnusedVar(val);
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::MinorVersion(int val)
{
// No effect
wxUnusedVar(val);
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::CompatibilityProfile()
{
AddAttribute(WXOpenGLPFAOpenGLProfile);
AddAttribute(WXOpenGLProfileVersionLegacy);
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::ForwardCompatible()
{
// No effect
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::ES2()
{
// No effect
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::DebugCtx()
{
// No effect
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::Robust()
{
// No effect. Somehow similar flag (NSOpenGLPFARobust) is deprecated in OS X v10.5
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::NoResetNotify()
{
// No effect
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::LoseOnReset()
{
// No effect
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::ResetIsolation()
{
// No effect
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::ReleaseFlush(int val)
{
// No effect
wxUnusedVar(val);
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::PlatformDefaults()
{
// No OSX specific defaults
return *this;
}
void wxGLContextAttrs::EndList()
{
AddAttribute(0);
}
// ----------------------------------------------------------------------------
// wxGLAttributes: pixel format attributes
// ----------------------------------------------------------------------------
// OSX specific values
wxGLAttributes& wxGLAttributes::RGBA()
{
AddAttribute(WXOpenGLPFAColorSize);
AddAttribute(24);
AddAttribute(WXOpenGLPFAAlphaSize);
AddAttribute(8);
return *this;
}
wxGLAttributes& wxGLAttributes::BufferSize(int val)
{
// No effect
wxUnusedVar(val);
return *this;
}
wxGLAttributes& wxGLAttributes::Level(int val)
{
// No effect
wxUnusedVar(val);
return *this;
}
wxGLAttributes& wxGLAttributes::DoubleBuffer()
{
AddAttribute(WXOpenGLPFADoubleBuffer);
return *this;
}
wxGLAttributes& wxGLAttributes::Stereo()
{
AddAttribute(WXOpenGLPFAStereo);
return *this;
}
wxGLAttributes& wxGLAttributes::AuxBuffers(int val)
{
if ( val >= 0 )
{
AddAttribute(WXOpenGLPFAAuxBuffers);
AddAttribute(val);
}
return *this;
}
wxGLAttributes& wxGLAttributes::MinRGBA(int mRed, int mGreen, int mBlue, int mAlpha)
{
int minColorBits = 0;
if ( mRed > minColorBits )
minColorBits = mRed;
if ( mGreen > minColorBits )
minColorBits = mGreen;
if ( mBlue > minColorBits )
minColorBits = mBlue;
if ( minColorBits > 0 )
{
AddAttribute(WXOpenGLPFAColorSize);
AddAttribute(minColorBits);
}
if ( mAlpha >= 0 )
{
AddAttribute(WXOpenGLPFAAlphaSize);
AddAttribute(mAlpha);
}
return *this;
}
wxGLAttributes& wxGLAttributes::Depth(int val)
{
if ( val >= 0 )
{
AddAttribute(WXOpenGLPFADepthSize);
AddAttribute(val);
}
return *this;
}
wxGLAttributes& wxGLAttributes::Stencil(int val)
{
if ( val >= 0 )
{
AddAttribute(WXOpenGLPFAStencilSize);
AddAttribute(val);
}
return *this;
}
wxGLAttributes& wxGLAttributes::MinAcumRGBA(int mRed, int mGreen, int mBlue, int mAlpha)
{
int minAcumBits = 0;
if ( mRed > minAcumBits )
minAcumBits = mRed;
if ( mGreen > minAcumBits )
minAcumBits = mGreen;
if ( mBlue > minAcumBits )
minAcumBits = mBlue;
if ( minAcumBits > 0 )
{
AddAttribute(WXOpenGLPFAAccumSize);
AddAttribute(minAcumBits);
}
// No effect for Alpha in accumulation buffer
wxUnusedVar(mAlpha);
return *this;
}
wxGLAttributes& wxGLAttributes::SampleBuffers(int val)
{
if ( val >= 0 )
{
AddAttribute(WXOpenGLPFASampleBuffers);
AddAttribute(val);
// Don't use software fallback
AddAttribute(WXOpenGLPFANoRecovery);
}
return *this;
}
wxGLAttributes& wxGLAttributes::Samplers(int val)
{
if ( val >= 0 )
{
AddAttribute(WXOpenGLPFASamples);
AddAttribute(val);
}
return *this;
}
wxGLAttributes& wxGLAttributes::FrameBuffersRGB()
{
// No effect
return *this;
}
void wxGLAttributes::EndList()
{
AddAttribute(0);
}
wxGLAttributes& wxGLAttributes::PlatformDefaults()
{
AddAttribute(WXOpenGLPFAMinimumPolicy); // use _SIZE tags as minimum sizes
// Test if we support hardware acceleration, we always want to use it if it
// is available and, apparently, in spite of the Apple docs explicitly
// saying the contrary:
//
// If present, this attribute indicates that only hardware-accelerated
// renderers are considered. If not present, accelerated renderers are
// still preferred.
//
// hardware acceleration is not always used without it, so we do need to
// specify it. But we shouldn't do it if acceleration is really not
// available.
const int attrsAccel[] = { WXOpenGLPFAAccelerated, 0 };
WXGLPixelFormat testFormat = WXGLChoosePixelFormat(attrsAccel, 2);
if ( testFormat )
{
// Hardware acceleration is available, use it.
AddAttribute(WXOpenGLPFAAccelerated);
WXGLDestroyPixelFormat(testFormat);
}
return *this;
}
wxGLAttributes& wxGLAttributes::Defaults()
{
RGBA().Depth(16).DoubleBuffer().SampleBuffers(1).Samplers(4);
return *this;
}
// ----------------------------------------------------------------------------
// wxGLContext
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
wxGLContext::wxGLContext(wxGLCanvas *win, const wxGLContext *other) wxGLContext::wxGLContext(wxGLCanvas *win,
const wxGLContext *other,
const wxGLContextAttrs *ctxAttrs)
{ {
m_glContext = WXGLCreateContext(win->GetWXGLPixelFormat(), const int* contextAttribs = NULL;
other ? other->m_glContext : NULL); int ctxSize = 0;
if ( ctxAttrs )
{
contextAttribs = ctxAttrs->GetGLAttrs();
ctxSize = ctxAttrs->GetSize();
}
else if ( win->GetGLCTXAttrs().GetGLAttrs() )
{
// If OpenGL context parameters were set at wxGLCanvas ctor, get them now
contextAttribs = win->GetGLCTXAttrs().GetGLAttrs();
ctxSize = win->GetGLCTXAttrs().GetSize();
}
// else use GPU driver defaults
// Join canvas attributes and context attributes to ask for a pixel format
WXGLPixelFormat pf = WXGLChoosePixelFormat(win->GetGLDispAttrs().GetGLAttrs(),
win->GetGLDispAttrs().GetSize(),
contextAttribs, ctxSize);
m_isOk = false;
if ( pf )
{
m_glContext = WXGLCreateContext(pf, other ? other->m_glContext : NULL);
if ( m_glContext )
{
m_isOk = true;
}
WXGLDestroyPixelFormat(pf);
}
if ( !m_isOk )
wxLogMessage(_("Couldn't create OpenGL context"));
} }
wxGLContext::~wxGLContext() wxGLContext::~wxGLContext()
@@ -61,6 +414,18 @@ wxIMPLEMENT_CLASS(wxGLCanvas, wxWindow);
wxBEGIN_EVENT_TABLE(wxGLCanvas, wxWindow) wxBEGIN_EVENT_TABLE(wxGLCanvas, wxWindow)
wxEND_EVENT_TABLE() wxEND_EVENT_TABLE()
wxGLCanvas::wxGLCanvas(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
long style,
const wxString& name,
const wxPalette& palette)
{
Create(parent, dispAttrs, id, pos, size, style, name, palette);
}
wxGLCanvas::wxGLCanvas(wxWindow *parent, wxGLCanvas::wxGLCanvas(wxWindow *parent,
wxWindowID id, wxWindowID id,
const int *attribList, const int *attribList,
@@ -73,6 +438,58 @@ wxGLCanvas::wxGLCanvas(wxWindow *parent,
Create(parent, id, pos, size, style, name, attribList, palette); Create(parent, id, pos, size, style, name, attribList, palette);
} }
bool wxGLCanvas::Create(wxWindow *parent,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
long style,
const wxString& name,
const int *attribList,
const wxPalette& palette)
{
// Separate 'pixel format' attributes.
// Also store context attributes for wxGLContext ctor
// If 'attribList' is NULL, ParseAttribList() will set defaults.
wxGLAttributes dispAttrs;
if ( ! ParseAttribList(attribList, dispAttrs, &m_GLCTXAttrs) )
return false;
return Create(parent, dispAttrs, id, pos, size, style, name, palette);
}
bool wxGLCanvas::Create(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
long style,
const wxString& name,
const wxPalette& WXUNUSED(palette))
{
m_glFormat = NULL;
// Don't allow an empty list
if ( !dispAttrs.GetGLAttrs() )
{
wxFAIL_MSG("wxGLAttributes object is empty.");
return false;
}
// Return false if any attribute is unsupported
if ( ! IsDisplaySupported(dispAttrs) )
{
wxFAIL_MSG("Can't find a pixel format for the requested attributes");
return false;
}
// Make a copy of attributes. Will use at wxGLContext ctor
m_GLAttrs = dispAttrs;
if ( !wxWindow::Create(parent, id, pos, size, style, name) )
return false;
return true;
}
#if WXWIN_COMPATIBILITY_2_8 #if WXWIN_COMPATIBILITY_2_8
wxGLCanvas::wxGLCanvas(wxWindow *parent, wxGLCanvas::wxGLCanvas(wxWindow *parent,
@@ -128,23 +545,36 @@ bool wxGLCanvas::IsAGLMultiSampleAvailable()
return s_isMultiSampleAvailable != 0; return s_isMultiSampleAvailable != 0;
} }
/* static */
bool wxGLCanvasBase::IsDisplaySupported(const wxGLAttributes& dispAttrs)
{
WXGLPixelFormat testFormat = WXGLChoosePixelFormat(dispAttrs.GetGLAttrs(), dispAttrs.GetSize());
if ( testFormat )
{
WXGLDestroyPixelFormat(testFormat);
}
else
{
return false;
}
return true;
}
/* static */ /* static */
bool wxGLCanvasBase::IsDisplaySupported(const int *attribList) bool wxGLCanvasBase::IsDisplaySupported(const int *attribList)
{ {
WXGLPixelFormat glFormat = WXGLChoosePixelFormat(attribList); wxGLAttributes dispAttrs;
ParseAttribList(attribList, dispAttrs);
if ( !glFormat ) return IsDisplaySupported(dispAttrs);
return false;
WXGLDestroyPixelFormat(glFormat);
return true;
} }
bool wxGLCanvasBase::IsExtensionSupported(const char *extension) bool wxGLCanvasBase::IsExtensionSupported(const char *extension)
{ {
// we need a valid context to query for extensions. // We need a valid context to query for extensions. Use a default one.
WXGLPixelFormat fmt = WXGLChoosePixelFormat(NULL); wxGLAttributes dispAttrs;
ParseAttribList(NULL, dispAttrs); // Sets defaults
WXGLPixelFormat fmt = WXGLChoosePixelFormat(dispAttrs.GetGLAttrs(), dispAttrs.GetSize());
WXGLContext ctx = WXGLCreateContext(fmt, NULL); WXGLContext ctx = WXGLCreateContext(fmt, NULL);
if ( !ctx ) if ( !ctx )
return false; return false;

View File

@@ -64,6 +64,16 @@
#define GLX_DIRECT_COLOR_EXT 0x8003 #define GLX_DIRECT_COLOR_EXT 0x8003
#endif #endif
#ifndef GLX_ARB_framebuffer_sRGB
#define GLX_ARB_framebuffer_sRGB
#define GLX_FRAMEBUFFER_SRGB_CAPABLE_ARB 0x20B2
#endif
/* Typedef for the GL 3.0 context creation function */
typedef GLXContext(*PFNGLXCREATECONTEXTATTRIBSARBPROC)
(Display * dpy, GLXFBConfig config, GLXContext share_context,
Bool direct, const int *attrib_list);
#ifndef GLX_ARB_create_context #ifndef GLX_ARB_create_context
#define GLX_ARB_create_context #define GLX_ARB_create_context
#define GLX_CONTEXT_MAJOR_VERSION_ARB 0x2091 #define GLX_CONTEXT_MAJOR_VERSION_ARB 0x2091
@@ -71,11 +81,6 @@
#define GLX_CONTEXT_FLAGS_ARB 0x2094 #define GLX_CONTEXT_FLAGS_ARB 0x2094
#define GLX_CONTEXT_DEBUG_BIT_ARB 0x0001 #define GLX_CONTEXT_DEBUG_BIT_ARB 0x0001
#define GLX_CONTEXT_FORWARD_COMPATIBLE_BIT_ARB 0x0002 #define GLX_CONTEXT_FORWARD_COMPATIBLE_BIT_ARB 0x0002
/* Typedef for the GL 3.0 context creation function */
typedef GLXContext(*PFNGLXCREATECONTEXTATTRIBSARBPROC)
(Display * dpy, GLXFBConfig config, GLXContext share_context,
Bool direct, const int *attrib_list);
#endif #endif
#ifndef GLX_ARB_create_context_profile #ifndef GLX_ARB_create_context_profile
@@ -93,79 +98,450 @@ typedef GLXContext(*PFNGLXCREATECONTEXTATTRIBSARBPROC)
#define GLX_LOSE_CONTEXT_ON_RESET_ARB 0x8252 #define GLX_LOSE_CONTEXT_ON_RESET_ARB 0x8252
#endif #endif
#ifndef GLX_EXT_create_context_es2_profile #ifndef GLX_ARB_robustness_application_isolation
#define GLX_EXT_create_context_es2_profile #define GLX_ARB_robustness_application_isolation
#ifndef GLX_CONTEXT_ES2_PROFILE_BIT_EXT #define GLX_CONTEXT_RESET_ISOLATION_BIT_ARB 0x00000008
#define GLX_CONTEXT_ES2_PROFILE_BIT_EXT 0x00000002
#endif #endif
#ifndef GLX_ARB_robustness_share_group_isolation
#define GLX_ARB_robustness_share_group_isolation
#endif #endif
#ifndef GLX_ARB_framebuffer_sRGB #ifndef GLX_ARB_context_flush_control
#define GLX_ARB_framebuffer_sRGB #define GLX_ARB_context_flush_control
#ifndef GLX_FRAMEBUFFER_SRGB_CAPABLE_ARB #define GLX_CONTEXT_RELEASE_BEHAVIOR_ARB 0x2097
#define GLX_FRAMEBUFFER_SRGB_CAPABLE_ARB 0x20B2 #define GLX_CONTEXT_RELEASE_BEHAVIOR_NONE_ARB 0
#define GLX_CONTEXT_RELEASE_BEHAVIOR_FLUSH_ARB 0x2098
#endif #endif
#ifndef GLX_EXT_create_context_es2_profile
#define GLX_EXT_create_context_es2_profile
#define GLX_CONTEXT_ES2_PROFILE_BIT_EXT 0x00000004
#endif #endif
#ifndef GLX_EXT_create_context_es_profile
#define GLX_EXT_create_context_es_profile
#define GLX_CONTEXT_ES2_PROFILE_BIT_EXT 0x00000004
#endif
// ----------------------------------------------------------------------------
// wxGLContextAttrs: OpenGL rendering context attributes
// ----------------------------------------------------------------------------
// GLX specific values
wxGLContextAttrs& wxGLContextAttrs::CoreProfile()
{
AddAttribBits(GLX_CONTEXT_PROFILE_MASK_ARB,
GLX_CONTEXT_CORE_PROFILE_BIT_ARB);
SetNeedsARB();
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::MajorVersion(int val)
{
if ( val > 0 )
{
AddAttribute(GLX_CONTEXT_MAJOR_VERSION_ARB);
AddAttribute(val);
if ( val >= 3 )
SetNeedsARB();
}
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::MinorVersion(int val)
{
if ( val >= 0 )
{
AddAttribute(GLX_CONTEXT_MINOR_VERSION_ARB);
AddAttribute(val);
}
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::CompatibilityProfile()
{
AddAttribBits(GLX_CONTEXT_PROFILE_MASK_ARB,
GLX_CONTEXT_COMPATIBILITY_PROFILE_BIT_ARB);
SetNeedsARB();
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::ForwardCompatible()
{
AddAttribBits(GLX_CONTEXT_FLAGS_ARB,
GLX_CONTEXT_FORWARD_COMPATIBLE_BIT_ARB);
SetNeedsARB();
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::ES2()
{
AddAttribBits(GLX_CONTEXT_PROFILE_MASK_ARB,
GLX_CONTEXT_ES2_PROFILE_BIT_EXT);
SetNeedsARB();
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::DebugCtx()
{
AddAttribBits(GLX_CONTEXT_FLAGS_ARB,
GLX_CONTEXT_DEBUG_BIT_ARB);
SetNeedsARB();
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::Robust()
{
AddAttribBits(GLX_CONTEXT_FLAGS_ARB,
GLX_CONTEXT_ROBUST_ACCESS_BIT_ARB);
SetNeedsARB();
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::NoResetNotify()
{
AddAttribute(GLX_CONTEXT_RESET_NOTIFICATION_STRATEGY_ARB);
AddAttribute(GLX_NO_RESET_NOTIFICATION_ARB);
SetNeedsARB();
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::LoseOnReset()
{
AddAttribute(GLX_CONTEXT_RESET_NOTIFICATION_STRATEGY_ARB);
AddAttribute(GLX_LOSE_CONTEXT_ON_RESET_ARB);
SetNeedsARB();
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::ResetIsolation()
{
AddAttribBits(GLX_CONTEXT_FLAGS_ARB,
GLX_CONTEXT_RESET_ISOLATION_BIT_ARB);
SetNeedsARB();
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::ReleaseFlush(int val)
{
AddAttribute(GLX_CONTEXT_RELEASE_BEHAVIOR_ARB);
if ( val == 1 )
AddAttribute(GLX_CONTEXT_RELEASE_BEHAVIOR_FLUSH_ARB);
else
AddAttribute(GLX_CONTEXT_RELEASE_BEHAVIOR_NONE_ARB);
SetNeedsARB();
return *this;
}
wxGLContextAttrs& wxGLContextAttrs::PlatformDefaults()
{
renderTypeRGBA = true;
x11Direct = true;
return *this;
}
void wxGLContextAttrs::EndList()
{
AddAttribute(None);
}
// ----------------------------------------------------------------------------
// wxGLAttributes: Visual/FBconfig attributes
// ----------------------------------------------------------------------------
// GLX specific values
// Different versions of GLX API use rather different attributes lists, see
// the following URLs:
//
// - <= 1.2: http://www.opengl.org/sdk/docs/man/xhtml/glXChooseVisual.xml
// - >= 1.3: http://www.opengl.org/sdk/docs/man/xhtml/glXChooseFBConfig.xml
//
// Notice in particular that
// - GLX_RGBA is boolean attribute in the old version of the API but a
// value of GLX_RENDER_TYPE in the new one
// - Boolean attributes such as GLX_DOUBLEBUFFER don't take values in the
// old version but must be followed by True or False in the new one.
wxGLAttributes& wxGLAttributes::RGBA()
{
if ( wxGLCanvasX11::GetGLXVersion() >= 13 )
AddAttribBits(GLX_RENDER_TYPE, GLX_RGBA_BIT);
else
AddAttribute(GLX_RGBA);
return *this;
}
wxGLAttributes& wxGLAttributes::BufferSize(int val)
{
if ( val >= 0 )
{
AddAttribute(GLX_BUFFER_SIZE);
AddAttribute(val);
}
return *this;
}
wxGLAttributes& wxGLAttributes::Level(int val)
{
AddAttribute(GLX_LEVEL);
AddAttribute(val);
return *this;
}
wxGLAttributes& wxGLAttributes::DoubleBuffer()
{
AddAttribute(GLX_DOUBLEBUFFER);
if ( wxGLCanvasX11::GetGLXVersion() >= 13 )
AddAttribute(True);
return *this;
}
wxGLAttributes& wxGLAttributes::Stereo()
{
AddAttribute(GLX_STEREO);
if ( wxGLCanvasX11::GetGLXVersion() >= 13 )
AddAttribute(True);
return *this;
}
wxGLAttributes& wxGLAttributes::AuxBuffers(int val)
{
if ( val >= 0 )
{
AddAttribute(GLX_AUX_BUFFERS);
AddAttribute(val);
}
return *this;
}
wxGLAttributes& wxGLAttributes::MinRGBA(int mRed, int mGreen, int mBlue, int mAlpha)
{
if ( mRed >= 0)
{
AddAttribute(GLX_RED_SIZE);
AddAttribute(mRed);
}
if ( mGreen >= 0)
{
AddAttribute(GLX_GREEN_SIZE);
AddAttribute(mGreen);
}
if ( mBlue >= 0)
{
AddAttribute(GLX_BLUE_SIZE);
AddAttribute(mBlue);
}
if ( mAlpha >= 0)
{
AddAttribute(GLX_ALPHA_SIZE);
AddAttribute(mAlpha);
}
return *this;
}
wxGLAttributes& wxGLAttributes::Depth(int val)
{
if ( val >= 0 )
{
AddAttribute(GLX_DEPTH_SIZE);
AddAttribute(val);
}
return *this;
}
wxGLAttributes& wxGLAttributes::Stencil(int val)
{
if ( val >= 0 )
{
AddAttribute(GLX_STENCIL_SIZE);
AddAttribute(val);
}
return *this;
}
wxGLAttributes& wxGLAttributes::MinAcumRGBA(int mRed, int mGreen, int mBlue, int mAlpha)
{
if ( mRed >= 0)
{
AddAttribute(GLX_ACCUM_RED_SIZE);
AddAttribute(mRed);
}
if ( mGreen >= 0)
{
AddAttribute(GLX_ACCUM_GREEN_SIZE);
AddAttribute(mGreen);
}
if ( mBlue >= 0)
{
AddAttribute(GLX_ACCUM_BLUE_SIZE);
AddAttribute(mBlue);
}
if ( mAlpha >= 0)
{
AddAttribute(GLX_ACCUM_ALPHA_SIZE);
AddAttribute(mAlpha);
}
return *this;
}
wxGLAttributes& wxGLAttributes::SampleBuffers(int val)
{
#ifdef GLX_SAMPLE_BUFFERS_ARB
if ( val >= 0 && wxGLCanvasX11::IsGLXMultiSampleAvailable() )
{
AddAttribute(GLX_SAMPLE_BUFFERS_ARB);
AddAttribute(val);
}
#endif
return *this;
}
wxGLAttributes& wxGLAttributes::Samplers(int val)
{
#ifdef GLX_SAMPLES_ARB
if ( val >= 0 && wxGLCanvasX11::IsGLXMultiSampleAvailable() )
{
AddAttribute(GLX_SAMPLES_ARB);
AddAttribute(val);
}
#endif
return *this;
}
wxGLAttributes& wxGLAttributes::FrameBuffersRGB()
{
AddAttribute(GLX_FRAMEBUFFER_SRGB_CAPABLE_ARB);
AddAttribute(True);
return *this;
}
void wxGLAttributes::EndList()
{
AddAttribute(None);
}
wxGLAttributes& wxGLAttributes::PlatformDefaults()
{
// No GLX specific values
return *this;
}
wxGLAttributes& wxGLAttributes::Defaults()
{
RGBA().DoubleBuffer();
if ( wxGLCanvasX11::GetGLXVersion() < 13 )
Depth(1).MinRGBA(1, 1, 1, 0);
else
Depth(16).SampleBuffers(1).Samplers(4);
return *this;
}
// ============================================================================ // ============================================================================
// wxGLContext implementation // wxGLContext implementation
// ============================================================================ // ============================================================================
// Need this X error handler for the case context creation fails
static bool g_ctxErrorOccurred = false;
static int CTXErrorHandler( Display* WXUNUSED(dpy), XErrorEvent* WXUNUSED(ev) )
{
g_ctxErrorOccurred = true;
return 0;
}
wxIMPLEMENT_CLASS(wxGLContext, wxObject); wxIMPLEMENT_CLASS(wxGLContext, wxObject);
wxGLContext::wxGLContext(wxGLCanvas *gc, const wxGLContext *other) wxGLContext::wxGLContext(wxGLCanvas *win,
const wxGLContext *other,
const wxGLContextAttrs *ctxAttrs)
{ {
if ( gc->GetGLXContextAttribs()[0] != 0 ) // OpenGL 3 context creation const int* contextAttribs = NULL;
Bool x11Direct = True;
int renderType = GLX_RGBA_TYPE;
bool needsARB = false;
if ( ctxAttrs )
{ {
XVisualInfo *vi = gc->GetXVisualInfo(); contextAttribs = ctxAttrs->GetGLAttrs();
wxCHECK_RET( vi, wxT("invalid visual for OpenGL") ); x11Direct = ctxAttrs->x11Direct;
renderType = ctxAttrs->renderTypeRGBA ? GLX_RGBA_TYPE : GLX_COLOR_INDEX_TYPE;
needsARB = ctxAttrs->NeedsARB();
}
else if ( win->GetGLCTXAttrs().GetGLAttrs() )
{
// If OpenGL context parameters were set at wxGLCanvas ctor, get them now
contextAttribs = win->GetGLCTXAttrs().GetGLAttrs();
x11Direct = win->GetGLCTXAttrs().x11Direct;
renderType = win->GetGLCTXAttrs().renderTypeRGBA ? GLX_RGBA_TYPE : GLX_COLOR_INDEX_TYPE;
needsARB = win->GetGLCTXAttrs().NeedsARB();
}
// else use GPU driver defaults and x11Direct renderType ones
m_isOk = false;
Display* dpy = wxGetX11Display();
XVisualInfo *vi = win->GetXVisualInfo();
wxCHECK_RET( vi, "invalid visual for OpenGL" );
// We need to create a temporary context to get the // We need to create a temporary context to get the
// glXCreateContextAttribsARB function // glXCreateContextAttribsARB function
GLXContext tempContext = glXCreateContext( wxGetX11Display(), vi, GLXContext tempContext = glXCreateContext(dpy, vi, NULL,
NULL, win->GetGLCTXAttrs().x11Direct );
GL_TRUE ); wxCHECK_RET(tempContext, "glXCreateContext failed" );
wxCHECK_RET( tempContext, wxT("Couldn't create OpenGL context") );
PFNGLXCREATECONTEXTATTRIBSARBPROC glXCreateContextAttribsARB PFNGLXCREATECONTEXTATTRIBSARBPROC glXCreateContextAttribsARB
= (PFNGLXCREATECONTEXTATTRIBSARBPROC) = (PFNGLXCREATECONTEXTATTRIBSARBPROC)
glXGetProcAddress((GLubyte *)"glXCreateContextAttribsARB"); glXGetProcAddress((GLubyte *)"glXCreateContextAttribsARB");
if ( !glXCreateContextAttribsARB )
glXDestroyContext( dpy, tempContext );
// The preferred way is using glXCreateContextAttribsARB, even for old context
if ( !glXCreateContextAttribsARB && needsARB ) // OpenGL 3 context creation
{ {
wxLogError(_("Core OpenGL profile is not supported by the OpenGL driver.")); wxLogMessage(_("OpenGL 3.0 or later is not supported by the OpenGL driver."));
return; return;
} }
GLXFBConfig *fbc = gc->GetGLXFBConfig(); // Install a X error handler, so as to the app doesn't exit (without
wxCHECK_RET( fbc, wxT("invalid GLXFBConfig for OpenGL") ); // even a warning) if GL >= 3.0 context creation fails
g_ctxErrorOccurred = false;
int (*oldHandler)(Display*, XErrorEvent*) = XSetErrorHandler(&CTXErrorHandler);
m_glContext = glXCreateContextAttribsARB( wxGetX11Display(), fbc[0], if ( glXCreateContextAttribsARB )
{
GLXFBConfig *fbc = win->GetGLXFBConfig();
wxCHECK_RET( fbc, "Invalid GLXFBConfig for OpenGL" );
m_glContext = glXCreateContextAttribsARB( dpy, fbc[0],
other ? other->m_glContext : None, other ? other->m_glContext : None,
GL_TRUE, gc->GetGLXContextAttribs() ); x11Direct, contextAttribs );
glXDestroyContext( wxGetX11Display(), tempContext );
} }
else if ( wxGLCanvas::GetGLXVersion() >= 13 ) else if ( wxGLCanvas::GetGLXVersion() >= 13 )
{ {
GLXFBConfig *fbc = gc->GetGLXFBConfig(); GLXFBConfig *fbc = win->GetGLXFBConfig();
wxCHECK_RET( fbc, wxT("invalid GLXFBConfig for OpenGL") ); wxCHECK_RET( fbc, "Invalid GLXFBConfig for OpenGL" );
m_glContext = glXCreateNewContext( wxGetX11Display(), fbc[0], GLX_RGBA_TYPE, m_glContext = glXCreateNewContext( dpy, fbc[0], renderType,
other ? other->m_glContext : None, other ? other->m_glContext : None,
GL_TRUE ); x11Direct );
} }
else // GLX <= 1.2 else // GLX <= 1.2
{ {
XVisualInfo *vi = gc->GetXVisualInfo(); m_glContext = glXCreateContext( dpy, vi,
wxCHECK_RET( vi, wxT("invalid visual for OpenGL") );
m_glContext = glXCreateContext( wxGetX11Display(), vi,
other ? other->m_glContext : None, other ? other->m_glContext : None,
GL_TRUE ); x11Direct );
} }
wxASSERT_MSG( m_glContext, wxT("Couldn't create OpenGL context") ); // Sync to ensure any errors generated are processed.
XSync( dpy, False );
if ( g_ctxErrorOccurred || !m_glContext )
wxLogMessage(_("Couldn't create OpenGL context"));
else
m_isOk = true;
// Restore old error handler
XSetErrorHandler( oldHandler );
} }
wxGLContext::~wxGLContext() wxGLContext::~wxGLContext()
@@ -213,14 +589,16 @@ wxGLCanvasX11::wxGLCanvasX11()
{ {
m_fbc = NULL; m_fbc = NULL;
m_vi = NULL; m_vi = NULL;
m_glxContextAttribs[0] = 0;
} }
bool wxGLCanvasX11::InitVisual(const int *attribList) bool wxGLCanvasX11::InitVisual(const wxGLAttributes& dispAttrs)
{ {
InitGLXContextAttribs(attribList, m_glxContextAttribs); bool ret = InitXVisualInfo(dispAttrs, &m_fbc, &m_vi);
if ( !ret )
return InitXVisualInfo(attribList, &m_fbc, &m_vi); {
wxFAIL_MSG("Failed to get a XVisualInfo for the requested attributes.");
}
return ret;
} }
wxGLCanvasX11::~wxGLCanvasX11() wxGLCanvasX11::~wxGLCanvasX11()
@@ -258,276 +636,28 @@ bool wxGLCanvasX11::IsGLXMultiSampleAvailable()
/* static */ /* static */
void wxGLCanvasX11::InitGLXContextAttribs(const int *wxattrs, int *wxctxattrs) bool wxGLCanvasX11::InitXVisualInfo(const wxGLAttributes& dispAttrs,
{
wxctxattrs[0] = 0; // default is legacy context
if ( !wxattrs ) // default attribs
return;
bool useGLCoreProfile = false;
// the minimum gl core version would be 3.0
int glVersionMajor = 3,
glVersionMinor = 0;
for ( int arg = 0; wxattrs[arg] != 0; )
{
switch ( wxattrs[arg++] )
{
case WX_GL_CORE_PROFILE:
useGLCoreProfile = true;
break;
case WX_GL_MAJOR_VERSION:
glVersionMajor = wxattrs[arg++];
break;
case WX_GL_MINOR_VERSION:
glVersionMinor = wxattrs[arg++];
break;
default: break;
}
}
if ( useGLCoreProfile )
{
wxctxattrs[0] = GLX_CONTEXT_MAJOR_VERSION_ARB;
wxctxattrs[1] = glVersionMajor;
wxctxattrs[2] = GLX_CONTEXT_MINOR_VERSION_ARB;
wxctxattrs[3] = glVersionMinor;
wxctxattrs[4] = GLX_CONTEXT_FLAGS_ARB;
wxctxattrs[5] = GLX_CONTEXT_COMPATIBILITY_PROFILE_BIT_ARB;
wxctxattrs[6] = GLX_CONTEXT_PROFILE_MASK_ARB;
wxctxattrs[7] = GLX_CONTEXT_CORE_PROFILE_BIT_ARB;
wxctxattrs[8] = 0; // terminate
}
}
/* static */
bool
wxGLCanvasX11::ConvertWXAttrsToGL(const int *wxattrs, int *glattrs, size_t n)
{
wxCHECK_MSG( n >= 16, false, wxT("GL attributes buffer too small") );
/*
Different versions of GLX API use rather different attributes lists, see
the following URLs:
- <= 1.2: http://www.opengl.org/sdk/docs/man/xhtml/glXChooseVisual.xml
- >= 1.3: http://www.opengl.org/sdk/docs/man/xhtml/glXChooseFBConfig.xml
Notice in particular that
- GLX_RGBA is boolean attribute in the old version of the API but a
value of GLX_RENDER_TYPE in the new one
- Boolean attributes such as GLX_DOUBLEBUFFER don't take values in the
old version but must be followed by True or False in the new one.
*/
if ( !wxattrs )
{
size_t i = 0;
// use double-buffered true colour by default
glattrs[i++] = GLX_DOUBLEBUFFER;
if ( GetGLXVersion() < 13 )
{
// default settings if attriblist = 0
glattrs[i++] = GLX_RGBA;
glattrs[i++] = GLX_DEPTH_SIZE; glattrs[i++] = 1;
glattrs[i++] = GLX_RED_SIZE; glattrs[i++] = 1;
glattrs[i++] = GLX_GREEN_SIZE; glattrs[i++] = 1;
glattrs[i++] = GLX_BLUE_SIZE; glattrs[i++] = 1;
glattrs[i++] = GLX_ALPHA_SIZE; glattrs[i++] = 0;
}
else // recent GLX can choose the defaults on its own just fine
{
// we just need to have a value after GLX_DOUBLEBUFFER
glattrs[i++] = True;
}
glattrs[i] = None;
wxASSERT_MSG( i < n, wxT("GL attributes buffer too small") );
}
else // have non-default attributes
{
size_t p = 0;
for ( int arg = 0; wxattrs[arg] != 0; )
{
// check if we have any space left, knowing that we may insert 2
// more elements during this loop iteration and we always need to
// terminate the list with None (hence -3)
if ( p > n - 3 )
return false;
// indicates whether we have a boolean attribute
bool isBoolAttr = false;
switch ( wxattrs[arg++] )
{
case WX_GL_BUFFER_SIZE:
glattrs[p++] = GLX_BUFFER_SIZE;
break;
case WX_GL_LEVEL:
glattrs[p++] = GLX_LEVEL;
break;
case WX_GL_RGBA:
if ( GetGLXVersion() >= 13 )
{
// this is the default GLX_RENDER_TYPE anyhow
continue;
}
glattrs[p++] = GLX_RGBA;
isBoolAttr = true;
break;
case WX_GL_DOUBLEBUFFER:
glattrs[p++] = GLX_DOUBLEBUFFER;
isBoolAttr = true;
break;
case WX_GL_STEREO:
glattrs[p++] = GLX_STEREO;
isBoolAttr = true;
break;
case WX_GL_AUX_BUFFERS:
glattrs[p++] = GLX_AUX_BUFFERS;
break;
case WX_GL_MIN_RED:
glattrs[p++] = GLX_RED_SIZE;
break;
case WX_GL_MIN_GREEN:
glattrs[p++] = GLX_GREEN_SIZE;
break;
case WX_GL_MIN_BLUE:
glattrs[p++] = GLX_BLUE_SIZE;
break;
case WX_GL_MIN_ALPHA:
glattrs[p++] = GLX_ALPHA_SIZE;
break;
case WX_GL_DEPTH_SIZE:
glattrs[p++] = GLX_DEPTH_SIZE;
break;
case WX_GL_STENCIL_SIZE:
glattrs[p++] = GLX_STENCIL_SIZE;
break;
case WX_GL_MIN_ACCUM_RED:
glattrs[p++] = GLX_ACCUM_RED_SIZE;
break;
case WX_GL_MIN_ACCUM_GREEN:
glattrs[p++] = GLX_ACCUM_GREEN_SIZE;
break;
case WX_GL_MIN_ACCUM_BLUE:
glattrs[p++] = GLX_ACCUM_BLUE_SIZE;
break;
case WX_GL_MIN_ACCUM_ALPHA:
glattrs[p++] = GLX_ACCUM_ALPHA_SIZE;
break;
case WX_GL_SAMPLE_BUFFERS:
#ifdef GLX_SAMPLE_BUFFERS_ARB
if ( IsGLXMultiSampleAvailable() )
{
glattrs[p++] = GLX_SAMPLE_BUFFERS_ARB;
break;
}
#endif // GLX_SAMPLE_BUFFERS_ARB
// if it was specified just to disable it, no problem
if ( !wxattrs[arg++] )
continue;
// otherwise indicate that it's not supported
return false;
case WX_GL_SAMPLES:
#ifdef GLX_SAMPLES_ARB
if ( IsGLXMultiSampleAvailable() )
{
glattrs[p++] = GLX_SAMPLES_ARB;
break;
}
#endif // GLX_SAMPLES_ARB
if ( !wxattrs[arg++] )
continue;
return false;
// the following constants are context attribs
// ignore them
case WX_GL_CORE_PROFILE:
continue;
case WX_GL_MAJOR_VERSION:
arg++; // skip int
continue;
case WX_GL_MINOR_VERSION:
arg++; // skip int
continue;
default:
wxLogDebug(wxT("Unsupported OpenGL attribute %d"),
wxattrs[arg - 1]);
continue;
}
if ( isBoolAttr )
{
// as explained above, for pre 1.3 API the attribute just needs
// to be present so we only add its value when using the new API
if ( GetGLXVersion() >= 13 )
glattrs[p++] = True;
}
else // attribute with real (non-boolean) value
{
// copy attribute value as is
glattrs[p++] = wxattrs[arg++];
}
}
glattrs[p] = None;
}
return true;
}
/* static */
bool
wxGLCanvasX11::InitXVisualInfo(const int *attribList,
GLXFBConfig** pFBC, GLXFBConfig** pFBC,
XVisualInfo** pXVisual) XVisualInfo** pXVisual)
{ {
int data[512]; // GLX_XX attributes
if ( !ConvertWXAttrsToGL(attribList, data, WXSIZEOF(data)) ) const int* attrsListGLX = dispAttrs.GetGLAttrs();
if ( !attrsListGLX )
{
wxFAIL_MSG("wxGLAttributes object is empty.");
return false; return false;
}
Display * const dpy = wxGetX11Display(); Display* dpy = wxGetX11Display();
if ( GetGLXVersion() >= 13 ) if ( GetGLXVersion() >= 13 )
{ {
int returned; int returned;
*pFBC = glXChooseFBConfig(dpy, DefaultScreen(dpy), data, &returned); *pFBC = glXChooseFBConfig(dpy, DefaultScreen(dpy), attrsListGLX, &returned);
if ( *pFBC ) if ( *pFBC )
{ {
// Use the first good match
*pXVisual = glXGetVisualFromFBConfig(wxGetX11Display(), **pFBC); *pXVisual = glXGetVisualFromFBConfig(wxGetX11Display(), **pFBC);
if ( !*pXVisual ) if ( !*pXVisual )
{ {
@@ -539,21 +669,20 @@ wxGLCanvasX11::InitXVisualInfo(const int *attribList,
else // GLX <= 1.2 else // GLX <= 1.2
{ {
*pFBC = NULL; *pFBC = NULL;
*pXVisual = glXChooseVisual(dpy, DefaultScreen(dpy), data); *pXVisual = glXChooseVisual(dpy, DefaultScreen(dpy),
wx_const_cast(int*, attrsListGLX) );
} }
return *pXVisual != NULL; return *pXVisual != NULL;
} }
/* static */ /* static */
bool bool wxGLCanvasBase::IsDisplaySupported(const wxGLAttributes& dispAttrs)
wxGLCanvasBase::IsDisplaySupported(const int *attribList)
{ {
GLXFBConfig *fbc = NULL; GLXFBConfig *fbc = NULL;
XVisualInfo *vi = NULL; XVisualInfo *vi = NULL;
const bool bool isSupported = wxGLCanvasX11::InitXVisualInfo(dispAttrs, &fbc, &vi);
isSupported = wxGLCanvasX11::InitXVisualInfo(attribList, &fbc, &vi);
if ( fbc ) if ( fbc )
XFree(fbc); XFree(fbc);
@@ -563,6 +692,15 @@ wxGLCanvasBase::IsDisplaySupported(const int *attribList)
return isSupported; return isSupported;
} }
/* static */
bool wxGLCanvasBase::IsDisplaySupported(const int *attribList)
{
wxGLAttributes dispAttrs;
ParseAttribList(attribList, dispAttrs);
return IsDisplaySupported(dispAttrs);
}
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
// default visual management // default visual management
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
@@ -574,8 +712,10 @@ GLXFBConfig *wxGLCanvasX11::ms_glFBCInfo = NULL;
bool wxGLCanvasX11::InitDefaultVisualInfo(const int *attribList) bool wxGLCanvasX11::InitDefaultVisualInfo(const int *attribList)
{ {
FreeDefaultVisualInfo(); FreeDefaultVisualInfo();
wxGLAttributes dispAttrs;
ParseAttribList(attribList, dispAttrs);
return InitXVisualInfo(attribList, &ms_glFBCInfo, &ms_glVisualInfo); return InitXVisualInfo(dispAttrs, &ms_glFBCInfo, &ms_glVisualInfo);
} }
/* static */ /* static */

View File

@@ -41,6 +41,18 @@
wxIMPLEMENT_CLASS(wxGLCanvas, wxWindow); wxIMPLEMENT_CLASS(wxGLCanvas, wxWindow);
wxGLCanvas::wxGLCanvas(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
long style,
const wxString& name,
const wxPalette& palette)
{
Create(parent, dispAttrs, id, pos, size, style, name, palette);
}
wxGLCanvas::wxGLCanvas(wxWindow *parent, wxGLCanvas::wxGLCanvas(wxWindow *parent,
wxWindowID id, wxWindowID id,
const int *attribList, const int *attribList,
@@ -60,12 +72,30 @@ bool wxGLCanvas::Create(wxWindow *parent,
long style, long style,
const wxString& name, const wxString& name,
const int *attribList, const int *attribList,
const wxPalette& palette)
{
// Separate 'GLXFBConfig/XVisual' attributes.
// Also store context attributes for wxGLContext ctor
wxGLAttributes dispAttrs;
if ( ! ParseAttribList(attribList, dispAttrs, &m_GLCTXAttrs) )
return false;
return Create(parent, dispAttrs, id, pos, size, style, name, palette);
}
bool wxGLCanvas::Create(wxWindow *parent,
const wxGLAttributes& dispAttrs,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
long style,
const wxString& name,
const wxPalette& WXUNUSED(palette)) const wxPalette& WXUNUSED(palette))
{ {
if ( !wxWindow::Create(parent, id, pos, size, style, name) ) if ( !wxWindow::Create(parent, id, pos, size, style, name) )
return false; return false;
if ( !InitVisual(attribList) ) if ( !InitVisual(dispAttrs) )
return false; return false;
return true; return true;