API Documentation

# gsub_lite

A collection of useful OpenGL routines for ARToolKit.

Updated: June 23, 2006
Includes: <AR/config.h>, <AR/ar.h>, <AR/param.h>

Sample code for example usage of gsub_lite is included with ARToolKit, in the directory <AR/examples/simpleLite>.
gsub_lite is the preferred means for drawing camera video images acquired from ARToolKit's video libraries. It includes optimized texture handling, and a variety of flexible drawing options.
gsub_lite also provides utility functions for setting the OpenGL viewing frustum and camera position based on ARToolKit- camera parameters and marker positions.
gsub_lite does not depend on GLUT, or indeed, any particular window or event handling system. It is therefore well suited to use in applications which have their own window and event handling code.
gsub_lite v2.7 is intended as a replacement for gsub from ARToolKit 2.65, by Mark Billinghurst (MB) & Hirokazu Kato (HK), with the following additional functionality:

- Support for true stereo and multiple displays through removal of most dependencies on global variables.
- Prepared library for thread-safety by removing global variables.
- Optimised texturing, particularly for Mac OS X platform.
- Added arglCameraFrustum to replace argDraw3dCamera() function.
- Renamed argConvGlpara() to arglCameraView() to more accurately represent its functionality.
- Correctly handle textures with non-RGBA handling.
- Library setup and cleanup functions.
- Version numbering.

It does however lack the following functionality from the original gsub library:

- GLUT event handling.
- Sub-window ("MINIWIN") and half-size drawing.
- HMD support for stereo via stencil.

This file is part of ARToolKit.
ARToolKit is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
ARToolKit is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with ARToolKit; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

© 2003-2007 Philip Lamb (Last Updated June 23, 2006)
HTML documentation generated by HeaderDoc