Update of /cvsroot/artoolkit/artoolkit/doc/gsub_lite
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv31612
Modified Files:
toc.html CompositePage.html gsub_lite.html
Log Message:
Update for run-time pixel format specification.
Index: toc.html
===================================================================
RCS file: /cvsroot/artoolkit/artoolkit/doc/gsub_lite/toc.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** toc.html 30 Jul 2005 01:10:16 -0000 1.3
--- toc.html 16 Aug 2005 00:49:33 -0000 1.4
***************
*** 24,27 ****
--- 24,29 ----
<nobr> <a href="Functions/Functions.html#//apple_ref/c/func/arglDistortionCompensationGet" target="doc">arglDistortionCompensationGet</a></nobr><br>
<nobr> <a href="Functions/Functions.html#//apple_ref/c/func/arglDistortionCompensationSet" target="doc">arglDistortionCompensationSet</a></nobr><br>
+ <nobr> <a href="Functions/Functions.html#//apple_ref/c/func/arglPixelFormatGet" target="doc">arglPixelFormatGet</a></nobr><br>
+ <nobr> <a href="Functions/Functions.html#//apple_ref/c/func/arglPixelFormatSet" target="doc">arglPixelFormatSet</a></nobr><br>
<nobr> <a href="Functions/Functions.html#//apple_ref/c/func/arglSetupForCurrentContext" target="doc">arglSetupForCurrentContext</a></nobr><br>
<h4><a href="DataTypes/DataTypes.html" target="doc">Defined Types
***************
*** 29,32 ****
--- 31,35 ----
<nobr> <a href="DataTypes/DataTypes.html#//apple_ref/c/tdef/ARGL_CONTEXT_SETTINGS_REF" target="doc">ARGL_CONTEXT_SETTINGS_REF</a></nobr><br>
+ <nobr> <a href="DataTypes/DataTypes.html#//apple_ref/c/tdef/ARGL_PIX_FORMAT" target="doc">ARGL_PIX_FORMAT</a></nobr><br>
<h4><a href="Vars/Vars.html" target="doc">Globals</a></h4>
Index: gsub_lite.html
===================================================================
RCS file: /cvsroot/artoolkit/artoolkit/doc/gsub_lite/gsub_lite.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** gsub_lite.html 30 Jul 2005 01:10:16 -0000 1.3
--- gsub_lite.html 16 Aug 2005 00:49:34 -0000 1.4
***************
*** 21,41 ****
ARToolKit, in the directory <AR/examples/simpleLite>.
<br><br>
! gsub_lite v2.7 was designed as a replacement for the original gsub from
! ARToolKit, by Mark Billinghurst (MB) & Hirokazu Kato (HK), with the
! following functionality removed: <br>
! - GLUT event handling. <br>
! - Sub-window ("MINIWIN") and half-size drawing. <br>
! - HMD support for stereo via stencil. <br>
! and the following functionality added or improved: <br>
! + Support for true stereo and multiple displays through removal
! of most dependencies on global variables. <br>
! + Prepared library for thread-safety by removing global variables. <br>
! + Optimised texturing, particularly for Mac OS X platform. <br>
! + Added arglCameraFrustum to replace argDraw3dCamera() function. <br>
! + Renamed argConvGlpara() to arglCameraView() to more accurately
! represent its functionality. <br>
! + Correctly handle textures with ARGB and ABGR byte ordering. <br>
! + Library setup and cleanup functions. <br>
! + Version numbering. <br>
<br><br>
This file is part of ARToolKit.
--- 21,60 ----
ARToolKit, in the directory <AR/examples/simpleLite>.
<br><br>
! 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.
! <br><br>
! gsub_lite also provides utility functions for setting the
! OpenGL viewing frustum and camera position based on ARToolKit-
! camera parameters and marker positions.
! <br><br>
! 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.
! <br><br>
! 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:
! <ul>
! <li> Support for true stereo and multiple displays through removal
! of most dependencies on global variables.
! <li> Prepared library for thread-safety by removing global variables.
! <li> Optimised texturing, particularly for Mac OS X platform.
! <li> Added arglCameraFrustum to replace argDraw3dCamera() function.
! <li> Renamed argConvGlpara() to arglCameraView() to more accurately
! represent its functionality.
! <li> Correctly handle textures with non-RGBA handling.
! <li> Library setup and cleanup functions.
! <li> Version numbering.
! </ul>
! It does however lack the following functionality from the original gsub
! library:
! <ul>
! <li> GLUT event handling.
! <li> Sub-window ("MINIWIN") and half-size drawing.
! <li> HMD support for stereo via stencil.
! </ul>
<br><br>
This file is part of ARToolKit.
Index: CompositePage.html
===================================================================
RCS file: /cvsroot/artoolkit/artoolkit/doc/gsub_lite/CompositePage.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** CompositePage.html 30 Jul 2005 01:09:48 -0000 1.3
--- CompositePage.html 16 Aug 2005 00:49:34 -0000 1.4
***************
*** 14,34 ****
ARToolKit, in the directory <AR/examples/simpleLite>.
<br><br>
! gsub_lite v2.7 was designed as a replacement for the original gsub from
! ARToolKit, by Mark Billinghurst (MB) & Hirokazu Kato (HK), with the
! following functionality removed: <br>
! - GLUT event handling. <br>
! - Sub-window ("MINIWIN") and half-size drawing. <br>
! - HMD support for stereo via stencil. <br>
! and the following functionality added or improved: <br>
! + Support for true stereo and multiple displays through removal
! of most dependencies on global variables. <br>
! + Prepared library for thread-safety by removing global variables. <br>
! + Optimised texturing, particularly for Mac OS X platform. <br>
! + Added arglCameraFrustum to replace argDraw3dCamera() function. <br>
! + Renamed argConvGlpara() to arglCameraView() to more accurately
! represent its functionality. <br>
! + Correctly handle textures with ARGB and ABGR byte ordering. <br>
! + Library setup and cleanup functions. <br>
! + Version numbering. <br>
<br><br>
This file is part of ARToolKit.
--- 14,53 ----
ARToolKit, in the directory <AR/examples/simpleLite>.
<br><br>
! 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.
! <br><br>
! gsub_lite also provides utility functions for setting the
! OpenGL viewing frustum and camera position based on ARToolKit-
! camera parameters and marker positions.
! <br><br>
! 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.
! <br><br>
! 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:
! <ul>
! <li> Support for true stereo and multiple displays through removal
! of most dependencies on global variables.
! <li> Prepared library for thread-safety by removing global variables.
! <li> Optimised texturing, particularly for Mac OS X platform.
! <li> Added arglCameraFrustum to replace argDraw3dCamera() function.
! <li> Renamed argConvGlpara() to arglCameraView() to more accurately
! represent its functionality.
! <li> Correctly handle textures with non-RGBA handling.
! <li> Library setup and cleanup functions.
! <li> Version numbering.
! </ul>
! It does however lack the following functionality from the original gsub
! library:
! <ul>
! <li> GLUT event handling.
! <li> Sub-window ("MINIWIN") and half-size drawing.
! <li> HMD support for stereo via stencil.
! </ul>
<br><br>
This file is part of ARToolKit.
***************
*** 72,75 ****
--- 91,100 ----
<dd>Set compensation for camera lens distortion in arglDispImage to off or on.
</dd>
+ <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/c/func/arglPixelFormatGet" target="_top">arglPixelFormatGet</a></tt></dt>
+ <dd>Get the format of pixel data in which arglDispImage*() is expecting data to be passed.
+ </dd>
+ <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/c/func/arglPixelFormatSet" target="_top">arglPixelFormatSet</a></tt></dt>
+ <dd>Set the format of pixel data which will be passed to arglDispImage*()
+ </dd>
<dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/c/func/arglSetupForCurrentContext" target="_top">arglSetupForCurrentContext</a></tt></dt>
<dd>Initialise the gsub_lite library for the current OpenGL context.
***************
*** 192,204 ****
pixels of the first row, followed immediately by the pixels of the second
row, and so on to the last byte of the image data, which corresponds to
! the last component of the bottom-right-most pixel.
! <br><br>
! In the current version of gsub_lite, the format of the pixels (i.e. the
! arrangement of components within each pixel) is fixed at the time the
! library is built, and cannot be changed at runtime. (It is determined by
! which of the possible AR_PIXEL_FORMAT_xxxx symbols was defined at the
! time the library was built.) Usually, image data is passed in directly
! from images generated by ARVideo, and so you should ensure that ARVideo
! is generating pixels of the same format.</dd>
<dt><code><i>cparam</i></code></dt><dd>Pointer to a set of ARToolKit camera parameters for the
current video source. The size of the source image is taken from the
--- 217,221 ----
pixels of the first row, followed immediately by the pixels of the second
row, and so on to the last byte of the image data, which corresponds to
! the last component of the bottom-right-most pixel.</dd>
<dt><code><i>cparam</i></code></dt><dd>Pointer to a set of ARToolKit camera parameters for the
current video source. The size of the source image is taken from the
***************
*** 287,291 ****
</dl>
</blockquote>
! <dl><dt><i>function result</i></dt><dd>TRUE if the distortion value was set, FALSE if an error occurred.
</dd>
<h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>By default, arglDispImage compensates for the distortion of the camera's
--- 304,308 ----
</dl>
</blockquote>
! <dl><dt><i>function result</i></dt><dd>TRUE if the distortion value was retreived, FALSE if an error occurred.
</dd>
<h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>By default, arglDispImage compensates for the distortion of the camera's
***************
*** 327,330 ****
--- 344,408 ----
</dd>
</dl>
+ <hr><!-- headerDoc=func; uid=//apple_ref/doc/compositePage/c/func/arglPixelFormatGet; name=arglPixelFormatGet -->
+ <a name="//apple_ref/doc/compositePage/c/func/arglPixelFormatGet"></a>
+ <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglPixelFormatGet">arglPixelFormatGet</a></h3>
+ </td></tr></table><hr><dl></dl><p>Get the format of pixel data in which arglDispImage*() is expecting data to be passed.
+ </p>
+ <blockquote><pre><!-- a logicalPath="//apple_ref/c/cl/int //apple_ref/c/cl/int //apple_ref/c/tdef/int //apple_ref/c/tag/int //apple_ref/c/econst/int //apple_ref/c/struct/int //apple_ref/c/clconst/int" --><font class="type">int</font><!-- /a --> <!-- a logicalPath="//apple_ref/c/instm/arglPixelFormatGet //apple_ref/c/clm/arglPixelFormatGet //apple_ref/c/intfcm/arglPixelFormatGet //apple_ref/c/func/arglPixelFormatGet //apple_ref/c/ftmplt/arglPixelFormatGet //apple_ref/c/defn/arglPixelFormatGet //apple_ref/c/macro/arglPixelFormatGet" --><font class="function">arglPixelFormatGet</font><!-- /a -->(
+ <!-- a logicalPath="//apple_ref/c/cl/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/cl/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/tdef/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/tag/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/econst/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/struct/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/clconst/ARGL_CONTEXT_SETTINGS_REF" --><font class="type">ARGL_CONTEXT_SETTINGS_REF</font><!-- /a --> <font class="param">contextSettings</font>,
+ <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT //apple_ref/c/cl/ARGL_PIX_FORMAT //apple_ref/c/tdef/ARGL_PIX_FORMAT //apple_ref/c/tag/ARGL_PIX_FORMAT //apple_ref/c/econst/ARGL_PIX_FORMAT //apple_ref/c/struct/ARGL_PIX_FORMAT //apple_ref/c/clconst/ARGL_PIX_FORMAT" --><font class="type">ARGL_PIX_FORMAT</font><!-- /a --> *<font class="param">format</font>,
+ <!-- a logicalPath="//apple_ref/c/cl/int //apple_ref/c/cl/int //apple_ref/c/tdef/int //apple_ref/c/tag/int //apple_ref/c/econst/int //apple_ref/c/struct/int //apple_ref/c/clconst/int" --><font class="type">int</font><!-- /a --> *<font class="param">size</font>); </pre></blockquote>
+ <h5><font face="Lucida Grande,Helvetica,Arial">Parameter Descriptions</font></h5>
+ <blockquote>
+ <dl>
+ <dt><code><i>contextSettings</i></code></dt><dd>A reference to ARGL's settings for the current OpenGL
+ context, as returned by arglSetupForCurrentContext() for this context.</dd>
+ <dt><code><i>format</i></code></dt><dd>A symbolic constant for the pixel format in use. See
+ <!-- a logicalPath="//apple_ref/c/tdef/ARGL_PIX_FORMAT" -->ARGL_PIX_FORMAT <!-- /a --> for a list of all possible formats.</dd>
+ <dt><code><i>size</i></code></dt><dd>The number of bytes of memory occupied per pixel, for the given format.</dd>
+ </dl>
+ </blockquote>
+ <dl><dt><i>function result</i></dt><dd>TRUE if the pixel format and size values were retreived, FALSE if an error occurred.
+ </dd>
+ <h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>This function enquires as to the current format of pixel data being
+ expected by the arglDispImage*() functions. The default format is determined by
+ which of the possible AR_PIXEL_FORMAT_xxxx symbols was defined at the time the
+ library was built.
+ </p>
+ <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.71.
+ </dd>
+ </dl>
+ <hr><!-- headerDoc=func; uid=//apple_ref/doc/compositePage/c/func/arglPixelFormatSet; name=arglPixelFormatSet -->
+ <a name="//apple_ref/doc/compositePage/c/func/arglPixelFormatSet"></a>
+ <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglPixelFormatSet">arglPixelFormatSet</a></h3>
+ </td></tr></table><hr><dl></dl><p>Set the format of pixel data which will be passed to arglDispImage*()
+ </p>
+ <blockquote><pre><!-- a logicalPath="//apple_ref/c/cl/int //apple_ref/c/cl/int //apple_ref/c/tdef/int //apple_ref/c/tag/int //apple_ref/c/econst/int //apple_ref/c/struct/int //apple_ref/c/clconst/int" --><font class="type">int</font><!-- /a --> <!-- a logicalPath="//apple_ref/c/instm/arglPixelFormatSet //apple_ref/c/clm/arglPixelFormatSet //apple_ref/c/intfcm/arglPixelFormatSet //apple_ref/c/func/arglPixelFormatSet //apple_ref/c/ftmplt/arglPixelFormatSet //apple_ref/c/defn/arglPixelFormatSet //apple_ref/c/macro/arglPixelFormatSet" --><font class="function">arglPixelFormatSet</font><!-- /a -->(
+ <!-- a logicalPath="//apple_ref/c/cl/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/cl/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/tdef/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/tag/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/econst/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/struct/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/clconst/ARGL_CONTEXT_SETTINGS_REF" --><font class="type">ARGL_CONTEXT_SETTINGS_REF</font><!-- /a --> <font class="param">contextSettings</font>,
+ <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT //apple_ref/c/cl/ARGL_PIX_FORMAT //apple_ref/c/tdef/ARGL_PIX_FORMAT //apple_ref/c/tag/ARGL_PIX_FORMAT //apple_ref/c/econst/ARGL_PIX_FORMAT //apple_ref/c/struct/ARGL_PIX_FORMAT //apple_ref/c/clconst/ARGL_PIX_FORMAT" --><font class="type">ARGL_PIX_FORMAT</font><!-- /a --> <font class="param">format</font>); </pre></blockquote>
+ <h5><font face="Lucida Grande,Helvetica,Arial">Parameter Descriptions</font></h5>
+ <blockquote>
+ <dl>
+ <dt><code><i>contextSettings</i></code></dt><dd>A reference to ARGL's settings for the current OpenGL
+ context, as returned by arglSetupForCurrentContext() for this context.</dd>
+ <dt><code><i>format</i></code></dt><dd>A symbolic constant for the pixel format being set. See
+ <!-- a logicalPath="//apple_ref/c/tdef/ARGL_PIX_FORMAT" -->ARGL_PIX_FORMAT <!-- /a --> for a list of all possible formats.</dd>
+ </dl>
+ </blockquote>
+ <dl><dt><i>function result</i></dt><dd>TRUE if the pixel format value was set, FALSE if an error occurred.
+ </dd>
+ <h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>(description)
+ In gsub_lite, the format of the pixels (i.e. the arrangement of components
+ within each pixel) can be changed at runtime. Use this function to inform
+ gsub_lite the format the pixels being passed to arglDispImage*() functions
+ are in. This setting applies only to the context passed in parameter
+ contextSettings. The default format is determined by which of the possible
+ AR_PIXEL_FORMAT_xxxx symbols was defined at the time the library was built.
+ Usually, image data is passed in directly from images generated by ARVideo,
+ and so you should ensure that ARVideo is generating pixels of the same format.
+ </p>
+ <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.71.
+ </dd>
+ </dl>
<hr><!-- headerDoc=func; uid=//apple_ref/doc/compositePage/c/func/arglSetupForCurrentContext; name=arglSetupForCurrentContext -->
<a name="//apple_ref/doc/compositePage/c/func/arglSetupForCurrentContext"></a>
***************
*** 382,385 ****
--- 460,522 ----
</dd>
</dl>
+ <hr><!-- headerDoc=tdef; uid=//apple_ref/doc/compositePage/c/tdef/ARGL_PIX_FORMAT; name=ARGL_PIX_FORMAT -->
+ <a name="//apple_ref/doc/compositePage/c/tdef/ARGL_PIX_FORMAT"></a>
+ <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="ARGL_PIX_FORMAT">ARGL_PIX_FORMAT</a></h3>
+ </td></tr></table><hr><dl></dl><p>ARToolKit pixel-format specifiers.
+ </p>
+ <blockquote><pre><font class="keyword">typedef</font> <font class="keyword">enum</font> {
+ <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_RGBA //apple_ref/c/cl/ARGL_PIX_FORMAT_RGBA //apple_ref/c/tdef/ARGL_PIX_FORMAT_RGBA //apple_ref/c/tag/ARGL_PIX_FORMAT_RGBA //apple_ref/c/econst/ARGL_PIX_FORMAT_RGBA //apple_ref/c/struct/ARGL_PIX_FORMAT_RGBA //apple_ref/c/clconst/ARGL_PIX_FORMAT_RGBA" --><font class="type">ARGL_PIX_FORMAT_RGBA</font><!-- /a --> = <font class="number">1</font>,
+ <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_ABGR //apple_ref/c/cl/ARGL_PIX_FORMAT_ABGR //apple_ref/c/tdef/ARGL_PIX_FORMAT_ABGR //apple_ref/c/tag/ARGL_PIX_FORMAT_ABGR //apple_ref/c/econst/ARGL_PIX_FORMAT_ABGR //apple_ref/c/struct/ARGL_PIX_FORMAT_ABGR //apple_ref/c/clconst/ARGL_PIX_FORMAT_ABGR" --><font class="type">ARGL_PIX_FORMAT_ABGR</font><!-- /a --> = <font class="number">2</font>,
+ <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_BGRA //apple_ref/c/cl/ARGL_PIX_FORMAT_BGRA //apple_ref/c/tdef/ARGL_PIX_FORMAT_BGRA //apple_ref/c/tag/ARGL_PIX_FORMAT_BGRA //apple_ref/c/econst/ARGL_PIX_FORMAT_BGRA //apple_ref/c/struct/ARGL_PIX_FORMAT_BGRA //apple_ref/c/clconst/ARGL_PIX_FORMAT_BGRA" --><font class="type">ARGL_PIX_FORMAT_BGRA</font><!-- /a --> = <font class="number">3</font>,
+ <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_ARGB //apple_ref/c/cl/ARGL_PIX_FORMAT_ARGB //apple_ref/c/tdef/ARGL_PIX_FORMAT_ARGB //apple_ref/c/tag/ARGL_PIX_FORMAT_ARGB //apple_ref/c/econst/ARGL_PIX_FORMAT_ARGB //apple_ref/c/struct/ARGL_PIX_FORMAT_ARGB //apple_ref/c/clconst/ARGL_PIX_FORMAT_ARGB" --><font class="type">ARGL_PIX_FORMAT_ARGB</font><!-- /a --> = <font class="number">4</font>,
+ <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_RGB //apple_ref/c/cl/ARGL_PIX_FORMAT_RGB //apple_ref/c/tdef/ARGL_PIX_FORMAT_RGB //apple_ref/c/tag/ARGL_PIX_FORMAT_RGB //apple_ref/c/econst/ARGL_PIX_FORMAT_RGB //apple_ref/c/struct/ARGL_PIX_FORMAT_RGB //apple_ref/c/clconst/ARGL_PIX_FORMAT_RGB" --><font class="type">ARGL_PIX_FORMAT_RGB</font><!-- /a --> = <font class="number">5</font>,
+ <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_BGR //apple_ref/c/cl/ARGL_PIX_FORMAT_BGR //apple_ref/c/tdef/ARGL_PIX_FORMAT_BGR //apple_ref/c/tag/ARGL_PIX_FORMAT_BGR //apple_ref/c/econst/ARGL_PIX_FORMAT_BGR //apple_ref/c/struct/ARGL_PIX_FORMAT_BGR //apple_ref/c/clconst/ARGL_PIX_FORMAT_BGR" --><font class="type">ARGL_PIX_FORMAT_BGR</font><!-- /a --> = <font class="number">6</font>,
+ <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_2vuy //apple_ref/c/cl/ARGL_PIX_FORMAT_2vuy //apple_ref/c/tdef/ARGL_PIX_FORMAT_2vuy //apple_ref/c/tag/ARGL_PIX_FORMAT_2vuy //apple_ref/c/econst/ARGL_PIX_FORMAT_2vuy //apple_ref/c/struct/ARGL_PIX_FORMAT_2vuy //apple_ref/c/clconst/ARGL_PIX_FORMAT_2vuy" --><font class="type">ARGL_PIX_FORMAT_2vuy</font><!-- /a --> = <font class="number">7</font>,
+ <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_UYVY //apple_ref/c/cl/ARGL_PIX_FORMAT_UYVY //apple_ref/c/tdef/ARGL_PIX_FORMAT_UYVY //apple_ref/c/tag/ARGL_PIX_FORMAT_UYVY //apple_ref/c/econst/ARGL_PIX_FORMAT_UYVY //apple_ref/c/struct/ARGL_PIX_FORMAT_UYVY //apple_ref/c/clconst/ARGL_PIX_FORMAT_UYVY" --><font class="type">ARGL_PIX_FORMAT_UYVY</font><!-- /a --> = <font class="var">ARGL_PIX_FORMAT_2vuy</font>,
+ <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_yuvs //apple_ref/c/cl/ARGL_PIX_FORMAT_yuvs //apple_ref/c/tdef/ARGL_PIX_FORMAT_yuvs //apple_ref/c/tag/ARGL_PIX_FORMAT_yuvs //apple_ref/c/econst/ARGL_PIX_FORMAT_yuvs //apple_ref/c/struct/ARGL_PIX_FORMAT_yuvs //apple_ref/c/clconst/ARGL_PIX_FORMAT_yuvs" --><font class="type">ARGL_PIX_FORMAT_yuvs</font><!-- /a --> = <font class="number">8</font>,
+ <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_YUY2 //apple_ref/c/cl/ARGL_PIX_FORMAT_YUY2 //apple_ref/c/tdef/ARGL_PIX_FORMAT_YUY2 //apple_ref/c/tag/ARGL_PIX_FORMAT_YUY2 //apple_ref/c/econst/ARGL_PIX_FORMAT_YUY2 //apple_ref/c/struct/ARGL_PIX_FORMAT_YUY2 //apple_ref/c/clconst/ARGL_PIX_FORMAT_YUY2" --><font class="type">ARGL_PIX_FORMAT_YUY2</font><!-- /a --> = <font class="var">ARGL_PIX_FORMAT_yuvs</font>,
+ } <font class="var">ARGL_PIX_FORMAT</font>; </pre></blockquote>
+ <h5><font face="Lucida Grande,Helvetica,Arial">Constants</font></h5>
+ <blockquote>
+ <dl>
+ <dt><code>ARGL_PIX_FORMAT_RGBA</code></dt><dd>Each pixel is represented by 32 bits. Eight bits per each Red, Green,
+ Blue, and Alpha component.</dd>
+ <dt><code>ARGL_PIX_FORMAT_ABGR</code></dt><dd>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.</dd>
+ <dt><code>ARGL_PIX_FORMAT_BGRA</code></dt><dd>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.</dd>
+ <dt><code>ARGL_PIX_FORMAT_ARGB</code></dt><dd>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.</dd>
+ <dt><code>ARGL_PIX_FORMAT_RGB</code></dt><dd>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.</dd>
+ <dt><code>ARGL_PIX_FORMAT_BGR</code></dt><dd>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.</dd>
+ <dt><code>ARGL_PIX_FORMAT_2vuy</code></dt><dd>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
+ chroma components. Each pair of pixels shares a common set of chroma
+ values. The components are ordered in memory; Cb, Y0, Cr, Y1. The
+ luminance components have a range of [16, 235], while the chroma value
+ has a range of [16, 240]. This is consistent with the CCIR601 spec.
+ This format is fairly prevalent on both Mac and Win32 platforms.
+ '2vuy' is the Apple QuickTime four-character code for this pixel format.
+ The equivalent Microsoft fourCC is 'UYVY'.</dd>
+ <dt><code>ARGL_PIX_FORMAT_yuvs</code></dt><dd>8-bit 4:2:2 Component Y'CbCr format. Identical to the ARGL_PIX_FORMAT_2vuy except
+ each 16 bit word has been byte swapped. This results in a component
+ ordering of; Y0, Cb, Y1, Cr.
+ This is most prevalent yuv 4:2:2 format on both Mac and Win32 platforms.
+ 'yuvs' is the Apple QuickTime four-character code for this pixel format.
+ The equivalent Microsoft fourCC is 'YUY2'.</dd>
+ </dl>
+ </blockquote>
+ <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>ARToolKit functions can accept pixel data in a variety of formats.
+ This enumerations provides a set of constants you can use to request
+ data in a particular pixel format from an ARToolKit function that
+ returns data to you, or to specify that data you are providing to an
+ ARToolKit function is in a particular pixel format.
+ </p>
+ </dl>
<h2>Globals</h2>
<hr><!-- headerDoc=data; uid=//apple_ref/doc/compositePage/c/data/arglDrawMode; name=arglDrawMode -->
***************
*** 437,446 ****
use of rectangluar textures. A value of FALSE specifies the use of ordinary textures.
<br><br>
! If gsub_lite was not built without support for rectangular textures, changing the
! value of this variable will have no effect, and ordinary textures will always be
! used. Support for rectangular textures is only available when gsub_lite is built
! with AR_OPENGL_TEXTURE_RECTANGLE defined in <AR/config.h> and with either
! GL_EXT_texture_rectangle or GL_NV_texture_rectangle defined in <GL/glext.h>
! or <GL/gl.h>
</p>
<dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.68.
--- 574,580 ----
use of rectangluar textures. A value of FALSE specifies the use of ordinary textures.
<br><br>
! 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.
</p>
<dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.68.
|