Whilest this project is still usable, it will no longer receive new features.

I will accept pull-requests and patches, but my own major development on this library has ceased.

The lessons learnt while developing and using this are being used in the next-generation OpenGL framework OMGL, which will be used as a base for the Bast 3D Engine.

PyGLy

PyGLy is a flexible OpenGL framework that works with any PyOpenGL supported Windowing system.

PyGLy provides a set of common rendering classes, but doesn't force you to use any of them.

Design

• OpenGL agnostic - Use Legacy (<=2.1) or Core (>=3) profiles.
• Cross-platform - Actively developed on Windows, Linux and Mac OS-X.
• Easy to install - Written in pure python.
• Modular design - Take almost any part of PyGLy and use it on its own.
• Loosely coupled framework, not an engine - Don't like an existing class? Don't use it! PyGLy doesn't force any programming method on you.
• Duck-typing - Replace any class with your own.
• Full control over rendering process.
• Uses Pyrr for Maths - NumPy powered Quaternion, Matrix, Vectors, Rays.
• Liberal BSD licensing - Do what you want!

Features

• Platform - Windowing system agnostic.
• Viewports - Multiple viewports using simple to use wrappers.
• Optional scene objects - Scene nodes, cameras, render nodes.
• 3D transform objects - Wraps 3D maths in intuitive objects.
• GLSL shaders - Uniform and Attribute wrappers. Errors print offending source code.
• Vertex Arrays and Buffers - Basic and numpy enhanced versions. No more pointer maths.
• Sorting - Sort scene to minimise over-draw and to support transparency.
• Texture - Easily create OpenGL textures using raw data or PIL.
• View Matrices - Simple wrappers that provide easy manipulation of the view matrix.
• GL functions - Python wrappers for common tasks.
• Cocos2D - Support for rendering PyGLy as a Cocos2D layer (OpenGL Legacy only).

Philosophy

• FRAMEWORK, not an engine. Program any way you want.
• FLEXIBLE, don't force any one method upon the user
• FULL CONTROL at all times. Full access to rendering, objects, data. No obfuscation. No 'awesome' tricks. Just good, simple code.
• EASY INSTALLATION. No crazy C++ bindings and complex build procedures.
• EXPOSE as much functionality as possible. Lower classes are always accessible or usable on their own.
• LOOSE COUPLING. Code designed with minimal coupling, allowing you to use only what you want.
• OPTIONAL high level classes. Low level code is always usable. High level API is optional.
• EXAMPLES of high quality.
• PYTHON to the core.
• SPEED in development. Simple and Intuitive code provides convenience functions where it makes sense.
• DEFINED GOALS. PyGLy aims to provide a high quality, base. PyGLy will never become bloat-ware.
• PARTNER PROJECTS. PyGLy provides the core of our 3D stack.

Documentation

View PyGLy's documentation online.

BYO Windowing System

PyGLy contains no platform / window specific code.

PyGLy has been tested with the following windowing systems:

• GLUT (OpenGL Legacy only)
• Pyglet
• PyGLFW

Note: When using Pyglet on Mac OS-X and the OpenGL core profile, you must use the Pyglet version supplied in the /contrib/pyglet directory.

Dependencies

Required Dependencies:

• Python 2(.6?)+
• PyOpenGL
• PyDispatcher
• NumPy
• Pyrr (https://github.com/adamlwgriffiths/Pyrr)

Optional dependencies:

• PIL / Pillow (PIL texture loading)
• PyOpenGL-accelerate

Installation

PyGLy is available from the PyPI package repository under the name 'pygly'.

Source installation is the recommended method to use PyGLy.

Install dependencies

Install required dependencies listed above.

Optional:

• pillow
• PyOpenGL-accelerate

And a window system of your choice.

Get PyGLy

git clone git://github.com/adamlwgriffiths/PyGLy.git
cd PyGLy
git submodule init
git submodule update

Add to Python

Select one of the following:

• A. Install PyGLy and it's submodules.
• OR
• B. set the PYTHONPATH to enable each module.

A. Install (Instead of B)

cd contrib/pyrr
python setup.py install
cd ../../
python setup.py install

B. Adding to PYTHONPATH (Instead of A)

export PYTHONPATH=$PYTHONPATH:/path/to/PyGLy
export PYTHONPATH=$PYTHONPATH:/path/to/PyGLy/contrib/pyrr

Check that it worked!

python pygly/examples/run_demo.py -p glut -g legacy -d basic

Usage

Check the 'pygly/examples' directory for for some example code.

Development

PyGLy is developed by Twisted Pair Development.

Contributions are welcome.

License

PyGLy is released under the BSD 2-clause license (a very relaxed licence), but it is encouraged that any modifications are submitted back to the master for inclusion.

Created by Adam Griffiths.

Copyright (c) 2012, Twisted Pair Development. All rights reserved.

twistedpairdevelopment.wordpress.com @twistedpairdev

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of the FreeBSD Project.