Phoenix Logo

phoenix_title wx.glcanvas.GLContext

An instance of a wx.glcanvas.GLContext represents the state of an OpenGL state machine and the connection between OpenGL and the system.

The OpenGL state includes everything that can be set with the OpenGL API: colors, rendering variables, display lists, texture objects, etc. Although it is possible to have multiple rendering contexts share display lists in order to save resources, this method is hardly used today any more, because display lists are only a tiny fraction of the overall state.

Therefore, one rendering context is usually used with or bound to multiple output windows in turn, so that the application has access to the complete and identical state while rendering into each window.

Binding (making current) a rendering context with another instance of a wx.glcanvas.GLCanvas however works only if the other wx.glcanvas.GLCanvas was created with the same attributes as the wx.glcanvas.GLCanvas from which the wx.glcanvas.GLContext was initialized. (This applies to sharing display lists among contexts analogously.)

Note that some wx.glcanvas.GLContext features are extremely platform-specific - its best to check your native platform’s glcanvas header (on windows include/wx/msw/glcanvas.h) to see what features your native platform provides.

HAS_OPENGL_ES is defined on platforms that only have this implementation available (eg the iPhone) und don’t support the full specification.


class_hierarchy Class Hierarchy

Inheritance diagram for class GLContext:


method_summary Methods Summary

__init__ Constructor.
SetCurrent Makes the OpenGL state that is represented by this rendering context current with the wx.glcanvas.GLCanvas win.

api Class API



class wx.glcanvas.GLContext(Object)

Possible constructors:

GLContext(win, other=None)

An instance of a GLContext represents the state of an OpenGL state machine and the connection between OpenGL and the system.


Methods



__init__(self, win, other=None)

Constructor.

Parameters:
  • win (wx.glcanvas.GLCanvas) – The canvas that is used to initialize this context. This parameter is needed only temporarily, and the caller may do anything with it (e.g. destroy the window) after the constructor returned.

    It will be possible to bind (make current) this context to any other wx.glcanvas.GLCanvas that has been created with equivalent attributes as win.

  • other (wx.glcanvas.GLContext) – Context to share display lists with or None (the default) for no sharing.


SetCurrent(self, win)

Makes the OpenGL state that is represented by this rendering context current with the wx.glcanvas.GLCanvas win.

Parameters:win (wx.glcanvas.GLCanvas) –
Return type:bool

Note

win can be a different wx.glcanvas.GLCanvas window than the one that was passed to the constructor of this rendering context. If RC is an object of type wx.glcanvas.GLContext, the statements “RC.SetCurrent(win);” and “win.SetCurrent(RC);” are equivalent, see wx.glcanvas.GLCanvas.SetCurrent .