|
From: Philip L. <phi...@us...> - 2006-09-28 03:06:39
|
Update of /cvsroot/artoolkit/artoolkit/doc In directory sc8-pr-cvs11.sourceforge.net:/tmp/cvs-serv21251 Modified Files: globals.html ar_8h.html video_8h.html globals_func.html Log Message: Update docs. Index: ar_8h.html =================================================================== RCS file: /cvsroot/artoolkit/artoolkit/doc/ar_8h.html,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** ar_8h.html 22 May 2006 23:03:18 -0000 1.2 --- ar_8h.html 28 Sep 2006 03:06:34 -0000 1.3 *************** *** 64,67 **** --- 64,70 ---- <tr><td class="mdescLeft"> </td><td class="mdescRight">ARToolKit pixel-format specifiers. <a href="#641bf68ce0529b6b323ec156e69c5590"></a><br></td></tr> <tr><td colspan="2"><br><h2>Functions</h2></td></tr> + <tr><td class="memItemLeft" nowrap align="right" valign="top">ARUint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="ar_8h.html#5f6a6f78cfce8c8dfc80479b47232eb4">arGetVersion</a> (char **versionStringRef)</td></tr> + + <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the ARToolKit version information in numberic and string format. <a href="#5f6a6f78cfce8c8dfc80479b47232eb4"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ar_8h.html#52f12a73083b810427e2a9066e69a0f2">arInitCparam</a> (<a class="el" href="structARParam.html">ARParam</a> *param)</td></tr> *************** *** 129,133 **** <tr><td class="memItemLeft" nowrap align="right" valign="top">ARInt16 * </td><td class="memItemRight" valign="bottom"><a class="el" href="ar_8h.html#42ad9c96a619e0d62be0627634332dfe">arLabeling</a> (ARUint8 *image, int thresh, int *label_num, int **area, double **pos, int **clip, int **label_ref)</td></tr> ! <tr><td class="mdescLeft"> </td><td class="mdescRight">extracted connected component from image. <a href="#42ad9c96a619e0d62be0627634332dfe"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ar_8h.html#4909575c338b25813a1c824d46b2f4fe">arGetImgFeature</a> (int *num, int **area, int **clip, double **pos)</td></tr> --- 132,136 ---- <tr><td class="memItemLeft" nowrap align="right" valign="top">ARInt16 * </td><td class="memItemRight" valign="bottom"><a class="el" href="ar_8h.html#42ad9c96a619e0d62be0627634332dfe">arLabeling</a> (ARUint8 *image, int thresh, int *label_num, int **area, double **pos, int **clip, int **label_ref)</td></tr> ! <tr><td class="mdescLeft"> </td><td class="mdescRight">extract connected components from image. <a href="#42ad9c96a619e0d62be0627634332dfe"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ar_8h.html#4909575c338b25813a1c824d46b2f4fe">arGetImgFeature</a> (int *num, int **area, int **clip, double **pos)</td></tr> *************** *** 144,148 **** <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ar_8h.html#5f9a199367ae02c106c1845f8706727e">arGetPatt</a> (ARUint8 *image, int *x_coord, int *y_coord, int *vertex, ARUint8 ext_pat[AR_PATT_SIZE_Y][AR_PATT_SIZE_X][3])</td></tr> ! <tr><td class="mdescLeft"> </td><td class="mdescRight">return a normalized pattern from a video image. <a href="#5f9a199367ae02c106c1845f8706727e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ar_8h.html#870cde1dfb861bfdbb12f2a71baa2a4e">arGetLine</a> (int x_coord[], int y_coord[], int coord_num, int vertex[], double line[4][3], double v[4][2])</td></tr> --- 147,151 ---- <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ar_8h.html#5f9a199367ae02c106c1845f8706727e">arGetPatt</a> (ARUint8 *image, int *x_coord, int *y_coord, int *vertex, ARUint8 ext_pat[AR_PATT_SIZE_Y][AR_PATT_SIZE_X][3])</td></tr> ! <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a normalized pattern from a video image. <a href="#5f9a199367ae02c106c1845f8706727e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ar_8h.html#870cde1dfb861bfdbb12f2a71baa2a4e">arGetLine</a> (int x_coord[], int y_coord[], int coord_num, int vertex[], double line[4][3], double v[4][2])</td></tr> *************** *** 1250,1256 **** <p> ! return a normalized pattern from a video image. <p> ! This function return a normalized pattern from a video image. The format is a table with AR_PATT_SIZE_X by AR_PATT_SIZE_Y <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>image</em> </td><td>video input image </td></tr> --- 1253,1259 ---- <p> ! Get a normalized pattern from a video image. <p> ! This function returns a normalized pattern from a video image. The format is a table with AR_PATT_SIZE_X by AR_PATT_SIZE_Y <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>image</em> </td><td>video input image </td></tr> *************** *** 1453,1456 **** --- 1456,1496 ---- </tr> </table> + <a class="anchor" name="5f6a6f78cfce8c8dfc80479b47232eb4"></a><!-- doxytag: member="ar.h::arGetVersion" ref="5f6a6f78cfce8c8dfc80479b47232eb4" args="(char **versionStringRef)" --><p> + <table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">ARUint32 arGetVersion </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">char ** </td> + <td class="mdname1" valign="top" nowrap> <em>versionStringRef</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> + </table> + <table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + + <p> + Get the ARToolKit version information in numberic and string format. + <p> + As of version 2.72, ARToolKit now allows querying of the version number of the toolkit available at runtime. It is highly recommended that any calling program that depends on features in a certain ARToolKit version, check at runtime that it is linked to a version of ARToolKit that can supply those features. It is NOT sufficient to check the ARToolKit SDK header versions, since with ARToolKit implemented in dynamically-loaded libraries, there is no guarantee that the version of ARToolKit installed on the machine at run-time will as recent as the version of the ARToolKit SDK which the host program was compiled against. The version information is reported in binary-coded decimal format, and optionally in an ASCII string. See the config.h header for more discussion of the definition of major, minor, tiny and build version numbers.<p> + <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>versionStringRef</em> </td><td>If non-NULL, the location pointed to will be filled with a pointer to a string containing the version information. Fields in the version string are separated by spaces. As of version 2.72.0, there is only one field implemented, and this field contains the major, minor and tiny version numbers in dotted-decimal format. The string is guaranteed to contain at least this field in all future versions of the toolkit. Later versions of the toolkit may add other fields to this string to report other types of version information. The storage for the string is malloc'ed inside the function. The caller is responsible for free'ing the string.</td></tr> + </table> + </dl> + <dl compact><dt><b>Returns:</b></dt><dd>Returns the full version number of the ARToolKit in binary coded decimal (BCD) format. BCD format allows simple tests of version number in the caller e.g. if ((arGetVersion(NULL) >> 16) > 0x0272) printf("This release is later than 2.72\n"); The major version number is encoded in the most-significant byte (bits 31-24), the minor version number in the second-most-significant byte (bits 23-16), the tiny version number in the third-most-significant byte (bits 15-8), and the build version number in the least-significant byte (bits 7-0). </dd></dl> + </td> + </tr> + </table> <a class="anchor" name="52f12a73083b810427e2a9066e69a0f2"></a><!-- doxytag: member="ar.h::arInitCparam" ref="52f12a73083b810427e2a9066e69a0f2" args="(ARParam *param)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> *************** *** 1553,1570 **** <p> ! extracted connected component from image. <p> ! Labeling the input image, i.e. extracted connected component from the inptu video image. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> ! <tr><td valign="top"></td><td valign="top"><em>image</em> </td><td>input image </td></tr> <tr><td valign="top"></td><td valign="top"><em>thresh</em> </td><td>lighting threshold </td></tr> ! <tr><td valign="top"></td><td valign="top"><em>label_num</em> </td><td>number of detected components </td></tr> ! <tr><td valign="top"></td><td valign="top"><em>area</em> </td><td>XXXBK </td></tr> ! <tr><td valign="top"></td><td valign="top"><em>pos</em> </td><td>XXXBK </td></tr> ! <tr><td valign="top"></td><td valign="top"><em>clip</em> </td><td>XXXBK </td></tr> ! <tr><td valign="top"></td><td valign="top"><em>label_ref</em> </td><td>XXXBK </td></tr> </table> </dl> ! <dl compact><dt><b>Returns:</b></dt><dd>XXXBK </dd></dl> </td> </tr> --- 1593,1610 ---- <p> ! extract connected components from image. <p> ! Label the input image, i.e. extract connected components from the input video image. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> ! <tr><td valign="top"></td><td valign="top"><em>image</em> </td><td>input image, as returned by <a class="el" href="video_8h.html#aba310982da09d39a4a92c5cd394d0dd">arVideoGetImage()</a> </td></tr> <tr><td valign="top"></td><td valign="top"><em>thresh</em> </td><td>lighting threshold </td></tr> ! <tr><td valign="top"></td><td valign="top"><em>label_num</em> </td><td>Ouput- number of detected components </td></tr> ! <tr><td valign="top"></td><td valign="top"><em>area</em> </td><td>On return, if label_num > 0, points to an array of ints, one for each detected component. </td></tr> ! <tr><td valign="top"></td><td valign="top"><em>pos</em> </td><td>On return, if label_num > 0, points to an array of doubles, one for each detected component. </td></tr> ! <tr><td valign="top"></td><td valign="top"><em>clip</em> </td><td>On return, if label_num > 0, points to an array of ints, one for each detected component. </td></tr> ! <tr><td valign="top"></td><td valign="top"><em>label_ref</em> </td><td>On return, if label_num > 0, points to an array of ints, one for each detected component. </td></tr> </table> </dl> ! <dl compact><dt><b>Returns:</b></dt><dd>returns a pointer to the labeled output image, ready for passing onto the next stage of processing. </dd></dl> </td> </tr> Index: video_8h.html =================================================================== RCS file: /cvsroot/artoolkit/artoolkit/doc/video_8h.html,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** video_8h.html 22 May 2006 23:03:18 -0000 1.3 --- video_8h.html 28 Sep 2006 03:06:34 -0000 1.4 *************** *** 80,84 **** This library provides multi-platform video input support for ARToolKit. It abstracts access to hardware video input available on different machines and operating systems.<p> The actual supported platforms (and the driver/library used) are:<ul> ! <li>Windows: with Microsoft DirectShow (VFW obsolete).</li><li>Linux: with Video4Linux library, IEEE1394 camera library, and DV camera library.</li><li>Macintosh: with QuickTime.</li><li>SGI: with VL.</li></ul> <p> This library provides two sets of functions, depending on whether your program needs to use only one video stream, or more than one video stream. These two sets are functionally identical.<ul> --- 80,84 ---- This library provides multi-platform video input support for ARToolKit. It abstracts access to hardware video input available on different machines and operating systems.<p> The actual supported platforms (and the driver/library used) are:<ul> ! <li>Windows: with Microsoft DirectShow (VFW obsolete).</li><li>Linux: with Video4Linux library, GStreamer, IEEE1394 camera library and DV camera library.</li><li>Macintosh: with QuickTime.</li><li>SGI: with VL.</li></ul> <p> This library provides two sets of functions, depending on whether your program needs to use only one video stream, or more than one video stream. These two sets are functionally identical.<ul> *************** *** 87,95 **** More information on establishing video streams is available in the ARToolKit manual.<p> <dl compact><dt><b>Remarks:</b></dt><dd>The arVideo* functions maintain the current video stream in a global variable and internally call the ar2Video* functions.</dd></dl> ! History : modified by Thomas Pintaric (<a href="mailto:pin...@im...">pin...@im...</a>) to add a fully transparent DirectShow Driver.<p> <dl compact><dt><b>Author:</b></dt><dd>Hirokazu Kato <a href="mailto:ka...@sy...">ka...@sy...</a> <p> Atsishi Nakazawa <a href="mailto:nak...@in...">nak...@in...</a> <p> Thomas Pintaric <a href="mailto:pin...@im...">pin...@im...</a> (Windows DirectShow video support). <p> ! Philip Lamb <a href="mailto:ph...@ed...">ph...@ed...</a> (Macintosh Quicktime video support). </dd></dl> <dl compact><dt><b>Version:</b></dt><dd>4.3b </dd></dl> <dl compact><dt><b>Date:</b></dt><dd>03/02/02 </dd></dl> --- 87,96 ---- More information on establishing video streams is available in the ARToolKit manual.<p> <dl compact><dt><b>Remarks:</b></dt><dd>The arVideo* functions maintain the current video stream in a global variable and internally call the ar2Video* functions.</dd></dl> ! History : modified by Thomas Pintaric (<a href="mailto:pin...@im...">pin...@im...</a>) to add a fully transparent DirectShow Driver. modified by Hartmut Seichter (<a href="mailto:ha...@te...">ha...@te...</a>) to add GStreamer video support<p> <dl compact><dt><b>Author:</b></dt><dd>Hirokazu Kato <a href="mailto:ka...@sy...">ka...@sy...</a> <p> Atsishi Nakazawa <a href="mailto:nak...@in...">nak...@in...</a> <p> Thomas Pintaric <a href="mailto:pin...@im...">pin...@im...</a> (Windows DirectShow video support). <p> ! Philip Lamb <a href="mailto:ph...@ed...">ph...@ed...</a> (Macintosh Quicktime video support). <p> ! Hartmut Seichter <a href="mailto:ha...@te...">ha...@te...</a> (GStreamer Video support) </dd></dl> <dl compact><dt><b>Version:</b></dt><dd>4.3b </dd></dl> <dl compact><dt><b>Date:</b></dt><dd>03/02/02 </dd></dl> Index: globals.html =================================================================== RCS file: /cvsroot/artoolkit/artoolkit/doc/globals.html,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** globals.html 22 May 2006 23:03:18 -0000 1.2 --- globals.html 28 Sep 2006 03:06:33 -0000 1.3 *************** *** 84,88 **** : <a class="el" href="ar_8h.html#37f711816374205f2479501fd7ed9dc8">ar.h</a><li>arGetTransMat() : <a class="el" href="ar_8h.html#01eddf593ac98e4547e7131263e0d8c6">ar.h</a><li>arGetTransMatCont() ! : <a class="el" href="ar_8h.html#701276e28f11b53f13877b0316b5f6ec">ar.h</a><li>argInit() : <a class="el" href="gsub_8h.html#07b1fb9faa954efc65f5d2b8f6f637e6">gsub.h</a><li>argInqSetting() : <a class="el" href="gsub_8h.html#fc546eb5e187fe05444fa2cdf2497a1d">gsub.h</a><li>ARGL_CONTEXT_SETTINGS_REF --- 84,89 ---- : <a class="el" href="ar_8h.html#37f711816374205f2479501fd7ed9dc8">ar.h</a><li>arGetTransMat() : <a class="el" href="ar_8h.html#01eddf593ac98e4547e7131263e0d8c6">ar.h</a><li>arGetTransMatCont() ! : <a class="el" href="ar_8h.html#701276e28f11b53f13877b0316b5f6ec">ar.h</a><li>arGetVersion() ! : <a class="el" href="ar_8h.html#5f6a6f78cfce8c8dfc80479b47232eb4">ar.h</a><li>argInit() : <a class="el" href="gsub_8h.html#07b1fb9faa954efc65f5d2b8f6f637e6">gsub.h</a><li>argInqSetting() : <a class="el" href="gsub_8h.html#fc546eb5e187fe05444fa2cdf2497a1d">gsub.h</a><li>ARGL_CONTEXT_SETTINGS_REF Index: globals_func.html =================================================================== RCS file: /cvsroot/artoolkit/artoolkit/doc/globals_func.html,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** globals_func.html 22 May 2006 23:03:18 -0000 1.2 --- globals_func.html 28 Sep 2006 03:06:34 -0000 1.3 *************** *** 77,81 **** : <a class="el" href="ar_8h.html#37f711816374205f2479501fd7ed9dc8">ar.h</a><li>arGetTransMat() : <a class="el" href="ar_8h.html#01eddf593ac98e4547e7131263e0d8c6">ar.h</a><li>arGetTransMatCont() ! : <a class="el" href="ar_8h.html#701276e28f11b53f13877b0316b5f6ec">ar.h</a><li>argInit() : <a class="el" href="gsub_8h.html#07b1fb9faa954efc65f5d2b8f6f637e6">gsub.h</a><li>argInqSetting() : <a class="el" href="gsub_8h.html#fc546eb5e187fe05444fa2cdf2497a1d">gsub.h</a><li>arglCameraFrustum() --- 77,82 ---- : <a class="el" href="ar_8h.html#37f711816374205f2479501fd7ed9dc8">ar.h</a><li>arGetTransMat() : <a class="el" href="ar_8h.html#01eddf593ac98e4547e7131263e0d8c6">ar.h</a><li>arGetTransMatCont() ! : <a class="el" href="ar_8h.html#701276e28f11b53f13877b0316b5f6ec">ar.h</a><li>arGetVersion() ! : <a class="el" href="ar_8h.html#5f6a6f78cfce8c8dfc80479b47232eb4">ar.h</a><li>argInit() : <a class="el" href="gsub_8h.html#07b1fb9faa954efc65f5d2b8f6f637e6">gsub.h</a><li>argInqSetting() : <a class="el" href="gsub_8h.html#fc546eb5e187fe05444fa2cdf2497a1d">gsub.h</a><li>arglCameraFrustum() |
