OpenGLContext Documentation

This document collects OpenGLContext-specific documentation.  The main PyOpenGL documentation collection includes links to both PyOpenGL and OpenGL documentation which will be of use to the OpenGLContext programmer as well.

OpenGLContext-Specific Documentation

There is little OpenGLContext-specific documentation at the moment. The most useful items are probably the rendering process description, and the pydoc-generated reference. The NeHe tutorial translations should be useful for beginning OpenGL programmers.

• Tutorials -- Documentation for users unfamiliar with OpenGL
• NeHe translations
• Introduction to Shaders
• Special Effects
  
• The Rendering Process -- The rendering algorithm(s), including the scenegraph traversal mechanism(s), used by OpenGLContext when rendering a scene
• Using VRML97 -- Tutorial on using the (partial) VRML97 loader and the nodes it creates
• Event Model -- The event model which manages changes to the VRML97 scenegraph
• PyDoc References (Automatically generated documentation)
• OpenGLContext
• OpenGLContext_qt (PyQt4 context, a separate module due to licensing restrictions)
• PyVRML97 (module vrml)
• TTFQuery (module ttfquery)
• PyOpenGL (module OpenGL)
• Structural Overview -- OpenGLContext's architecture and implementation
• Rendering Text -- Overview of the Text and FontStyle scenegraph nodes, general notes regarding support of text in OpenGLContext
• Using Numeric Python -- Overview of using Numeric Python within OpenGLContext (and PyOpenGL), with emphasis on the basics of Numeric Python, rather than PyOpenGL specifics.

Sample Code (Where to Look)

The râison d'ętre (apologies for my rusty French) for OpenGLContext is to provide a platform for testing and sample code, so you'll find a lot of it lurking about in the project. In particular, in the source-code release, you can find sample code for:

• Shader-Based Drawing
• Instanced Rendering Sample
  
• Shader-based Geometry Scenegraph Nodes
• GLU polygon tessellation
• Scenegraph Node
• Usage Sample
• Polygon-sorting by screen depth
• passes sub-package, flat.py and passes.py
  
• Multi-texturing
• Saving buffers to disk (screen capture)
• Select render mode (mouse interactions)
• Particle-systems
• Display Lists
• Geometry Drawing
• Box
• Sphere, Cone and Cylinder
• Non-Uniform Rational B-Splines (NURBS), including surfaces and curves, with trimming
• Scenegraph Node
• Usage Sample
• Array Based Geometry
• Basic
• IndexedFaceSet
• IndexPolygons
• IndexLineSet
• Pointset including sprite support
  
• GLUT Teapot
• Gear
• Extrusions GLE-based tubing and extrusion
• Text
• Solid/3D Font Extraction with TTFQuery
• Pygame Bitmap Font
• Scene Setup
• SphereBackground spherical gradiant backgrounds
  
• CubeBackground skybox implementation
• Lights
• Material Properties
• Material
• Appearance
• Textures with PIL/Pillow