mirror-github-bspeice/libcvautomation
1
0
Fork 0
mirror of https://github.com/bspeice/libcvautomation synced 2025-01-09 15:30:05 -05:00
Code Issues Releases Wiki Activity
810e4e9fe8
libcvautomation/libcvautomation-xlib_8h.html
Bradlee Speice 810e4e9fe8 Release version 1.1 Documentation
2012-07-17 16:07:18 -04:00

342 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libcvautomation: libcvautomation-xlib.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<h1>libcvautomation-xlib.h File Reference</h1>The source code to access Xlib from inside libcvautomation. <a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="libcvautomation_8h-source.html">libcvautomation/libcvautomation.h</a>&gt;</code><br>
<p>
<a href="libcvautomation-xlib_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">Display *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xlib_8h.html#a6e348c2e829e1addb446160f54723a0">cvaOpenDisplay</a> (char *displayName)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Simple wrapper for XOpenDisplay. <a href="#a6e348c2e829e1addb446160f54723a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xlib_8h.html#1c8a205c0b2f4f7a28d1ce51d5225871">cvaCloseDisplay</a> (Display *displayLocation)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Simple wrapper for XCloseDisplay. <a href="#1c8a205c0b2f4f7a28d1ce51d5225871"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">CvPoint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xlib_8h.html#8fbf1f5f968670a03c4c8e31f5afdaed">matchSubImage_X11</a> (Display *displayLocation, IplImage *subImage, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the location of a sub image in the X11 root window. <a href="#8fbf1f5f968670a03c4c8e31f5afdaed"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">CvPoint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xlib_8h.html#fb70c8eec779a6696b3df5af5bca1a6d">matchSubImage_X11_center</a> (Display *displayLocation, IplImage *subImage, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the center of a sub image in root X11 window, rather than the top-left corner. <a href="#fb70c8eec779a6696b3df5af5bca1a6d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">CvPoint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xlib_8h.html#d238842448af81c09f56d1d54253c1b5">matchSubImage_X11_location</a> (Display *displayLocation, const char *subImage_location, int search_method, int tolerance)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the location of a sub image in the X11 root window. <a href="#d238842448af81c09f56d1d54253c1b5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">CvPoint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xlib_8h.html#b441627acd22889f404d89c9cc4809f5">matchSubImage_X11_location_center</a> (Display *displayLocation, const char *subImage_location, int search_method, int tolerance)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the center of a sub image in the root X11 window, rather than the top-left corner. <a href="#b441627acd22889f404d89c9cc4809f5"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The source code to access Xlib from inside libcvautomation.
<p>
This source file builds in the necessary functionality to use libcv functions inside libcvautomation. <dl compact><dt><b>Author:</b></dt><dd>Bradlee Speice </dd></dl>
<dl compact><dt><b>Date:</b></dt><dd>6/21/2012 </dd></dl>
<p>
Definition in file <a class="el" href="libcvautomation-xlib_8h-source.html">libcvautomation-xlib.h</a>.<hr><h2>Function Documentation</h2>
<a class="anchor" name="a6e348c2e829e1addb446160f54723a0"></a><!-- doxytag: member="libcvautomation-xlib.h::cvaOpenDisplay" ref="a6e348c2e829e1addb446160f54723a0" args="(char *displayName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Display * cvaOpenDisplay </td>
<td>(</td>
<td class="paramtype">char *&nbsp;</td>
<td class="paramname"> <em>displayName</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Simple wrapper for XOpenDisplay.
<p>
Currently this function literally just passes off to XOpenDisplay, but is designed to be used in the future if extra functionality is needed. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayName</em>&nbsp;</td><td>The name of the display to open - '' is a valid name </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Pointer to the opened X11 Display </dd></dl>
</div>
</div><p>
<a class="anchor" name="1c8a205c0b2f4f7a28d1ce51d5225871"></a><!-- doxytag: member="libcvautomation-xlib.h::cvaCloseDisplay" ref="1c8a205c0b2f4f7a28d1ce51d5225871" args="(Display *displayLocation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cvaCloseDisplay </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Simple wrapper for XCloseDisplay.
<p>
Currently this function literally just passes off to XCloseDisplay, but is designed to be used in the future if extra functionality is needed. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>Pointer to the display to close </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Nothing </dd></dl>
</div>
</div><p>
<a class="anchor" name="8fbf1f5f968670a03c4c8e31f5afdaed"></a><!-- doxytag: member="libcvautomation-xlib.h::matchSubImage_X11" ref="8fbf1f5f968670a03c4c8e31f5afdaed" args="(Display *displayLocation, IplImage *subImage, int searchMethod, int tolerance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CvPoint matchSubImage_X11 </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IplImage *&nbsp;</td>
<td class="paramname"> <em>subImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>tolerance</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the location of a sub image in the X11 root window.
<p>
This function wraps grabbing the X11 root window, converting it to IplImage format, and then giving this to <a class="el" href="libcvautomation-opencv_8h.html#297b9b5b22f77b65308d4057cff845f7">matchSubImage()</a> <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>Pointer to the currently open X11 Display </td></tr>
<tr><td valign="top"></td><td valign="top"><em>subImage</em>&nbsp;</td><td>The sub image (in IplImage format) to search for in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>searchMethod</em>&nbsp;</td><td>The search method to use when searching for <code>subImage</code> in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tolerance</em>&nbsp;</td><td>The tolerance to use when searching for <code>subImage</code> in the root X11 window </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd>libcv_search_methods </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The location of the sub image in root X11 window </dd></dl>
</div>
</div><p>
<a class="anchor" name="fb70c8eec779a6696b3df5af5bca1a6d"></a><!-- doxytag: member="libcvautomation-xlib.h::matchSubImage_X11_center" ref="fb70c8eec779a6696b3df5af5bca1a6d" args="(Display *displayLocation, IplImage *subImage, int searchMethod, int tolerance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CvPoint matchSubImage_X11_center </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IplImage *&nbsp;</td>
<td class="paramname"> <em>subImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>tolerance</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the center of a sub image in root X11 window, rather than the top-left corner.
<p>
This function wraps grabbing the X11 root window, converting it to IplImage format, and then giving this to <a class="el" href="libcvautomation-opencv_8h.html#5bf9db7dfc5674e40180937b0c7787f3">matchSubImage_center()</a> <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>Pointer to the currently open X11 Display </td></tr>
<tr><td valign="top"></td><td valign="top"><em>subImage</em>&nbsp;</td><td>The sub image (in IplImage format) to search for in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>searchMethod</em>&nbsp;</td><td>The search method to use when searching for <code>subImage</code> in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tolerance</em>&nbsp;</td><td>The tolerance to use when searching for <code>subImage</code> in the root X11 window </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd>libcv_search_methods </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The center location of the sub image in the root X11 window </dd></dl>
</div>
</div><p>
<a class="anchor" name="d238842448af81c09f56d1d54253c1b5"></a><!-- doxytag: member="libcvautomation-xlib.h::matchSubImage_X11_location" ref="d238842448af81c09f56d1d54253c1b5" args="(Display *displayLocation, const char *subImage_location, int search_method, int tolerance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CvPoint matchSubImage_X11_location </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>subImage_location</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>tolerance</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the location of a sub image in the X11 root window.
<p>
This function wraps grabbing the X11 root window, converting it to IplImage format, and then giving this to <a class="el" href="libcvautomation-opencv_8h.html#c0d3066da6b2d42251c876d12a7158c7">matchSubImage_location()</a> <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>Pointer to the currently open X11 Display </td></tr>
<tr><td valign="top"></td><td valign="top"><em>subImage_location</em>&nbsp;</td><td>The location of the sub image to search for in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>searchMethod</em>&nbsp;</td><td>The search method to use when searching for <code>subImage</code> in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tolerance</em>&nbsp;</td><td>The tolerance to use when searching for <code>subImage</code> in the root X11 window </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd>libcv_search_methods </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The center location of the sub image in the root X11 window </dd></dl>
<p>
Referenced by <a class="el" href="cva-match_8c-source.html#l00035">main()</a>.
</div>
</div><p>
<a class="anchor" name="b441627acd22889f404d89c9cc4809f5"></a><!-- doxytag: member="libcvautomation-xlib.h::matchSubImage_X11_location_center" ref="b441627acd22889f404d89c9cc4809f5" args="(Display *displayLocation, const char *subImage_location, int search_method, int tolerance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CvPoint matchSubImage_X11_location_center </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>subImage_location</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>tolerance</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the center of a sub image in the root X11 window, rather than the top-left corner.
<p>
This function wraps grabbing the X11 root window, converting it to IplImage format, and then giving this to <a class="el" href="libcvautomation-opencv_8h.html#bed7c891adb272993912d973c0e08c27">matchSubImage_location_center()</a> <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>Pointer to the currently open X11 Display </td></tr>
<tr><td valign="top"></td><td valign="top"><em>subImage_location</em>&nbsp;</td><td>The location of the sub image to search for in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>searchMethod</em>&nbsp;</td><td>The search method to use when searching for <code>subImage</code> in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tolerance</em>&nbsp;</td><td>The tolerance to use when searching for <code>subImage</code> in the root X11 window </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd>libcv_search_methods </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The center location of the sub image in the root X11 window </dd></dl>
<p>
Referenced by <a class="el" href="cva-match_8c-source.html#l00035">main()</a>.
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Tue Jul 17 12:19:00 2012 for libcvautomation by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink