pyglet.gl
OpenGL interface.
This package imports all OpenGL and registered OpenGL extension functions. Functions have identical signatures to their C counterparts.
OpenGL is documented in full at the OpenGL Reference Pages.
The OpenGL Programming Guide, also known as “The Red Book”, is a popular reference manual organised by topic. It is available in digital and paper editions.
The following subpackages are imported into this “mega” package already
(and so are available by importing pyglet.gl):
pyglet.gl.glOpenGL
pyglet.gl.gl.glext_arbARB registered OpenGL extension functions
pyglet.gl.gl.gl_compatDeprecated OpenGL extension functions.
These subpackages are also available, but are not imported into this namespace by default:
pyglet.gl.glext_nvnVidia OpenGL extension functions
pyglet.gl.aglAGL (Mac OS X OpenGL context functions)
pyglet.gl.glxGLX (Linux OpenGL context functions)
pyglet.gl.glxext_arbARB registered GLX extension functions
pyglet.gl.glxext_nvnvidia GLX extension functions
pyglet.gl.wglWGL (Windows OpenGL context functions)
pyglet.gl.wglext_arbARB registered WGL extension functions
pyglet.gl.wglext_nvnvidia WGL extension functions
The information modules are provided for convenience, and are documented below.
- exception GLException
- class Config
Graphics configuration.
A Config stores the preferences for OpenGL attributes such as the number of auxiliary buffers, size of the colour and depth buffers, double buffering, stencilling, multi- and super-sampling, and so on.
Different platforms support a different set of attributes, so these are set with a string key and a value which is integer or boolean.
-
accum_alpha_size:
int Bits per pixel devoted to the alpha component in the accumulation buffer.
-
accum_blue_size:
int Bits per pixel devoted to the blue component in the accumulation buffer.
-
accum_green_size:
int Bits per pixel devoted to the green component in the accumulation buffer.
-
accum_red_size:
int Bits per pixel devoted to the red component in the accumulation buffer.
-
alpha_size:
int Bits per sample per buffer devoted to the alpha component.
-
aux_buffers:
int The number of auxiliary color buffers.
-
blue_size:
int Bits per sample per buffer devoted to the blue component.
-
buffer_size:
int Total bits per sample per color buffer.
-
debug:
bool Debug mode.
-
depth_size:
int Bits per sample in the depth buffer.
-
double_buffer:
bool Specify the presence of a back-buffer for every color buffer.
-
forward_compatible:
bool Whether to use forward compatibility mode.
-
green_size:
int Bits per sample per buffer devoted to the green component.
-
major_version:
int The OpenGL major version.
-
minor_version:
int The OpenGL minor version.
-
opengl_api:
str The OpenGL API, such as “gl” or “gles”.
-
red_size:
int Bits per sample per buffer devoted to the red component.
-
sample_buffers:
int The number of multisample buffers.
-
samples:
int The number of samples per pixel, or 0 if there are no multisample buffers.
-
stencil_size:
int Bits per sample in the stencil buffer.
-
stereo:
bool Specify the presence of separate left and right buffer sets.
-
transparent_framebuffer:
bool If the framebuffer should be transparent.
-
accum_alpha_size:
- GLDEBUGPROC
alias of
CFunctionType
- GLbitfield
alias of
c_uint
- GLboolean
alias of
c_ubyte
- GLbyte
alias of
c_byte
- GLchar
alias of
c_char
- GLclampd
alias of
c_double
- GLclampf
alias of
c_float
- GLclampx
alias of
c_uint
- GLdouble
alias of
c_double
- GLenum
alias of
c_uint
- GLfloat
alias of
c_float
- GLint
alias of
c_int
- GLint64
alias of
c_long
- GLintptr
alias of
c_long
- GLshort
alias of
c_short
- GLsizei
alias of
c_int
- GLsizeiptr
alias of
c_long
- GLsync
alias of
LP_struct___GLsync
- GLubyte
alias of
c_ubyte
- GLuint
alias of
c_uint
- GLuint64
alias of
c_ulong
- GLuint64EXT
alias of
c_ulong
- GLushort
alias of
c_ushort
- class ObjectSpace
A container to store shared objects that are to be removed.
- class Config
Graphics configuration.
A Config stores the preferences for OpenGL attributes such as the number of auxiliary buffers, size of the colour and depth buffers, double buffering, stencilling, multi- and super-sampling, and so on.
Different platforms support a different set of attributes, so these are set with a string key and a value which is integer or boolean.
-
accum_alpha_size:
int Bits per pixel devoted to the alpha component in the accumulation buffer.
-
accum_blue_size:
int Bits per pixel devoted to the blue component in the accumulation buffer.
-
accum_green_size:
int Bits per pixel devoted to the green component in the accumulation buffer.
-
accum_red_size:
int Bits per pixel devoted to the red component in the accumulation buffer.
-
alpha_size:
int Bits per sample per buffer devoted to the alpha component.
-
aux_buffers:
int The number of auxiliary color buffers.
-
blue_size:
int Bits per sample per buffer devoted to the blue component.
-
buffer_size:
int Total bits per sample per color buffer.
-
debug:
bool Debug mode.
-
depth_size:
int Bits per sample in the depth buffer.
-
double_buffer:
bool Specify the presence of a back-buffer for every color buffer.
-
forward_compatible:
bool Whether to use forward compatibility mode.
-
green_size:
int Bits per sample per buffer devoted to the green component.
-
major_version:
int The OpenGL major version.
-
minor_version:
int The OpenGL minor version.
-
opengl_api:
str The OpenGL API, such as “gl” or “gles”.
-
red_size:
int Bits per sample per buffer devoted to the red component.
-
sample_buffers:
int The number of multisample buffers.
-
samples:
int The number of samples per pixel, or 0 if there are no multisample buffers.
-
stencil_size:
int Bits per sample in the stencil buffer.
-
stereo:
bool Specify the presence of separate left and right buffer sets.
-
transparent_framebuffer:
bool If the framebuffer should be transparent.
-
accum_alpha_size:
- class DisplayConfig
Bases:
Config,ABCAn OpenGL configuration for a particular display.
Use
Config.matchto obtain an instance of this class.Added in version 1.2.
- class Context
A base OpenGL context for drawing.
Use
DisplayConfig.create_contextto create a context.-
config:
DisplayConfig
-
object_space:
ObjectSpace A container which is shared between all contexts that share GL objects.
-
config: