OpenGL (version 3.0.1b2)
ctypes-based OpenGL wrapper for Python
This is the PyOpenGL 3.x tree, it attempts to provide
a largely compatible API for code written with the
PyOpenGL 2.x series using the ctypes foreign function
There are a few configuration variables in this top-level
module. Applications should be the only code that tweaks
these variables, mid-level libraries should not take it
upon themselves to disable/enable features at this level.
The implication there is that your library code should be
able to work with any of the valid configurations available
with these sets of flags.
ERROR_CHECKING -- if set to a False value before
importing any OpenGL.* libraries will completely
disable error-checking. This can dramatically
improve performance, but makes debugging far
This is intended to be turned off *only* in a
production environment where you *know* that
your code is entirely free of situations where you
use exception-handling to handle error conditions,
i.e. where you are explicitly checking for errors
everywhere they can occur in your code.
ERROR_LOGGING -- If True, then wrap array-handler
functions with error-logging operations so that all exceptions
will be reported to log objects in OpenGL.logs, note that
this means you will get lots of error logging whenever you
have code that tests by trying something and catching an
error, this is intended to be turned on only during
development so that you can see why something is failing.
Errors are normally logged to the OpenGL.errors logger.
Only triggers if ERROR_CHECKING is True
ERROR_ON_COPY -- if set to a True value before
importing the numpy/lists support modules, will
cause array operations to raise
OpenGL.error.CopyError if the operation
would cause a data-copy in order to make the
passed data-type match the target data-type.
This effectively disables all list/tuple array
support, as they are inherently copy-based.
This feature allows for optimisation of your
application. It should only be enabled during
testing stages to prevent raising errors on
recoverable conditions at run-time.
Note: this feature does not currently work with
numarray or Numeric arrays.
CONTEXT_CHECKING -- if set to True, PyOpenGL will wrap
*every* GL and GLU call with a check to see if there
is a valid context. If there is no valid context
then will throw OpenGL.errors.NoContext. This is an
*extremely* slow check and is not enabled by default,
intended to be enabled in order to track down (wrong)
code that uses GL/GLU entry points before the context
has been initialized (something later Linux GLs are
very picky about).
STORE_POINTERS -- if set to True, PyOpenGL array operations
will attempt to store references to pointers which are
being passed in order to prevent memory-access failures
if the pointed-to-object goes out of scope. This
behaviour is primarily intended to allow temporary arrays
to be created without causing memory errors, thus it is
trading off performance for safety.
To use this flag effectively, you will want to first set
ERROR_ON_COPY to True and eliminate all cases where you
are copying arrays. Copied arrays *will* segfault your
application deep within the GL if you disable this feature!
Once you have eliminated all copying of arrays in your
application, you will further need to be sure that all
arrays which are passed to the GL are stored for at least
the time period for which they are active in the GL. That
is, you must be sure that your array objects live at least
until they are no longer bound in the GL. This is something
you need to confirm by thinking about your application's
When you are sure your arrays won't cause seg-faults, you
can set STORE_POINTERS=False in your application and enjoy
a (slight) speed up.
Note: this flag is *only* observed when ERROR_ON_COPY == True,
as a safety measure to prevent pointless segfaults
WARN_ON_FORMAT_UNAVAILABLE -- If True, generates
logging-module warn-level events when a FormatHandler
plugin is not loadable (with traceback).
FULL_LOGGING -- If True, then wrap functions with
logging operations which reports each call along with its
arguments to the OpenGL.calltrace logger at the INFO
level. This is *extremely* slow. You should *not* enable
this in production code!
You will need to have a logging configuration (e.g.
) call in your top-level script to see the results of the
ALLOW_NUMPY_SCALARS -- if True, we will wrap
all GLint/GLfloat calls conversions with wrappers
that allow for passing numpy scalar values.
Note that this is experimental, *not* reliable,
and very slow!
Note that byte/char types are not wrapped.
UNSIGNED_BYTE_IMAGES_AS_STRING -- if True, we will return
GL_UNSIGNED_BYTE image-data as strings, istead of arrays
for glReadPixels and glGetTexImage
FORWARD_COMPATIBLE_ONLY -- only include OpenGL 3.1 compatible
entry points. Note that this will generally break most
PyOpenGL code that hasn't been explicitly made "legacy free"
via a significant rewrite.
SIZE_1_ARRAY_UNPACK -- if True, unpack size-1 arrays to be
scalar values, as done in PyOpenGL 1.5 -> 3.0.0, that is,
if a glGenList( 1 ) is done, return a uint rather than
an array of uints.
USE_ACCELERATE -- if True, attempt to use the OpenGL_accelerate
package to provide Cython-coded accelerators for core wrapping
GL (package) -- OpenGL.GL, the core GL library and extensions to it
GLE (package) -- GL Extrusion Routine Library (GLE) wrapper for OpenGL-ctypes
GLU (package) -- The GLU library implementation via ctypes
GLUT (package) -- The GLUT library implementation via ctypes
GLX (package) -- Platform-specific functions/support for the xorg/X11 windowing system
Tk (package) -- Traditional PyOpenGL interface to Togl
__init__ -- ctypes-based OpenGL wrapper for Python
acceleratesupport -- Common code for accelerated modules
arrays (package) -- Abstraction point for handling of data-pointers in OpenGL
constant -- Implementation of OpenGL constant objects
constants -- OpenGL-wide constant types (not OpenGL.GL-specific)
contextdata -- Storage of per-context values of various types
converters -- Implementations for common converter types
error -- Implementation of OpenGL errors/exceptions
extensions -- Extension module support methods
images -- Image/texture implementation code
lazywrapper -- Simplistic wrapper decorator for Python-coded wrappers
logs -- Fix missing-API problems in logging module (circa Python 2.3)
platform (package) -- Abstraction for the platform-specific code in PyOpenGL
plugins -- Simple plug-in mechanism to provide replacement for setuptools plugins
raw (package) -- C-style "raw" API for low-level ctypes-specific access to OpenGL
version -- Declares the current version for use in setuptools and the like
wrapper -- The wrapping code for providing natural ctypes-based OpenGL interface
|ALLOW_NUMPY_SCALARS = False|
ARRAY_SIZE_CHECKING = True
CONTEXT_CHECKING = False
ERROR_CHECKING = True
ERROR_LOGGING = False
ERROR_ON_COPY = False
FORWARD_COMPATIBLE_ONLY = False
FULL_LOGGING = False
SIZE_1_ARRAY_UNPACK = True
STORE_POINTERS = True
UNSIGNED_BYTE_IMAGES_AS_STRING = True
USE_ACCELERATE = True
WARN_ON_FORMAT_UNAVAILABLE = False
__file__ = '/home/mcfletch/pylive/OpenGL/__init__.pyc'
__name__ = 'OpenGL'
__package__ = 'OpenGL'
__path__ = ['/home/mcfletch/pylive/OpenGL']
__version__ = '3.0.1b2'