gsub_lite.h

Go to the documentation of this file.

/*
 *      gsub_lite.h
 *
 *      Graphics Subroutines (Lite) for ARToolKit.
 *
 *      Copyright (c) 2003-2007 Philip Lamb (PRL) phil@eden.net.nz. All rights reserved.
 *      
 *      Rev             Date            Who             Changes
 *  2.7.0   2003-08-13  PRL     Complete rewrite to ARToolKit-2.65 gsub.c API.
 *  2.7.1   2004-03-03  PRL             Avoid defining BOOL if already defined
 *      2.7.1   2004-03-03      PRL             Don't enable lighting if it was not enabled.
 *      2.7.2   2004-04-27      PRL             Added headerdoc markup. See http://developer.apple.com/darwin/projects/headerdoc/
 *      2.7.3   2004-07-02      PRL             Much more object-orientated through use of ARGL_CONTEXT_SETTINGS type.
 *      2.7.4   2004-07-14      PRL             Added gluCheckExtension hack for GLU versions pre-1.3.
 *      2.7.5   2004-07-15      PRL             Added arglDispImageStateful(); removed extraneous glPixelStorei(GL_UNPACK_IMAGE_HEIGHT,...) calls.
 *      2.7.6   2005-02-18      PRL             Go back to using int rather than BOOL, to avoid conflict with Objective-C.
 *      2.7.7   2005-07-26      PRL             Added cleanup routines for texture stuff.
 *      2.7.8   2005-07-29      PRL             Added distortion compensation enabling/disabling.
 *      2.7.9   2005-08-15      PRL             Added complete support for runtime selection of pixel format and rectangle/power-of-2 textures.
 *      2.8.0   2006-04-04      PRL             Move pixel format constants into toolkit global namespace (in config.h).
 *      2.8.1   2006-04-06      PRL             Move arglDrawMode, arglTexmapMode, arglTexRectangle out of global variables.
 *  2.8.2   2006-06-12  PRL             More stringent runtime GL caps checking. Fix zoom for DRAWPIXELS mode.
 *
 */
/*
 * 
 * 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
 * 
 */

#ifndef __gsub_lite_h__
#define __gsub_lite_h__

#ifdef __cplusplus
extern "C" {
#endif

// ============================================================================
//      Public includes.
// ============================================================================

#ifdef __APPLE__
#  include <OpenGL/gl.h>
#else
#  ifdef _WIN32
#    include <windows.h>
#  endif
#  include <GL/gl.h>
#endif
#include <AR/config.h>
#include <AR/ar.h>              // ARUint8, AR_PIXEL_FORMAT, arDebug, arImage.
#include <AR/param.h>   // ARParam, arParamDecompMat(), arParamObserv2Ideal()

// ============================================================================
//      Public types and definitions.
// ============================================================================

// Keep code nicely typed.
#ifndef TRUE
#  define TRUE 1
#endif
#ifndef FALSE
#  define FALSE 0
#endif

typedef struct _ARGL_CONTEXT_SETTINGS *ARGL_CONTEXT_SETTINGS_REF;

// ============================================================================
//      Public globals.
// ============================================================================

#if defined(__APPLE__)
extern int arglAppleClientStorage;
extern int arglAppleTextureRange;
#endif // __APPLE__
        
// ============================================================================
//      Public functions.
// ============================================================================
        
ARGL_CONTEXT_SETTINGS_REF arglSetupForCurrentContext(void);

void arglCleanup(ARGL_CONTEXT_SETTINGS_REF contextSettings);

void arglCameraFrustum(const ARParam *cparam, const double focalmin, const double focalmax, GLdouble m_projection[16]);

void arglCameraFrustumRH(const ARParam *cparam, const double focalmin, const double focalmax, GLdouble m_projection[16]);

void arglCameraView(const double para[3][4], GLdouble m_modelview[16], const double scale);

void arglCameraViewRH(const double para[3][4], GLdouble m_modelview[16], const double scale);

void arglDispImage(ARUint8 *image, const ARParam *cparam, const double zoom, ARGL_CONTEXT_SETTINGS_REF contextSettings);

void arglDispImageStateful(ARUint8 *image, const ARParam *cparam, const double zoom, ARGL_CONTEXT_SETTINGS_REF contextSettings);

int arglDistortionCompensationSet(ARGL_CONTEXT_SETTINGS_REF contextSettings, int enable);

int arglDistortionCompensationGet(ARGL_CONTEXT_SETTINGS_REF contextSettings, int *enable);

int arglPixelFormatSet(ARGL_CONTEXT_SETTINGS_REF contextSettings, AR_PIXEL_FORMAT format);

int arglPixelFormatGet(ARGL_CONTEXT_SETTINGS_REF contextSettings, AR_PIXEL_FORMAT *format, int *size);

void arglDrawModeSet(ARGL_CONTEXT_SETTINGS_REF contextSettings, const int mode);

int arglDrawModeGet(ARGL_CONTEXT_SETTINGS_REF contextSettings);

void arglTexmapModeSet(ARGL_CONTEXT_SETTINGS_REF contextSettings, const int mode);

int arglTexmapModeGet(ARGL_CONTEXT_SETTINGS_REF contextSettings);

void arglTexRectangleSet(ARGL_CONTEXT_SETTINGS_REF contextSettings, const int state);

int arglTexRectangleGet(ARGL_CONTEXT_SETTINGS_REF contextSettings);

#ifdef __cplusplus
}
#endif

#endif /* !__gsub_lite_h__ */