|
From: Philip L. <phi...@us...> - 2006-05-22 22:17:56
|
Update of /cvsroot/artoolkit/artoolkit/include/AR In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv31373 Modified Files: gsub_lite.h ar.h video.h Log Message: Copyright date and documentation update. Index: video.h =================================================================== RCS file: /cvsroot/artoolkit/artoolkit/include/AR/video.h,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -d -r1.5 -r1.6 *** video.h 20 Oct 2005 19:56:03 -0000 1.5 --- video.h 22 May 2006 22:17:53 -0000 1.6 *************** *** 1,4 **** /* -------------------------------------------------------------------------- ! * Copyright (c) 2004-2005 Philip Lamb (PRL) ph...@ed.... All rights reserved. * This file is part of ARToolKit. * --- 1,4 ---- /* -------------------------------------------------------------------------- ! * Copyright (c) 2004-2006 Philip Lamb (PRL) ph...@ed.... All rights reserved. * This file is part of ARToolKit. * Index: ar.h =================================================================== RCS file: /cvsroot/artoolkit/artoolkit/include/AR/ar.h,v retrieving revision 1.7 retrieving revision 1.8 diff -C2 -d -r1.7 -r1.8 *** ar.h 5 Apr 2006 05:48:43 -0000 1.7 --- ar.h 22 May 2006 22:17:53 -0000 1.8 *************** *** 1,4 **** /* -------------------------------------------------------------------------- ! * Copyright (c) 20042-2005 HIT Lab NZ. * The distribution policy is described in the file COPYING.txt furnished * with this library. --- 1,4 ---- /* -------------------------------------------------------------------------- ! * Copyright (c) 20042-2006 HIT Lab NZ. * The distribution policy is described in the file COPYING.txt furnished * with this library. *************** *** 81,106 **** ARToolKit function is in a particular pixel format. ! \var AR_PIXEL_FORMAT_RGB Each pixel is represented by 24 bits. Eight bits per each Red, Green, and Blue component. This is the native 24 bit format for the Mac platform. ! \var AR_PIXEL_FORMAT_BGR Each pixel is represented by 24 bits. Eight bits per each Blue, Red, and Green component. This is the native 24 bit format for the Win32 platform. ! \var AR_PIXEL_FORMAT_RGBA Each pixel is represented by 32 bits. Eight bits per each Red, Green, Blue, and Alpha component. ! \var AR_PIXEL_FORMAT_BGRA Each pixel is represented by 32 bits. Eight bits per each Blue, Green, Red, and Alpha component. This is the native 32 bit format for the Win32 platform. ! \var AR_PIXEL_FORMAT_ABGR Each pixel is represented by 32 bits. Eight bits per each Alpha, Blue, Green, and Red component. This is the native 32 bit format for the SGI platform. ! \var AR_PIXEL_FORMAT_ARGB Each pixel is represented by 32 bits. Eight bits per each Alpha, Red, Green, and Blue component. This is the native 32 bit format for the Mac platform. ! \var AR_PIXEL_FORMAT_2vuy 8-bit 4:2:2 Component Y'CbCr format. Each 16 bit pixel is represented by an unsigned eight bit luminance component and two unsigned eight bit --- 81,112 ---- ARToolKit function is in a particular pixel format. ! AR_PIXEL_FORMAT_RGB Each pixel is represented by 24 bits. Eight bits per each Red, Green, and Blue component. This is the native 24 bit format for the Mac platform. ! ! AR_PIXEL_FORMAT_BGR Each pixel is represented by 24 bits. Eight bits per each Blue, Red, and Green component. This is the native 24 bit format for the Win32 platform. ! ! AR_PIXEL_FORMAT_RGBA Each pixel is represented by 32 bits. Eight bits per each Red, Green, Blue, and Alpha component. ! ! AR_PIXEL_FORMAT_BGRA Each pixel is represented by 32 bits. Eight bits per each Blue, Green, Red, and Alpha component. This is the native 32 bit format for the Win32 platform. ! ! AR_PIXEL_FORMAT_ABGR Each pixel is represented by 32 bits. Eight bits per each Alpha, Blue, Green, and Red component. This is the native 32 bit format for the SGI platform. ! ! AR_PIXEL_FORMAT_ARGB Each pixel is represented by 32 bits. Eight bits per each Alpha, Red, Green, and Blue component. This is the native 32 bit format for the Mac platform. ! ! AR_PIXEL_FORMAT_2vuy 8-bit 4:2:2 Component Y'CbCr format. Each 16 bit pixel is represented by an unsigned eight bit luminance component and two unsigned eight bit *************** *** 112,116 **** '2vuy' is the Apple QuickTime four-character code for this pixel format. The equivalent Microsoft fourCC is 'UYVY'. ! \var AR_PIXEL_FORMAT_yuvs 8-bit 4:2:2 Component Y'CbCr format. Identical to the AR_PIXEL_FORMAT_2vuy except each 16 bit word has been byte swapped. This results in a component --- 118,123 ---- '2vuy' is the Apple QuickTime four-character code for this pixel format. The equivalent Microsoft fourCC is 'UYVY'. ! ! AR_PIXEL_FORMAT_yuvs 8-bit 4:2:2 Component Y'CbCr format. Identical to the AR_PIXEL_FORMAT_2vuy except each 16 bit word has been byte swapped. This results in a component Index: gsub_lite.h =================================================================== RCS file: /cvsroot/artoolkit/artoolkit/include/AR/gsub_lite.h,v retrieving revision 1.10 retrieving revision 1.11 diff -C2 -d -r1.10 -r1.11 *** gsub_lite.h 21 Apr 2006 04:35:13 -0000 1.10 --- gsub_lite.h 22 May 2006 22:17:53 -0000 1.11 *************** *** 4,8 **** * Graphics Subroutines (Lite) for ARToolKit. * ! * Copyright (c) 2003-2005 Philip Lamb (PRL) ph...@ed.... All rights reserved. * * Rev Date Who Changes --- 4,8 ---- * Graphics Subroutines (Lite) for ARToolKit. * ! * Copyright (c) 2003-2006 Philip Lamb (PRL) ph...@ed.... All rights reserved. * * Rev Date Who Changes *************** *** 109,114 **** Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ! @copyright 2003-2005 Philip Lamb ! @updated 2005-07-29 */ --- 109,114 ---- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ! @copyright 2003-2006 Philip Lamb ! @updated 2006-05-23 */ *************** *** 133,137 **** #endif #include <AR/config.h> ! #include <AR/ar.h> // ARUint8 #include <AR/param.h> // ARParam, arParamDecompMat(), arParamObserv2Ideal() --- 133,137 ---- #endif #include <AR/config.h> ! #include <AR/ar.h> // ARUint8, AR_PIXEL_FORMAT #include <AR/param.h> // ARParam, arParamDecompMat(), arParamObserv2Ideal() *************** *** 188,192 **** /*! ! @function arglSetupForCurrentContext @abstract Initialise the gsub_lite library for the current OpenGL context. @discussion --- 188,192 ---- /*! ! @function @abstract Initialise the gsub_lite library for the current OpenGL context. @discussion *************** *** 211,215 **** /*! ! @function arglCleanup @abstract Free memory used by gsub_lite associated with the specified context. @discussion --- 211,215 ---- /*! ! @function @abstract Free memory used by gsub_lite associated with the specified context. @discussion *************** *** 226,230 **** /*! ! @function arglCameraFrustum @abstract Create an OpenGL perspective projection matrix. @discussion --- 226,230 ---- /*! ! @function @abstract Create an OpenGL perspective projection matrix. @discussion *************** *** 259,263 **** /*! ! @function arglCameraView @abstract Create an OpenGL viewing transformation matrix. @discussion --- 259,263 ---- /*! ! @function @abstract Create an OpenGL viewing transformation matrix. @discussion *************** *** 280,284 **** /*! ! @function arglDispImage @abstract Display an ARVideo image, by drawing it using OpenGL. @discussion --- 280,284 ---- /*! ! @function @abstract Display an ARVideo image, by drawing it using OpenGL. @discussion *************** *** 333,337 **** /*! ! @function arglDispImageStateful @abstract Display an ARVideo image, by drawing it using OpenGL, using and modifying current OpenGL state. @discussion --- 333,337 ---- /*! ! @function @abstract Display an ARVideo image, by drawing it using OpenGL, using and modifying current OpenGL state. @discussion *************** *** 355,359 **** /*! ! @function arglDistortionCompensationSet @abstract Set compensation for camera lens distortion in arglDispImage to off or on. @discussion --- 355,359 ---- /*! ! @function @abstract Set compensation for camera lens distortion in arglDispImage to off or on. @discussion *************** *** 376,380 **** /*! ! @function arglDistortionCompensationGet @abstract Enquire as to the enable state of camera lens distortion compensation in arglDispImage. @discussion --- 376,380 ---- /*! ! @function @abstract Enquire as to the enable state of camera lens distortion compensation in arglDispImage. @discussion *************** *** 392,396 **** /*! ! @function arglPixelFormatSet @abstract Set the format of pixel data which will be passed to arglDispImage*() @discussion (description) --- 392,396 ---- /*! ! @function @abstract Set the format of pixel data which will be passed to arglDispImage*() @discussion (description) *************** *** 406,410 **** context, as returned by arglSetupForCurrentContext() for this context. @param format A symbolic constant for the pixel format being set. See ! @link AR_PIXEL_FORMAT AR_PIXEL_FORMAT @/link for a list of all possible formats. @result TRUE if the pixel format value was set, FALSE if an error occurred. @availability First appeared in ARToolKit 2.71. --- 406,410 ---- context, as returned by arglSetupForCurrentContext() for this context. @param format A symbolic constant for the pixel format being set. See ! AR_PIXEL_FORMAT in ar.h for a list of all possible formats. @result TRUE if the pixel format value was set, FALSE if an error occurred. @availability First appeared in ARToolKit 2.71. *************** *** 413,417 **** /*! ! @function arglPixelFormatGet @abstract Get the format of pixel data in which arglDispImage*() is expecting data to be passed. @discussion This function enquires as to the current format of pixel data being --- 413,417 ---- /*! ! @function @abstract Get the format of pixel data in which arglDispImage*() is expecting data to be passed. @discussion This function enquires as to the current format of pixel data being *************** *** 421,425 **** context, as returned by arglSetupForCurrentContext() for this context. @param format A symbolic constant for the pixel format in use. See ! @link AR_PIXEL_FORMAT AR_PIXEL_FORMAT @/link for a list of all possible formats. @param size The number of bytes of memory occupied per pixel, for the given format. @result TRUE if the pixel format and size values were retreived, FALSE if an error occurred. --- 421,425 ---- context, as returned by arglSetupForCurrentContext() for this context. @param format A symbolic constant for the pixel format in use. See ! AR_PIXEL_FORMAT in ar.h for a list of all possible formats. @param size The number of bytes of memory occupied per pixel, for the given format. @result TRUE if the pixel format and size values were retreived, FALSE if an error occurred. *************** *** 430,440 **** /*! @function ! @abstract Set method by which arglDispImage() transfers pixels. @discussion ! The value of this setting determines the method by which ! arglDispImage transfers pixels of an image to the display. Setting this ! variable to a value of AR_DRAW_BY_GL_DRAW_PIXELS specifies the use of OpenGL ! DrawPixels to do the transfer. Setting this variable to a value of ! AR_DRAW_BY_TEXTURE_MAPPING specifies the use of OpenGL TexImage2D to do the transfer. The DrawPixels method is guaranteed to be available on all implementations, but arglDispImage does not correct the image --- 430,440 ---- /*! @function ! @abstract Set method by which arglDispImage() will transfer pixels. @discussion ! This setting determines the method by which arglDispImage transfers pixels ! of an image to OpenGL for display. Setting this ! variable to a value of AR_DRAW_BY_GL_DRAW_PIXELS specifies the use of the ! OpenGL DrawPixels functions to do the transfer. Setting this variable to a value of ! AR_DRAW_BY_TEXTURE_MAPPING specifies the use of OpenGL TexImage2D functions to do the transfer. The DrawPixels method is guaranteed to be available on all implementations, but arglDispImage does not correct the image *************** *** 445,451 **** The initial value is AR_DRAW_BY_TEXTURE_MAPPING. ! @availability First appeared in ARToolKit 2.68. */ void arglDrawModeSet(ARGL_CONTEXT_SETTINGS_REF contextSettings, const int mode); int arglDrawModeGet(ARGL_CONTEXT_SETTINGS_REF contextSettings); --- 445,461 ---- The initial value is AR_DRAW_BY_TEXTURE_MAPPING. ! @availability First appeared in ARToolKit 2.72. */ void arglDrawModeSet(ARGL_CONTEXT_SETTINGS_REF contextSettings, const int mode); + + /*! + @function + @abstract Get method by which arglDispImage() is transfering pixels. + @discussion + Enquires as to the current method by which arglDispImage() is + transferring pixels to OpenGL for display. See arglDrawModeSet() for + more information. + @availability First appeared in ARToolKit 2.72. + */ int arglDrawModeGet(ARGL_CONTEXT_SETTINGS_REF contextSettings); *************** *** 454,461 **** @abstract Determines use of full or half-resolution TexImage2D pixel-transfer in arglDispImage(). @discussion ! When arglDrawModeSet(AR_DRAW_BY_TEXTURE_MAPPING) has been called, the value of this setting ! determines whether full or half-resolution data is transferred to the ! texture. A value of AR_DRAW_TEXTURE_FULL_IMAGE uses all available pixels in the ! source image data. A value of AR_DRAW_TEXTURE_HALF_IMAGE discards every second row in the source image data, defining a half-height texture which is then drawn stretched vertically to double its height. --- 464,472 ---- @abstract Determines use of full or half-resolution TexImage2D pixel-transfer in arglDispImage(). @discussion ! When arglDrawModeSet(AR_DRAW_BY_TEXTURE_MAPPING) has been called, the value of this ! setting determines whether full or half-resolution data is transferred to the ! texture. Calling this function with a mode value of AR_DRAW_TEXTURE_FULL_IMAGE ! uses all available pixels in the source image data. A value of ! AR_DRAW_TEXTURE_HALF_IMAGE discards every second row in the source image data, defining a half-height texture which is then drawn stretched vertically to double its height. *************** *** 465,471 **** The initial value is AR_DRAW_TEXTURE_FULL_IMAGE. ! @availability First appeared in ARToolKit 2.68. */ void arglTexmapModeSet(ARGL_CONTEXT_SETTINGS_REF contextSettings, const int mode); int arglTexmapModeGet(ARGL_CONTEXT_SETTINGS_REF contextSettings); --- 476,491 ---- The initial value is AR_DRAW_TEXTURE_FULL_IMAGE. ! @availability First appeared in ARToolKit 2.72. */ void arglTexmapModeSet(ARGL_CONTEXT_SETTINGS_REF contextSettings, const int mode); + + /*! + @function + @abstract Enquire whether full or half-resolution TexImage2D pixel-transfer is being used in arglDispImage(). + @discussion + Enquires as to the current value of the TexmapMode setting. See arglTexmapModeSet() + for more info. + @availability First appeared in ARToolKit 2.72. + */ int arglTexmapModeGet(ARGL_CONTEXT_SETTINGS_REF contextSettings); *************** *** 481,489 **** If the OpenGL driver available at runtime does not support for rectangular textures, ! changing the value of this variable to TRUE will result calls to arglDispImage performing no drawing. ! @availability First appeared in ARToolKit 2.68. */ void arglTexRectangleSet(ARGL_CONTEXT_SETTINGS_REF contextSettings, const int state); int arglTexRectangleGet(ARGL_CONTEXT_SETTINGS_REF contextSettings); --- 501,518 ---- If the OpenGL driver available at runtime does not support for rectangular textures, ! changing the value of this setting to TRUE will result calls to arglDispImage performing no drawing. ! @availability First appeared in ARToolKit 2.72. */ void arglTexRectangleSet(ARGL_CONTEXT_SETTINGS_REF contextSettings, const int state); + + /*! + @function + @abstract Enquire as to use of rectangular TexImage2D pixel-transfer in arglDispImage(). + @discussion + Enquires as to the current value of the TexRectangle setting. See arglTexRectangleSet() + for more info. + @availability First appeared in ARToolKit 2.72. + */ int arglTexRectangleGet(ARGL_CONTEXT_SETTINGS_REF contextSettings); |
