[artoolkit-commits] artoolkit/doc/gsub_lite/Functions Functions.html,1.3,1.4
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.3,1.4
|
From: Philip L. <phi...@us...> - 2005-08-16 00:49:49
|
Update of /cvsroot/artoolkit/artoolkit/doc/gsub_lite/Functions In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv31636 Modified Files: Functions.html Log Message: Update for run-time pixel format specification. Index: Functions.html =================================================================== RCS file: /cvsroot/artoolkit/artoolkit/doc/gsub_lite/Functions/Functions.html,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** Functions.html 30 Jul 2005 01:10:20 -0000 1.3 --- Functions.html 16 Aug 2005 00:49:40 -0000 1.4 *************** *** 30,33 **** --- 30,39 ---- <dd>Set compensation for camera lens distortion in arglDispImage to off or on. </dd> + <dt><tt><a href="Functions.html#//apple_ref/c/func/arglPixelFormatGet" target="doc">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="Functions.html#//apple_ref/c/func/arglPixelFormatSet" target="doc">arglPixelFormatSet</a></tt></dt> + <dd>Set the format of pixel data which will be passed to arglDispImage*() + </dd> <dt><tt><a href="Functions.html#//apple_ref/c/func/arglSetupForCurrentContext" target="doc">arglSetupForCurrentContext</a></tt></dt> <dd>Initialise the gsub_lite library for the current OpenGL context. *************** *** 150,162 **** 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 --- 156,160 ---- 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 *************** *** 245,249 **** </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 --- 243,247 ---- </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 *************** *** 285,288 **** --- 283,347 ---- </dd> </dl> + <hr><!-- headerDoc=func; uid=//apple_ref/c/func/arglPixelFormatGet; name=arglPixelFormatGet --> + <a name="//apple_ref/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/c/func/arglPixelFormatSet; name=arglPixelFormatSet --> + <a name="//apple_ref/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/c/func/arglSetupForCurrentContext; name=arglSetupForCurrentContext --> <a name="//apple_ref/c/func/arglSetupForCurrentContext"></a> |
