[artoolkit-commits] artoolkit/doc/gsub_lite/Functions Functions.html,1.1.1.1,1.2
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.1.1.1,1.2
|
From: Philip L. <phi...@us...> - 2005-06-23 06:48:52
|
Update of /cvsroot/artoolkit/artoolkit/doc/gsub_lite/Functions In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv25142 Modified Files: Functions.html Log Message: Update for Mac OS X 10.4 Index: Functions.html =================================================================== RCS file: /cvsroot/artoolkit/artoolkit/doc/gsub_lite/Functions/Functions.html,v retrieving revision 1.1.1.1 retrieving revision 1.2 diff -C2 -d -r1.1.1.1 -r1.2 *** Functions.html 4 Nov 2004 08:50:55 -0000 1.1.1.1 --- Functions.html 23 Jun 2005 06:48:42 -0000 1.2 *************** *** 1,49 **** <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/1998/REC-html40-19980424/loose.dtd"> ! <html><style type="text/css"><!--a:link {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #0000ff;}a:visited {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #0000ff;}a:visited:hover {text-decoration: underline; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #ff6600;}a:active {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #ff6600;}a:hover {text-decoration: underline; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #ff6600;}h4 {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: tiny; font-weight: bold;}body {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: 10pt;}--></style><head> <title>Functions</title> ! <meta name="generator" content="HeaderDoc"> ! </head><body bgcolor="#ffffff"> <h1><font face="Geneva,Arial,Helvtica">Functions</font></h1><br> <a name="HeaderDoc_functions"></a> <dl> ! <dt><tt><a href="Functions.html#arglSetupForCurrentContext" target="doc">arglSetupForCurrentContext</a></tt></dt> ! <dd>Initialise the gsub_lite library for the current OpenGL context. ! </dd> ! <dt><tt><a href="Functions.html#arglCleanup" target="doc">arglCleanup</a></tt></dt> ! <dd>Free memory used by gsub_lite associated with the specified context. ! </dd> ! <dt><tt><a href="Functions.html#arglCameraFrustum" target="doc">arglCameraFrustum</a></tt></dt> <dd>Create an OpenGL perspective projection matrix. </dd> ! <dt><tt><a href="Functions.html#arglCameraView" target="doc">arglCameraView</a></tt></dt> <dd>Create an OpenGL viewing transformation matrix. </dd> ! <dt><tt><a href="Functions.html#arglDispImage" target="doc">arglDispImage</a></tt></dt> <dd>Display an ARVideo image, by drawing it using OpenGL. </dd> ! <dt><tt><a href="Functions.html#arglDispImageStateful" target="doc">arglDispImageStateful</a></tt></dt> <dd>Display an ARVideo image, by drawing it using OpenGL, using and modifying current OpenGL state. </dd> </dl> ! <hr><!-- headerDoc=func; name=arglCameraFrustum --><a name="//apple_ref/c/func/arglCameraFrustum"></a> ! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h2><a name="arglCameraFrustum">arglCameraFrustum</a></h2> ! </td></tr></table><hr><dl>Create an OpenGL perspective projection matrix. ! ! </dl><blockquote><pre>void arglCameraFrustum( ! const ARParam *cparam, ! const double focalmin, ! const double focalmax, ! GLdouble m_projection [ 16 ]); ! </pre></blockquote> ! <p>Use this function to create a matrix suitable for passing to OpenGL ! to set the viewing projection. </p> <h5><font face="Lucida Grande,Helvetica,Arial">Parameter Descriptions</font></h5> <blockquote> <dl> ! <dt><tt><em>cparam</em></tt></dt><dd>Pointer to a set of ARToolKit camera parameters for the current video source.</dd> ! <dt><tt><em>focalmax</em></tt></dt><dd>The maximum distance at which geometry will be rendered. Any geometry further away from the camera than this distance will be clipped and will not be appear in a rendered frame. Thus, this value should be --- 1,47 ---- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/1998/REC-html40-19980424/loose.dtd"> ! <html><head> <title>Functions</title> ! <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> ! <meta name="generator" content="HeaderDoc"> ! <style type="text/css"><!--a:link {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #0000ff;}a:visited {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #0000ff;}a:visited:hover {text-decoration: underline; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #ff6600;}a:active {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #ff6600;}a:hover {text-decoration: underline; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #ff6600;}h4 {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: tiny; font-weight: bold;}body {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: 10pt;}--></style></head><body bgcolor="#ffffff"> <h1><font face="Geneva,Arial,Helvtica">Functions</font></h1><br> <a name="HeaderDoc_functions"></a> <dl> ! <dt><tt><a href="Functions.html#//apple_ref/c/func/arglCameraFrustum" target="doc">arglCameraFrustum</a></tt></dt> <dd>Create an OpenGL perspective projection matrix. </dd> ! <dt><tt><a href="Functions.html#//apple_ref/c/func/arglCameraView" target="doc">arglCameraView</a></tt></dt> <dd>Create an OpenGL viewing transformation matrix. </dd> ! <dt><tt><a href="Functions.html#//apple_ref/c/func/arglCleanup" target="doc">arglCleanup</a></tt></dt> ! <dd>Free memory used by gsub_lite associated with the specified context. ! </dd> ! <dt><tt><a href="Functions.html#//apple_ref/c/func/arglDispImage" target="doc">arglDispImage</a></tt></dt> <dd>Display an ARVideo image, by drawing it using OpenGL. </dd> ! <dt><tt><a href="Functions.html#//apple_ref/c/func/arglDispImageStateful" target="doc">arglDispImageStateful</a></tt></dt> <dd>Display an ARVideo image, by drawing it using OpenGL, using and modifying current OpenGL state. </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. + </dd> </dl> ! <hr><!-- headerDoc=func; uid=//apple_ref/c/func/arglCameraFrustum; name=arglCameraFrustum --> ! <a name="//apple_ref/c/func/arglCameraFrustum"></a> ! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglCameraFrustum">arglCameraFrustum</a></h3> ! </td></tr></table><hr><dl></dl><p>Create an OpenGL perspective projection matrix. </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/arglCameraFrustum //apple_ref/c/clm/arglCameraFrustum //apple_ref/c/intfcm/arglCameraFrustum //apple_ref/c/func/arglCameraFrustum //apple_ref/c/ftmplt/arglCameraFrustum //apple_ref/c/defn/arglCameraFrustum //apple_ref/c/macro/arglCameraFrustum" --><font class="function">arglCameraFrustum</font><!-- /a -->( + <font class="keyword">const</font> <!-- a logicalPath="//apple_ref/c/cl/ARParam //apple_ref/c/cl/ARParam //apple_ref/c/tdef/ARParam //apple_ref/c/tag/ARParam //apple_ref/c/econst/ARParam //apple_ref/c/struct/ARParam //apple_ref/c/clconst/ARParam" --><font class="type">ARParam</font><!-- /a --> *<font class="param">cparam</font>, + <font class="keyword">const</font> <!-- a logicalPath="//apple_ref/c/cl/double //apple_ref/c/cl/double //apple_ref/c/tdef/double //apple_ref/c/tag/double //apple_ref/c/econst/double //apple_ref/c/struct/double //apple_ref/c/clconst/double" --><font class="type">double</font><!-- /a --> <font class="param">focalmin</font>, + <font class="keyword">const</font> <!-- a logicalPath="//apple_ref/c/cl/double //apple_ref/c/cl/double //apple_ref/c/tdef/double //apple_ref/c/tag/double //apple_ref/c/econst/double //apple_ref/c/struct/double //apple_ref/c/clconst/double" --><font class="type">double</font><!-- /a --> <font class="param">focalmax</font>, + <!-- a logicalPath="//apple_ref/c/cl/GLdouble //apple_ref/c/cl/GLdouble //apple_ref/c/tdef/GLdouble //apple_ref/c/tag/GLdouble //apple_ref/c/econst/GLdouble //apple_ref/c/struct/GLdouble //apple_ref/c/clconst/GLdouble" --><font class="type">GLdouble</font><!-- /a --> <!-- a logicalPath="//apple_ref/c/cl/m_projection //apple_ref/c/cl/m_projection //apple_ref/c/tdef/m_projection //apple_ref/c/tag/m_projection //apple_ref/c/econst/m_projection //apple_ref/c/struct/m_projection //apple_ref/c/clconst/m_projection" --><font class="type">m_projection</font><!-- /a -->[<font class="number">16</font>]); </pre></blockquote> <h5><font face="Lucida Grande,Helvetica,Arial">Parameter Descriptions</font></h5> <blockquote> <dl> ! <dt><code><i>cparam</i></code></dt><dd>Pointer to a set of ARToolKit camera parameters for the current video source.</dd> ! <dt><code><i>focalmax</i></code></dt><dd>The maximum distance at which geometry will be rendered. Any geometry further away from the camera than this distance will be clipped and will not be appear in a rendered frame. Thus, this value should be *************** *** 52,56 **** to focalmax, thus you should not set focalmax any higher than it needs to be. This value should be specified in the same units as your OpenGL drawing.</dd> ! <dt><tt><em>focalmin</em></tt></dt><dd>The minimum distance at which geometry will be rendered. Any geometry closer to the camera than this distance will be clipped and will not be appear in a rendered frame. Thus, this value should be --- 50,54 ---- to focalmax, thus you should not set focalmax any higher than it needs to be. This value should be specified in the same units as your OpenGL drawing.</dd> ! <dt><code><i>focalmin</i></code></dt><dd>The minimum distance at which geometry will be rendered. Any geometry closer to the camera than this distance will be clipped and will not be appear in a rendered frame. Thus, this value should be *************** *** 62,159 **** perspectives you should set this value no lower than the near-point of the eyes. The near point in humans varies, but usually lies between 0.1 m ! 0.3 m. This value should be specified in the same units as your OpenGL drawing.</dd> ! <dt><tt><em>m_projection</em></tt></dt><dd>Pointer to a array of 16 GLdoubles, which will be filled out with a projection matrix suitable for passing to OpenGL. The matrix is specified in column major order.</dd> </dl> </blockquote> ! <dl><dt><i>availability</i></dt><dd>First appeared in ARToolKit 2.68. </dd> </dl> ! <hr><!-- headerDoc=func; name=arglCameraView --><a name="//apple_ref/c/func/arglCameraView"></a> ! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h2><a name="arglCameraView">arglCameraView</a></h2> ! </td></tr></table><hr><dl>Create an OpenGL viewing transformation matrix. ! ! </dl><blockquote><pre>void arglCameraView( ! double para [ 3 ][ 4 ], ! GLdouble m_modelview [ 16 ], ! double scale ); ! </pre></blockquote> ! <p>Use this function to create a matrix suitable for passing to OpenGL ! to set the viewing transformation of the virtual camera. </p> <h5><font face="Lucida Grande,Helvetica,Arial">Parameter Descriptions</font></h5> <blockquote> <dl> ! <dt><tt><em>para</em></tt></dt><dd>Pointer to 3x4 matrix array of doubles which specify the position of an ARToolKit marker, as returned by arGetTransMat().</dd> ! <dt><tt><em>m_modelview</em></tt></dt><dd>Pointer to a array of 16 GLdoubles, which will be filled out with a modelview matrix suitable for passing to OpenGL. The matrix is specified in column major order.</dd> ! <dt><tt><em>scale</em></tt></dt><dd>Specifies a scaling between ARToolKit's units (usually millimeters) and OpenGL's coordinate system units.</dd> </dl> </blockquote> ! <dl><dt><i>availability</i></dt><dd>First appeared in ARToolKit 2.68. </dd> </dl> ! <hr><!-- headerDoc=func; name=arglCleanup --><a name="//apple_ref/c/func/arglCleanup"></a> ! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h2><a name="arglCleanup">arglCleanup</a></h2> ! </td></tr></table><hr><dl>Free memory used by gsub_lite associated with the specified context. ! ! </dl><blockquote><pre>void arglCleanup( ! ARGL_CONTEXT_SETTINGS_REF contextSettings ); ! </pre></blockquote> ! <p>Should be called after no more argl* functions are needed, in order ! to prevent memory leaks etc. ! <br><br> ! The library can be setup again for the context at a later time by calling ! arglSetupForCurrentContext() again. </p> <h5><font face="Lucida Grande,Helvetica,Arial">Parameter Descriptions</font></h5> <blockquote> <dl> ! <dt><tt><em>contextSettings</em></tt></dt><dd>A reference to ARGL's settings for an OpenGL context, as returned by arglSetupForCurrentContext().</dd> </dl> </blockquote> ! <dl><dt><i>availability</i></dt><dd>First appeared in ARToolKit 2.68. </dd> </dl> ! <hr><!-- headerDoc=func; name=arglDispImage --><a name="//apple_ref/c/func/arglDispImage"></a> ! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h2><a name="arglDispImage">arglDispImage</a></h2> ! </td></tr></table><hr><dl>Display an ARVideo image, by drawing it using OpenGL. ! ! </dl><blockquote><pre>void arglDispImage( ! ARUint8 *image, ! const ARParam *cparam, ! const double zoom, ! ARGL_CONTEXT_SETTINGS_REF contextSettings ); ! </pre></blockquote> ! <p>This function draws an image from an ARVideo source to the current ! OpenGL context. This operation is most useful in video see-through ! augmented reality applications for drawing the camera view as a ! background image, but can also be used in other ways. ! <br><br> ! An undistorted image is drawn with the lower-left corner of the ! bottom-left-most pixel at OpenGL screen coordinates (0,0), and the ! upper-right corner of the top-right-most pixel at OpenGL screen ! coodinates (x * zoom, y * zoom), where x and y are the values of the ! fields cparam->xsize and cparam->ysize (see below) and zoom is the ! value of the parameter zoom (also see below). If cparam->dist_factor ! indicates that an un-warping correction should be applied, the actual ! coordinates will differ from the values specified here. ! <br><br> ! OpenGL state: Drawing is performed with depth testing and lighting ! disabled, and thus leaves the the depth buffer (if any) unmodified. If ! pixel transfer is by texturing (see documentation for arglDrawMode), ! the drawing is done in replacement texture environment mode. ! The depth test enable and lighting enable state and the texture ! environment mode are restored before the function returns. </p> <h5><font face="Lucida Grande,Helvetica,Arial">Parameter Descriptions</font></h5> <blockquote> <dl> ! <dt><tt><em>image</em></tt></dt><dd>Pointer to the tightly-packed image data (as returned by arVideoGetImage()). The horizontal and vertical dimensions of the image data must exactly match the values specified in the fields cparam->xsize --- 60,139 ---- perspectives you should set this value no lower than the near-point of the eyes. The near point in humans varies, but usually lies between 0.1 m ! 0.3 m. This value should be specified in the same units as your OpenGL drawing.</li></ol></dd> ! <dt><code><i>m_projection</i></code></dt><dd>Pointer to a array of 16 GLdoubles, which will be filled out with a projection matrix suitable for passing to OpenGL. The matrix is specified in column major order.</dd> </dl> </blockquote> ! <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>Use this function to create a matrix suitable for passing to OpenGL ! to set the viewing projection. ! </p> ! <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.68. </dd> </dl> ! <hr><!-- headerDoc=func; uid=//apple_ref/c/func/arglCameraView; name=arglCameraView --> ! <a name="//apple_ref/c/func/arglCameraView"></a> ! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglCameraView">arglCameraView</a></h3> ! </td></tr></table><hr><dl></dl><p>Create an OpenGL viewing transformation matrix. </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/arglCameraView //apple_ref/c/clm/arglCameraView //apple_ref/c/intfcm/arglCameraView //apple_ref/c/func/arglCameraView //apple_ref/c/ftmplt/arglCameraView //apple_ref/c/defn/arglCameraView //apple_ref/c/macro/arglCameraView" --><font class="function">arglCameraView</font><!-- /a -->( + <!-- a logicalPath="//apple_ref/c/cl/double //apple_ref/c/cl/double //apple_ref/c/tdef/double //apple_ref/c/tag/double //apple_ref/c/econst/double //apple_ref/c/struct/double //apple_ref/c/clconst/double" --><font class="type">double</font><!-- /a --> <!-- a logicalPath="//apple_ref/c/cl/para //apple_ref/c/cl/para //apple_ref/c/tdef/para //apple_ref/c/tag/para //apple_ref/c/econst/para //apple_ref/c/struct/para //apple_ref/c/clconst/para" --><font class="type">para</font><!-- /a -->[<font class="number">3</font>][<font class="number">4</font>], + <!-- a logicalPath="//apple_ref/c/cl/GLdouble //apple_ref/c/cl/GLdouble //apple_ref/c/tdef/GLdouble //apple_ref/c/tag/GLdouble //apple_ref/c/econst/GLdouble //apple_ref/c/struct/GLdouble //apple_ref/c/clconst/GLdouble" --><font class="type">GLdouble</font><!-- /a --> <!-- a logicalPath="//apple_ref/c/cl/m_modelview //apple_ref/c/cl/m_modelview //apple_ref/c/tdef/m_modelview //apple_ref/c/tag/m_modelview //apple_ref/c/econst/m_modelview //apple_ref/c/struct/m_modelview //apple_ref/c/clconst/m_modelview" --><font class="type">m_modelview</font><!-- /a -->[<font class="number">16</font>], + <!-- a logicalPath="//apple_ref/c/cl/double //apple_ref/c/cl/double //apple_ref/c/tdef/double //apple_ref/c/tag/double //apple_ref/c/econst/double //apple_ref/c/struct/double //apple_ref/c/clconst/double" --><font class="type">double</font><!-- /a --> <font class="param">scale</font>); </pre></blockquote> <h5><font face="Lucida Grande,Helvetica,Arial">Parameter Descriptions</font></h5> <blockquote> <dl> ! <dt><code><i>para</i></code></dt><dd>Pointer to 3x4 matrix array of doubles which specify the position of an ARToolKit marker, as returned by arGetTransMat().</dd> ! <dt><code><i>m_modelview</i></code></dt><dd>Pointer to a array of 16 GLdoubles, which will be filled out with a modelview matrix suitable for passing to OpenGL. The matrix is specified in column major order.</dd> ! <dt><code><i>scale</i></code></dt><dd>Specifies a scaling between ARToolKit's units (usually millimeters) and OpenGL's coordinate system units.</dd> </dl> </blockquote> ! <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>Use this function to create a matrix suitable for passing to OpenGL ! to set the viewing transformation of the virtual camera. ! </p> ! <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.68. </dd> </dl> ! <hr><!-- headerDoc=func; uid=//apple_ref/c/func/arglCleanup; name=arglCleanup --> ! <a name="//apple_ref/c/func/arglCleanup"></a> ! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglCleanup">arglCleanup</a></h3> ! </td></tr></table><hr><dl></dl><p>Free memory used by gsub_lite associated with the specified context. </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/arglCleanup //apple_ref/c/clm/arglCleanup //apple_ref/c/intfcm/arglCleanup //apple_ref/c/func/arglCleanup //apple_ref/c/ftmplt/arglCleanup //apple_ref/c/defn/arglCleanup //apple_ref/c/macro/arglCleanup" --><font class="function">arglCleanup</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> <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 an OpenGL context, as returned by arglSetupForCurrentContext().</dd> </dl> </blockquote> ! <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>Should be called after no more argl* functions are needed, in order ! to prevent memory leaks etc. ! <br><br> ! The library can be setup again for the context at a later time by calling ! arglSetupForCurrentContext() again. ! </p> ! <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.68. </dd> </dl> ! <hr><!-- headerDoc=func; uid=//apple_ref/c/func/arglDispImage; name=arglDispImage --> ! <a name="//apple_ref/c/func/arglDispImage"></a> ! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglDispImage">arglDispImage</a></h3> ! </td></tr></table><hr><dl></dl><p>Display an ARVideo image, by drawing it using OpenGL. </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/arglDispImage //apple_ref/c/clm/arglDispImage //apple_ref/c/intfcm/arglDispImage //apple_ref/c/func/arglDispImage //apple_ref/c/ftmplt/arglDispImage //apple_ref/c/defn/arglDispImage //apple_ref/c/macro/arglDispImage" --><font class="function">arglDispImage</font><!-- /a -->( + <!-- a logicalPath="//apple_ref/c/cl/ARUint8 //apple_ref/c/cl/ARUint8 //apple_ref/c/tdef/ARUint8 //apple_ref/c/tag/ARUint8 //apple_ref/c/econst/ARUint8 //apple_ref/c/struct/ARUint8 //apple_ref/c/clconst/ARUint8" --><font class="type">ARUint8</font><!-- /a --> *<font class="param">image</font>, + <font class="keyword">const</font> <!-- a logicalPath="//apple_ref/c/cl/ARParam //apple_ref/c/cl/ARParam //apple_ref/c/tdef/ARParam //apple_ref/c/tag/ARParam //apple_ref/c/econst/ARParam //apple_ref/c/struct/ARParam //apple_ref/c/clconst/ARParam" --><font class="type">ARParam</font><!-- /a --> *<font class="param">cparam</font>, + <font class="keyword">const</font> <!-- a logicalPath="//apple_ref/c/cl/double //apple_ref/c/cl/double //apple_ref/c/tdef/double //apple_ref/c/tag/double //apple_ref/c/econst/double //apple_ref/c/struct/double //apple_ref/c/clconst/double" --><font class="type">double</font><!-- /a --> <font class="param">zoom</font>, + <!-- 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> <h5><font face="Lucida Grande,Helvetica,Arial">Parameter Descriptions</font></h5> <blockquote> <dl> ! <dt><code><i>image</i></code></dt><dd>Pointer to the tightly-packed image data (as returned by arVideoGetImage()). The horizontal and vertical dimensions of the image data must exactly match the values specified in the fields cparam->xsize *************** *** 173,177 **** from images generated by ARVideo, and so you should ensure that ARVideo is generating pixels of the same format.</dd> ! <dt><tt><em>cparam</em></tt></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 fields xsize and ysize of the ARParam structure pointed to. Also, when --- 153,157 ---- 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 fields xsize and ysize of the ARParam structure pointed to. Also, when *************** *** 180,187 **** structure pointed to will be taken as the amount to un-warp the supplied image.</dd> ! <dt><tt><em>zoom</em></tt></dt><dd>The amount to scale the video image up or down. To draw the video image double size, use a zoom value of 2.0. To draw the video image half size use a zoom value of 0.5.</dd> ! <dt><tt><em>contextSettings</em></tt></dt><dd>A reference to ARGL's settings for the current OpenGL context, as returned by arglSetupForCurrentContext() for this context. It is the callers responsibility to make sure that the current context at the --- 160,167 ---- structure pointed to will be taken as the amount to un-warp the supplied image.</dd> ! <dt><code><i>zoom</i></code></dt><dd>The amount to scale the video image up or down. To draw the video image double size, use a zoom value of 2.0. To draw the video image half size use a zoom value of 0.5.</dd> ! <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. It is the callers responsibility to make sure that the current context at the *************** *** 190,207 **** </dl> </blockquote> ! <dl><dt><i>availability</i></dt><dd>First appeared in ARToolKit 2.68. </dd> </dl> ! <hr><!-- headerDoc=func; name=arglDispImageStateful --><a name="//apple_ref/c/func/arglDispImageStateful"></a> ! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h2><a name="arglDispImageStateful">arglDispImageStateful</a></h2> ! </td></tr></table><hr><dl>Display an ARVideo image, by drawing it using OpenGL, using and modifying current OpenGL state. ! ! </dl><blockquote><pre>void arglDispImageStateful( ! ARUint8 *image, ! const ARParam *cparam, ! const double zoom, ! ARGL_CONTEXT_SETTINGS_REF contextSettings ); ! </pre></blockquote> ! <p>This function is identical to arglDispImage except that whereas arglDispImage sets an orthographic 2D projection and the OpenGL state prior to drawing, this function does not. It also does not restore any --- 170,208 ---- </dl> </blockquote> ! <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>This function draws an image from an ARVideo source to the current ! OpenGL context. This operation is most useful in video see-through ! augmented reality applications for drawing the camera view as a ! background image, but can also be used in other ways. ! <br><br> ! An undistorted image is drawn with the lower-left corner of the ! bottom-left-most pixel at OpenGL screen coordinates (0,0), and the ! upper-right corner of the top-right-most pixel at OpenGL screen ! coodinates (x * zoom, y * zoom), where x and y are the values of the ! fields cparam->xsize and cparam->ysize (see below) and zoom is the ! value of the parameter zoom (also see below). If cparam->dist_factor ! indicates that an un-warping correction should be applied, the actual ! coordinates will differ from the values specified here. ! <br><br> ! OpenGL state: Drawing is performed with depth testing and lighting ! disabled, and thus leaves the the depth buffer (if any) unmodified. If ! pixel transfer is by texturing (see documentation for arglDrawMode), ! the drawing is done in replacement texture environment mode. ! The depth test enable and lighting enable state and the texture ! environment mode are restored before the function returns. ! </p> ! <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.68. </dd> </dl> ! <hr><!-- headerDoc=func; uid=//apple_ref/c/func/arglDispImageStateful; name=arglDispImageStateful --> ! <a name="//apple_ref/c/func/arglDispImageStateful"></a> ! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglDispImageStateful">arglDispImageStateful</a></h3> ! </td></tr></table><hr><dl></dl><p>Display an ARVideo image, by drawing it using OpenGL, using and modifying current OpenGL state. ! </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/arglDispImageStateful //apple_ref/c/clm/arglDispImageStateful //apple_ref/c/intfcm/arglDispImageStateful //apple_ref/c/func/arglDispImageStateful //apple_ref/c/ftmplt/arglDispImageStateful //apple_ref/c/defn/arglDispImageStateful //apple_ref/c/macro/arglDispImageStateful" --><font class="function">arglDispImageStateful</font><!-- /a -->( ! <!-- a logicalPath="//apple_ref/c/cl/ARUint8 //apple_ref/c/cl/ARUint8 //apple_ref/c/tdef/ARUint8 //apple_ref/c/tag/ARUint8 //apple_ref/c/econst/ARUint8 //apple_ref/c/struct/ARUint8 //apple_ref/c/clconst/ARUint8" --><font class="type">ARUint8</font><!-- /a --> *<font class="param">image</font>, ! <font class="keyword">const</font> <!-- a logicalPath="//apple_ref/c/cl/ARParam //apple_ref/c/cl/ARParam //apple_ref/c/tdef/ARParam //apple_ref/c/tag/ARParam //apple_ref/c/econst/ARParam //apple_ref/c/struct/ARParam //apple_ref/c/clconst/ARParam" --><font class="type">ARParam</font><!-- /a --> *<font class="param">cparam</font>, ! <font class="keyword">const</font> <!-- a logicalPath="//apple_ref/c/cl/double //apple_ref/c/cl/double //apple_ref/c/tdef/double //apple_ref/c/tag/double //apple_ref/c/econst/double //apple_ref/c/struct/double //apple_ref/c/clconst/double" --><font class="type">double</font><!-- /a --> <font class="param">zoom</font>, ! <!-- 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>This function is identical to arglDispImage except that whereas arglDispImage sets an orthographic 2D projection and the OpenGL state prior to drawing, this function does not. It also does not restore any *************** *** 218,232 **** See the documentation for arglDispImage() for more information. </p> ! <dl><dt><i>availability</i></dt><dd>First appeared in ARToolKit 2.68.2. </dd> </dl> ! <hr><!-- headerDoc=func; name=arglSetupForCurrentContext --><a name="//apple_ref/c/func/arglSetupForCurrentContext"></a> ! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h2><a name="arglSetupForCurrentContext">arglSetupForCurrentContext</a></h2> ! </td></tr></table><hr><dl>Initialise the gsub_lite library for the current OpenGL context. ! ! </dl><blockquote><pre>ARGL_CONTEXT_SETTINGS_REF arglSetupForCurrentContext( ! void ); ! </pre></blockquote> ! <p>This function performs required setup of the gsub_lite library for the current OpenGL context and must be called before any other argl*() functions are called for this context. --- 219,235 ---- See the documentation for arglDispImage() for more information. </p> ! <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.68.2. </dd> </dl> ! <hr><!-- headerDoc=func; uid=//apple_ref/c/func/arglSetupForCurrentContext; name=arglSetupForCurrentContext --> ! <a name="//apple_ref/c/func/arglSetupForCurrentContext"></a> ! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglSetupForCurrentContext">arglSetupForCurrentContext</a></h3> ! </td></tr></table><hr><dl></dl><p>Initialise the gsub_lite library for the current OpenGL context. ! </p> ! <blockquote><pre><!-- 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 --> <!-- a logicalPath="//apple_ref/c/instm/arglSetupForCurrentContext //apple_ref/c/clm/arglSetupForCurrentContext //apple_ref/c/intfcm/arglSetupForCurrentContext //apple_ref/c/func/arglSetupForCurrentContext //apple_ref/c/ftmplt/arglSetupForCurrentContext //apple_ref/c/defn/arglSetupForCurrentContext //apple_ref/c/macro/arglSetupForCurrentContext" --><font class="function">arglSetupForCurrentContext</font><!-- /a -->( ! <font class="param">void</font>); </pre></blockquote> ! <dl><dt><i>function result</i></dt><dd>An ARGL_CONTEXT_SETTINGS_REF. See the documentation for this type for more info. ! </dd> ! <h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>This function performs required setup of the gsub_lite library for the current OpenGL context and must be called before any other argl*() functions are called for this context. *************** *** 243,252 **** when you have finished with the library for this context. </p> ! <dl><dt><i>function result</i></dt><dd>An ARGL_CONTEXT_SETTINGS_REF. See the documentation for this type for more info. ! </dd> ! <dt><i>availability</i></dt><dd>First appeared in ARToolKit 2.68. </dd> </dl> <p><p>© 2003-2004 Philip Lamb ! (Last Updated 07/02/2004) </p></body></html> --- 246,253 ---- when you have finished with the library for this context. </p> ! <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.68. </dd> </dl> <p><p>© 2003-2004 Philip Lamb ! (Last Updated August 02, 2004) </p></body></html> |
