[artoolkit-commits] artoolkit/doc/gsub_lite/Functions Functions.html,1.5,1.6
Optical marker tracking and overlay for augmented reality.
Brought to you by:
philip_lamb
Menu
▾
▴
[artoolkit-commits] artoolkit/doc/gsub_lite/Functions Functions.html,1.5,1.6
|
From: Philip L. <phi...@us...> - 2006-05-22 23:03:25
|
Update of /cvsroot/artoolkit/artoolkit/doc/gsub_lite/Functions In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv16483/gsub_lite/Functions Modified Files: Functions.html Log Message: Refresh documentation. Index: Functions.html =================================================================== RCS file: /cvsroot/artoolkit/artoolkit/doc/gsub_lite/Functions/Functions.html,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -d -r1.5 -r1.6 *** Functions.html 27 Apr 2006 18:52:45 -0000 1.5 --- Functions.html 22 May 2006 23:03:19 -0000 1.6 *************** *** 30,35 **** <dd>Set compensation for camera lens distortion in arglDispImage to off or on. </dd> <dt><tt><a href="Functions.html#//apple_ref/c/func/arglDrawModeSet" target="doc">arglDrawModeSet</a></tt></dt> ! <dd>Set method by which arglDispImage() transfers pixels. </dd> <dt><tt><a href="Functions.html#//apple_ref/c/func/arglPixelFormatGet" target="doc">arglPixelFormatGet</a></tt></dt> --- 30,38 ---- <dd>Set compensation for camera lens distortion in arglDispImage to off or on. </dd> + <dt><tt><a href="Functions.html#//apple_ref/c/func/arglDrawModeGet" target="doc">arglDrawModeGet</a></tt></dt> + <dd>Get method by which arglDispImage() is transfering pixels. + </dd> <dt><tt><a href="Functions.html#//apple_ref/c/func/arglDrawModeSet" target="doc">arglDrawModeSet</a></tt></dt> ! <dd>Set method by which arglDispImage() will transfer pixels. </dd> <dt><tt><a href="Functions.html#//apple_ref/c/func/arglPixelFormatGet" target="doc">arglPixelFormatGet</a></tt></dt> *************** *** 42,48 **** --- 45,57 ---- <dd>Initialise the gsub_lite library for the current OpenGL context. </dd> + <dt><tt><a href="Functions.html#//apple_ref/c/func/arglTexmapModeGet" target="doc">arglTexmapModeGet</a></tt></dt> + <dd>Enquire whether full or half-resolution TexImage2D pixel-transfer is being used in arglDispImage(). + </dd> <dt><tt><a href="Functions.html#//apple_ref/c/func/arglTexmapModeSet" target="doc">arglTexmapModeSet</a></tt></dt> <dd>Determines use of full or half-resolution TexImage2D pixel-transfer in arglDispImage(). </dd> + <dt><tt><a href="Functions.html#//apple_ref/c/func/arglTexRectangleGet" target="doc">arglTexRectangleGet</a></tt></dt> + <dd>Enquire as to use of rectangular TexImage2D pixel-transfer in arglDispImage(). + </dd> <dt><tt><a href="Functions.html#//apple_ref/c/func/arglTexRectangleSet" target="doc">arglTexRectangleSet</a></tt></dt> <dd>Determines use of rectangular TexImage2D pixel-transfer in arglDispImage(). *************** *** 295,311 **** </dd> </dl> <hr><!-- headerDoc=func; uid=//apple_ref/c/func/arglDrawModeSet; name=arglDrawModeSet --> <a name="//apple_ref/c/func/arglDrawModeSet"></a> <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglDrawModeSet">arglDrawModeSet</a></h3> ! </td></tr></table><hr><dl></dl><p>Set method by which arglDispImage() transfers pixels. </p> <blockquote><pre><!-- a logicalPath="//apple_ref/c/cl/void //apple_ref/c/cl/void //apple_ref/c/tdef/void //apple_ref/c/tag/void //apple_ref/c/econst/void //apple_ref/c/struct/void //apple_ref/c/clconst/void" --><font class="type">void</font><!-- /a --> <!-- a logicalPath="//apple_ref/c/instm/arglDrawModeSet //apple_ref/c/clm/arglDrawModeSet //apple_ref/c/intfcm/arglDrawModeSet //apple_ref/c/func/arglDrawModeSet //apple_ref/c/ftmplt/arglDrawModeSet //apple_ref/c/defn/arglDrawModeSet //apple_ref/c/macro/arglDrawModeSet" --><font class="function">arglDrawModeSet</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>, <font class="keyword">const</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">mode</font>); </pre></blockquote> ! <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>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 --- 304,334 ---- </dd> </dl> + <hr><!-- headerDoc=func; uid=//apple_ref/c/func/arglDrawModeGet; name=arglDrawModeGet --> + <a name="//apple_ref/c/func/arglDrawModeGet"></a> + <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglDrawModeGet">arglDrawModeGet</a></h3> + </td></tr></table><hr><dl></dl><p>Get method by which arglDispImage() is transfering pixels. + </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/arglDrawModeGet //apple_ref/c/clm/arglDrawModeGet //apple_ref/c/intfcm/arglDrawModeGet //apple_ref/c/func/arglDrawModeGet //apple_ref/c/ftmplt/arglDrawModeGet //apple_ref/c/defn/arglDrawModeGet //apple_ref/c/macro/arglDrawModeGet" --><font class="function">arglDrawModeGet</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>); </pre></blockquote> + <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>Enquires as to the current method by which arglDispImage() is + transferring pixels to OpenGL for display. See arglDrawModeSet() for + more information. + </p> + <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.72. + </dd> + </dl> <hr><!-- headerDoc=func; uid=//apple_ref/c/func/arglDrawModeSet; name=arglDrawModeSet --> <a name="//apple_ref/c/func/arglDrawModeSet"></a> <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglDrawModeSet">arglDrawModeSet</a></h3> ! </td></tr></table><hr><dl></dl><p>Set method by which arglDispImage() will transfer pixels. </p> <blockquote><pre><!-- a logicalPath="//apple_ref/c/cl/void //apple_ref/c/cl/void //apple_ref/c/tdef/void //apple_ref/c/tag/void //apple_ref/c/econst/void //apple_ref/c/struct/void //apple_ref/c/clconst/void" --><font class="type">void</font><!-- /a --> <!-- a logicalPath="//apple_ref/c/instm/arglDrawModeSet //apple_ref/c/clm/arglDrawModeSet //apple_ref/c/intfcm/arglDrawModeSet //apple_ref/c/func/arglDrawModeSet //apple_ref/c/ftmplt/arglDrawModeSet //apple_ref/c/defn/arglDrawModeSet //apple_ref/c/macro/arglDrawModeSet" --><font class="function">arglDrawModeSet</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>, <font class="keyword">const</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">mode</font>); </pre></blockquote> ! <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>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 *************** *** 317,321 **** The initial value is AR_DRAW_BY_TEXTURE_MAPPING. </p> ! <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.68. </dd> </dl> --- 340,344 ---- The initial value is AR_DRAW_BY_TEXTURE_MAPPING. </p> ! <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.72. </dd> </dl> *************** *** 335,339 **** 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="" -->AR_PIXEL_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> --- 358,362 ---- 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 ! AR_PIXEL_FORMAT in ar.h 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> *************** *** 362,366 **** 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="" -->AR_PIXEL_FORMAT <!-- /a --> for a list of all possible formats.</dd> </dl> </blockquote> --- 385,389 ---- 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 ! AR_PIXEL_FORMAT in ar.h for a list of all possible formats.</dd> </dl> </blockquote> *************** *** 407,410 **** --- 430,446 ---- </dd> </dl> + <hr><!-- headerDoc=func; uid=//apple_ref/c/func/arglTexmapModeGet; name=arglTexmapModeGet --> + <a name="//apple_ref/c/func/arglTexmapModeGet"></a> + <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglTexmapModeGet">arglTexmapModeGet</a></h3> + </td></tr></table><hr><dl></dl><p>Enquire whether full or half-resolution TexImage2D pixel-transfer is being used in 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/arglTexmapModeGet //apple_ref/c/clm/arglTexmapModeGet //apple_ref/c/intfcm/arglTexmapModeGet //apple_ref/c/func/arglTexmapModeGet //apple_ref/c/ftmplt/arglTexmapModeGet //apple_ref/c/defn/arglTexmapModeGet //apple_ref/c/macro/arglTexmapModeGet" --><font class="function">arglTexmapModeGet</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>); </pre></blockquote> + <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>Enquires as to the current value of the TexmapMode setting. See arglTexmapModeSet() + for more info. + </p> + <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.72. + </dd> + </dl> <hr><!-- headerDoc=func; uid=//apple_ref/c/func/arglTexmapModeSet; name=arglTexmapModeSet --> <a name="//apple_ref/c/func/arglTexmapModeSet"></a> *************** *** 415,422 **** <!-- 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>, <font class="keyword">const</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">mode</font>); </pre></blockquote> ! <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>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. --- 451,459 ---- <!-- 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>, <font class="keyword">const</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">mode</font>); </pre></blockquote> ! <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>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. *************** *** 427,431 **** The initial value is AR_DRAW_TEXTURE_FULL_IMAGE. </p> ! <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.68. </dd> </dl> --- 464,481 ---- The initial value is AR_DRAW_TEXTURE_FULL_IMAGE. </p> ! <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.72. ! </dd> ! </dl> ! <hr><!-- headerDoc=func; uid=//apple_ref/c/func/arglTexRectangleGet; name=arglTexRectangleGet --> ! <a name="//apple_ref/c/func/arglTexRectangleGet"></a> ! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglTexRectangleGet">arglTexRectangleGet</a></h3> ! </td></tr></table><hr><dl></dl><p>Enquire as to use of rectangular TexImage2D pixel-transfer in 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/arglTexRectangleGet //apple_ref/c/clm/arglTexRectangleGet //apple_ref/c/intfcm/arglTexRectangleGet //apple_ref/c/func/arglTexRectangleGet //apple_ref/c/ftmplt/arglTexRectangleGet //apple_ref/c/defn/arglTexRectangleGet //apple_ref/c/macro/arglTexRectangleGet" --><font class="function">arglTexRectangleGet</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>); </pre></blockquote> ! <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>Enquires as to the current value of the TexRectangle setting. See arglTexRectangleSet() ! for more info. ! </p> ! <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.72. </dd> </dl> *************** *** 445,455 **** <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. </dd> </dl> ! <p><p>© 2003-2005 Philip Lamb ! (Last Updated August 29, 2005) </p></body></html> --- 495,505 ---- <br><br> 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. </p> ! <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.72. </dd> </dl> ! <p><p>© 2003-2006 Philip Lamb ! (Last Updated June 23, 2006) </p></body></html> |
