PyOpenGL 2.0.1.07 Man Pages
|  | Next

# PyOpenGL 2.0.1.07 Man Pages

Abstract

PyOpenGL is a cross-platform open source Python binding to OpenGL which provides a standard 2D and 3D graphics API. PyOpenGL also supports GLU, GLE, GLUT, WGL, and Togl.

Table of Contents

I. Reference
  I. GL
    glAccum - operate on the accumulation buffer
    glActiveTextureARB - select active texture unit
    glAlphaFunc - specify the alpha test function
    glAreTexturesResident - determine if textures are loaded in texture memory
    glArrayElement - render a vertex using the specified vertex array element
    glBegin - delimit the vertices of a primitive or a group of like primitives
    glBindTexture - bind a named texture to a texturing target
    glBitmap - draw a bitmap
    glBlendColor - set the blend color
    glBlendEquation - set the blend equation
    glBlendFunc - specify pixel arithmetic
    glCallList - execute a display list
    glCallLists - execute a list of display lists
    glClear - clear buffers to preset values
    glClearAccum - specify clear values for the accumulation buffer
    glClearColor - specify clear values for the color buffers
    glClearDepth - specify the clear value for the depth buffer
    glClearIndex - specify the clear value for the color index buffers
    glClearStencil - specify the clear value for the stencil buffer
    glClientActiveTextureARB - select active texture unit
    glClipPlane - specify a plane against which all geometry is clipped
    glColor - set the current color
    glColorMask - enable and disable writing of frame buffer color components
    glColorMaterial - cause a material color to track the current color
    glColorPointer - define an array of colors
    glColorSubTable - respecify a portion of a color table
    glColorTable - define a color lookup table
    glColorTableParameter - set color lookup table parameters
    glConvolutionFilter1D - define a one-dimensional convolution filter
    glConvolutionFilter2D - define a two-dimensional convolution filter
    glConvolutionParameter - set convolution parameters
    glCopyColorSubTable - respecify a portion of a color table
    glCopyColorTable - copy pixels into a color table
    glCopyConvolutionFilter1D - copy pixels into a one-dimensional convolution filter
    glCopyConvolutionFilter2D - copy pixels into a two-dimensional convolution filter
    glCopyPixels - copy pixels in the frame buffer
    glCopyTexImage1D - copy pixels into a 1D texture image
    glCopyTexImage2D - copy pixels into a 2D texture image
    glCopyTexSubImage1D - copy a one-dimensional texture subimage
    glCopyTexSubImage2D - copy a two-dimensional texture subimage
    glCopyTexSubImage3D - copy a three-dimensional texture subimage
    glCullFace - specify whether front- or back-facing facets can be culled
    glDeleteLists - delete a contiguous group of display lists
    glDeleteTextures - delete named textures
    glDepthFunc - specify the value used for depth buffer comparisons
    glDepthMask - enable or disable writing into the depth buffer
    glDepthRange - specify mapping of depth values from normalized device coordinates to window coordinates
    glDrawArrays - render primitives from array data
    glDrawBuffer - specify which color buffers are to be drawn into
    glDrawElements - render primitives from array data
    glDrawPixels - write a block of pixels to the frame buffer
    glDrawRangeElements - render primitives from array data
    glEdgeFlag - flag edges as either boundary or nonboundary
    glEdgeFlagPointer - define an array of edge flags
    glEnable - enable or disable server-side GL capabilities
    glEnableClientState - enable or disable client-side capability
    glEvalCoord - evaluate enabled one-dimensional and two-dimensional maps
    glEvalMesh - compute a one- or two-dimensional grid of points or lines
    glEvalPoint - generate and evaluate a single point in a mesh
    glFeedbackBuffer - controls feedback mode
    glFinish - block until all GL execution is complete
    glFlush - force execution of GL commands in finite time
    glFog - specify fog parameters
    glFrontFace - define front- and back-facing polygons
    glFrustum - multiply the current matrix by a perspective matrix
    glGenLists - generate a contiguous set of empty display lists
    glGenTextures - generate texture names
    glGet - return the value or values of a selected parameter
    glGetClipPlane - return the coefficients of the specified clipping plane
    glGetColorTable - retrieve contents of a color lookup table
    glGetColorTableParameter - get color lookup table parameters
    glGetConvolutionFilter - get current 1D or 2D convolution filter kernel
    glGetConvolutionParameter - get convolution parameters
    glGetError - return error information
    glGetHistogram - get histogram table
    glGetHistogramParameter - get histogram parameters
    glGetLight - return light source parameter values
    glGetMap - return evaluator parameters
    glGetMaterial - return material parameters
    glGetMinmax - get minimum and maximum pixel values
    glGetMinmaxParameter - get minmax parameters
    glGetPixelMap - return the specified pixel map
    glGetPointerv - return the address of the specified pointer
    glGetPolygonStipple - return the polygon stipple pattern
    glGetSeparableFilter - get separable convolution filter kernel images
    glGetString - return a string describing the current GL connection
    glGetTexEnv - return texture environment parameters
    glGetTexGen - return texture coordinate generation parameters
    glGetTexImage - return a texture image
    glGetTexLevelParameter - return texture parameter values for a specific level of detail
    glGetTexParameter - return texture parameter values
    glHint - specify implementation-specific hints
    glHistogram - define histogram table
    glIndex - set the current color index
    glIndexMask - control the writing of individual bits in the color index buffers
    glIndexPointer - define an array of color indexes
    glInitNames - initialize the name stack
    glInterleavedArrays - simultaneously specify and enable several interleaved arrays
    glIsEnabled - test whether a capability is enabled
    glIsList - determine if a name corresponds to a display-list
    glIsTexture - determine if a name corresponds to a texture
    glLight - set light source parameters
    glLightModel - set the lighting model parameters
    glLineStipple - specify the line stipple pattern
    glLineWidth - specify the width of rasterized lines
    glListBase - set the display-list base for glCallLists
    glLoadIdentity - replace the current matrix with the identity matrix
    glLoadMatrix - replace the current matrix with the specified matrix
    glLoadName - load a name onto the name stack
    glLogicOp - specify a logical pixel operation for color index rendering
    glMap1 - define a one-dimensional evaluator
    glMap2 - define a two-dimensional evaluator
    glMapGrid - define a one- or two-dimensional mesh
    glMaterial - specify material parameters for the lighting model
    glMatrixMode - specify which matrix is the current matrix
    glMinmax - define minmax table
    glMultMatrix - multiply the current matrix with the specified matrix
    glMultiTexCoordARB - set the current texture coordinates
    glNewList - create or replace a display list
    glNormal - set the current normal vector
    glNormalPointer - define an array of normals
    glOrtho - multiply the current matrix with an orthographic matrix
    glPassThrough - place a marker in the feedback buffer
    glPixelMap - set up pixel transfer maps
    glPixelStore - set pixel storage modes
    glPixelTransfer - set pixel transfer modes
    glPixelZoom - specify the pixel zoom factors
    glPointSize - specify the diameter of rasterized points
    glPolygonMode - select a polygon rasterization mode
    glPolygonOffset - set the scale and units used to calculate depth values
    glPolygonStipple - set the polygon stippling pattern
    glPrioritizeTextures - set texture residence priority
    glPushAttrib - push and pop the server attribute stack
    glPushClientAttrib - push and pop the client attribute stack
    glPushMatrix - push and pop the current matrix stack
    glPushName - push and pop the name stack
    glRasterPos - specify the raster position for pixel operations
    glReadBuffer - select a color buffer source for pixels
    glReadPixels - read a block of pixels from the frame buffer
    glRect - draw a rectangle
    glRenderMode - set rasterization mode
    glResetHistogram - reset histogram table entries to zero
    glResetMinmax - reset minmax table entries to initial values
    glRotate - multiply the current matrix by a rotation matrix
    glScale - multiply the current matrix by a general scaling matrix
    glScissor - define the scissor box
    glSelectBuffer - establish a buffer for selection mode values
    glSeparableFilter2D - define a separable two-dimensional convolution filter
    glShadeModel - select flat or smooth shading
    glStencilFunc - set function and reference value for stencil testing
    glStencilMask - control the writing of individual bits in the stencil planes
    glStencilOp - set stencil test actions
    glTexCoord - set the current texture coordinates
    glTexCoordPointer - define an array of texture coordinates
    glTexEnv - set texture environment parameters
    glTexGen - control the generation of texture coordinates
    glTexImage1D - specify a one-dimensional texture image
    glTexImage2D - specify a two-dimensional texture image
    glTexImage3D - specify a three-dimensional texture image
    glTexParameter - set texture parameters
    glTexSubImage1D - specify a one-dimensional texture subimage
    glTexSubImage2D - specify a two-dimensional texture subimage
    glTexSubImage3D - specify a three-dimensional texture subimage
    glTranslate - multiply the current matrix by a translation matrix
    glVertex - specify a vertex
    glVertexPointer - define an array of vertex data
    glViewport - set the viewport
  II. GLU
    gluBeginCurve - delimit a NURBS curve definition
    gluBeginPolygon - delimit a polygon description
    gluBeginSurface - delimit a NURBS surface definition
    gluBeginTrim - delimit a NURBS trimming loop definition
    gluBuild1DMipmapLevels - builds a subset of one-dimensional mipmap levels
    gluBuild1DMipmaps - builds a one-dimensional mipmap
    gluBuild2DMipmapLevels - builds a subset of two-dimensional mipmap levels
    gluBuild2DMipmaps - builds a two-dimensional mipmap
    gluBuild3DMipmapLevels - builds a subset of three-dimensional mipmap levels
    gluBuild3DMipmaps - builds a three-dimensional mipmap
    gluCheckExtension - determines if an extension name is supported
    gluCylinder - draw a cylinder
    gluDeleteNurbsRenderer - destroy a NURBS object
    gluDeleteQuadric - destroy a quadrics object
    gluDeleteTess - destroy a tessellation object
    gluDisk - draw a disk
    gluErrorString - produce an error string from a GL or GLU error code
    gluGetNurbsProperty - get a NURBS property
    gluGetString - return a string describing the GLU version or GLU extensions
    gluGetTessProperty - get a tessellation object property
    gluLoadSamplingMatrices - load NURBS sampling and culling matrices
    gluLookAt - define a viewing transformation
    gluNewNurbsRenderer - create a NURBS object
    gluNewQuadric - create a quadrics object
    gluNewTess - create a tessellation object
    gluNextContour - mark the beginning of another contour
    gluNurbsCallback - define a callback for a NURBS object
    gluNurbsCallbackData - set a user data pointer
    gluNurbsCallbackDataEXT - set a user data pointer
    gluNurbsCurve - define the shape of a NURBS curve
    gluNurbsProperty - set a NURBS property
    gluNurbsSurface - define the shape of a NURBS surface
    gluOrtho2D - define a 2D orthographic projection matrix
    gluPartialDisk - draw an arc of a disk
    gluPerspective - set up a perspective projection matrix
    gluPickMatrix - define a picking region
    gluProject - map object coordinates to window coordinates
    gluPwlCurve - describe a piecewise linear NURBS trimming curve
    gluQuadricCallback - define a callback for a quadrics object
    gluQuadricDrawStyle - specify the draw style desired for quadrics
    gluQuadricNormals - specify what kind of normals are desired for quadrics
    gluQuadricOrientation - specify inside/outside orientation for quadrics
    gluQuadricTexture - specify if texturing is desired for quadrics
    gluScaleImage - scale an image to an arbitrary size
    gluSphere - draw a sphere
    gluTessBeginContour - delimit a contour description
    gluTessBeginPolygon - delimit a polygon description
    gluTessCallback - define a callback for a tessellation object
    gluTessEndPolygon - delimit a polygon description
    gluTessNormal - specify a normal for a polygon
    gluTessProperty - set a tessellation object property
    gluTessVertex - specify a vertex on a polygon
    gluUnProject - map window coordinates to object coordinates
    gluUnProject4 - map window and clip coordinates to object coordinates
  III. GLUT
    glut - an introduction to the OpenGL Utility Toolkit
    glutAddMenuEntry - adds a menu entry to the bottom of the current menu.
    glutAddSubMenu - adds a sub-menu trigger to the bottom of the current menu.
    glutAttachMenu - attaches/detaches a mouse button for the current window to the identifier of the current menu
    glutBitmapCharacter - renders a bitmap character using OpenGL.
    glutBitmapWidth - returns the width/length of a bitmap character/string.
    glutButtonBoxFunc - sets the dial & button box button callback for the current window.
    glutChangeToMenuEntry - changes the specified menu item in the current menu into a menu entry.
    glutChangeToSubMenu - changes the specified menu item in the current menu into a sub-menu trigger.
    glutCopyColormap - copies the logical colormap for the layer in use from a specified window to the current window.
    glutCreateMenu - creates a new pop-up menu.
    glutCreateSubWindow - creates a subwindow.
    glutCreateWindow - creates a top-level window.
    glutDestroyMenu - destroys the specified menu.
    glutDestroyWindow - destroys the specified window.
    glutDeviceGet - retrieves GLUT device information represented by integers.
    glutDialsFunc - sets the dial & button box dials callback for the current window.
    glutDisplayFunc - sets the display callback for the current window.
    glutEnterGameMode - enters and leaves GLUT's game mode.
    glutEntryFunc - sets the mouse enter/leave callback for the current window.
    glutEstablishOverlay - establishes an overlay (if possible) for the current window.
    glutExtensionSupported - helps to easily determine whether a given OpenGL extension is supported.
    glutForceJoystickFunc - forces current window's joystick callback to be called.
    glutFullScreen - requests that the current window be made full screen.
    glutGameModeGet - retrieves GLUT game mode information represented by integers.
    glutGameModeString - sets the game mode configuration via a string.
    glutGet - retrieves simple GLUT state represented by integers.
    glutGetColor - retrieves a red, green, or blue component for a given color index colormap entry for the layer in use's logical colormap for the current window.
    glutGetModifiers - returns the modifier key state when certain callbacks were generated.
    glutIdleFunc - sets the global idle callback.
    glutIgnoreKeyRepeat - determines if auto repeat keystrokes are reported to the current window
    glutInit - initialize the GLUT library.
    glutInitDisplayMode - sets the initial display mode.
    glutInitDisplayString - sets the initial display mode via a string.
    glutInitWindowPosition - set the initial window position and size respectively.
    glutJoystickFunc - sets the joystick callback for the current window.
    glutKeyboardFunc - sets the keyboard callback for the current window.
    glutKeyboardUpFunc - sets the keyboard up (key release) callback for the current window.
    glutLayerGet - retrieves GLUT state pertaining to the layers of the current window.
    glutMainLoop - enters the GLUT event processing loop.
    glutMenuStatusFunc - sets the global menu status callback.
    glutMotionFunc - set the motion and passive motion callbacks respectively for the current window.
    glutMouseFunc - sets the mouse callback for the current window.
    glutOverlayDisplayFunc - sets the overlay display callback for the current window.
    glutPopWindow - change the stacking order of the current window relative to its siblings.
    glutPositionWindow - requests a change to the position of the current window.
    glutPostOverlayRedisplay - marks the overlay of the current or specified window as needing to be redisplayed.
    glutPostRedisplay - marks the current or specified window as needing to be redisplayed.
    glutRemoveMenuItem - remove the specified menu item.
    glutRemoveOverlay - removes the overlay (if one exists) from the current window.
    glutReportErrors - for debugging purposes; prints out OpenGL run-time errors.
    glutReshapeFunc - sets the reshape callback for the current window.
    glutReshapeWindow - requests a change to the size of the current window.
    glutSetColor - sets the color of a colormap entry in the layer of use for the current window.
    glutSetCursor - changes the cursor image of the current window.
    glutSetKeyRepeat - sets the key repeat mode
    glutSetMenu - set/get the current menu
    glutSetWindow - set/get the current window
    glutSetWindowTitle - change the window or icon title respectively of the current top-level window.
    glutShowOverlay - shows or hides the overlay of the current window
    glutShowWindow - change the display status of the current window.
    glutSolidCone - render a solid or wireframe cone respectively.
    glutSolidCube - render a solid or wireframe cube respectively.
    glutSolidDodecahedron - render a solid or wireframe dodecahedron (12-sided regular solid) respectively.
    glutSolidIcosahedron - render a solid or wireframe icosahedron (20-sided regular solid) respectively.
    glutSolidOctahedron - render a solid or wireframe octahedron (8-sided regular solid) respectively.
    glutSolidSphere - render a solid or wireframe sphere respectively.
    glutSolidTeapot - render a solid or wireframe teapot respectively.
    glutSolidTetrahedron - render a solid or wireframe tetrahedron (4-sided regular solid) respectively.
    glutSolidTorus - render a solid or wireframe torus (doughnut) respectively.
    glutSpaceballButtonFunc - sets the Spaceball button callback for the current window.
    glutSpaceballMotionFunc - sets the Spaceball motion callback for the current window.
    glutSpaceballRotateFunc - sets the Spaceball rotation callback for the current window.
    glutSpecialFunc - sets the special keyboard callback for the current window.
    glutSpecialUpFunc - sets the special keyboard up (key release) callback for the current window.
    glutStrokeCharacter - renders a stroke character using OpenGL.
    glutStrokeWidth - returns the width/length of a stroke character/string.
    glutSwapBuffers - swaps the buffers of the current window if double buffered.
    glutTabletButtonFunc - sets the special keyboard callback for the current window.
    glutTabletMotionFunc - sets the special keyboard callback for the current window.
    glutTimerFunc - registers a timer callback to be triggered in a specified number of milliseconds.
    glutUseLayer - changes the layer in use for the current window.
    glutVideoResizeGet - retrieves GLUT video resize information represented by integers.
    glutVisibilityFunc - sets the visibility callback for the current window.
    glutWarpPointer -
    glutWindowStatusFunc - sets the window status callback for the current window.
  IV. GLE
    gle - an introduction to the GLE Tubing & Extrusions Library
    gleExtrusion - Extrude arbitrary 2D contour along arbitrary 3D path.
    gleHelicoid - Generalized torus, spiral with circle contour.
    gleLathe - Sweep using a Z-axis shear to create an arbitrary contour along a helical path.
    glePolyCone - Draw polycone, specified as a polyline with radii.
    glePolyCylinder - Draw polycylinder, specified as a polyline.
    gleScrew - Draws screw-type shapes.
    gleSetJoinStyle - Query and Set the GLE join style flags.
    gleSetNumSides - Query and Set the cylinder roundness.
    gleSpiral - Sweep an arbitrary contour along a helical path.
    gleSuperExtrusion - Extrude arbitrary 2D contour along arbitrary 3D path, specifying local affine transformations.
    gleTextureMode - set the type of GLE automatic texture coordinate generation.
    gleToroid - Generalized torus, lathe with circle contour.
    gleTwistExtrusion - Extrude arbitrary 2D contour along arbitrary 3D path, specifying local rotations (twists).

|  | Next
|  | Part I. Reference