 |
| Home |
| About |
| Downloads |
| Documentation |
| Contact |
| Forums |
| Trackers |
 |
Documentation
The main source for documentation is the OpenGI Programming Guide, that is also contained in the download packages. It is recommended to read this guide in order to become acquainted with OpenGI. It thoroughly describes every function in a logical order with all its possible problems and pitfalls and can therefore also be treated as a reference and a troubleshooting guide.
For quickly looking up a function signature or the meaning of a constant there is also a Doxygen generated documentation online.
This only documents the public API and no internal functions or data structures. A Doxyfile for generating the full developer documentation, with all internal structures and functions documented, is contained in the source distribution, as it is actually only interesting for people modifying the source code.
The source distribution also contains a small example application demonstrating the typical use of the major OpenGI functions.