*********************
wx.glcanvas.GLContext
*********************

Inheritance diagram for `wx.glcanvas.GLContext`:

|

.. inheritance-diagram:: wx.glcanvas.GLContext

|

Description
===========

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 <wx.glcanvas.GLCanvas.html>`_ 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:: Note that some `wx.glcanvas.GLContext` features are extremely platform-specific -- it's best to check your native platform's glcanvas 
   header (on Windows ``include/wx./msw/glcanvas.h``) to see what features your native platform provides.

.. seealso:: `wx.glcanvas.GLCanvas <wx.glcanvas.GLCanvas.html>`_


Derived From
^^^^^^^^^^^^^

* `wx.Object <../Widgets/wx.Object.html>`_ 


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `SetCurrent <#SetCurrent>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(win, other=None)

   Constructor.
   
   **Parameters:**

   * `win` (`wx.glcanvas.GLCanvas <wx.glcanvas.GLCanvas.html>`_): 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 <wx.glcanvas.GLContext.html>`_): Context to share display lists with or ``None`` (the default) for no sharing.

   |

   **Returns:**

   `wx.glcanvas.GLContext <wx.glcanvas.GLContext.html>`_ 

--------

.. method:: SetCurrent(win)

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

   **Parameters:**

   * `win` (`wx.GLCanvas <wx.GLCanvas.html>`_) 


.. note:: Note that `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:: 

       win.SetCurrent(RC) 

   and::

       RC.SetCurrent(win)


   are equivalent.

.. seealso:: `wx.glcanvas.GLCanvas.SetCurrent <wx.glcanvas.GLCanvas.html#SetCurrent>`_