libcvautomation/libcvautomation-xlib_8h.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>libcvautomation: libcvautomation-xlib.h File Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script><script src="http://www.mathjax.org/mathjax/MathJax.js"></script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">libcvautomation
   &#160;<span id="projectnumber">2.0</span>
   </div>
   
  </td>
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">libcvautomation-xlib.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The source code to access Xlib from inside libcvautomation.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;<a class="el" href="libcvautomation_8h_source.html">libcvautomation/libcvautomation.h</a>&gt;</code><br/>
</div>
<p><a href="libcvautomation-xlib_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Display *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xlib_8h.html#a575e80fc9cf076026e127a57888423d4">cvaOpenDisplay</a> (char *displayName)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Simple wrapper for XOpenDisplay.  <a href="#a575e80fc9cf076026e127a57888423d4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xlib_8h.html#a65ab3bc56b956970a6b3d31c624d464a">cvaCloseDisplay</a> (Display *displayLocation)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Simple wrapper for XCloseDisplay.  <a href="#a65ab3bc56b956970a6b3d31c624d464a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xlib_8h.html#abdedf5cd2aceeda00f665747bf1eeece">matchSubImage_X11</a> (Display *displayLocation, IplImage *subImage, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the location of a sub image in the X11 root window.  <a href="#abdedf5cd2aceeda00f665747bf1eeece"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xlib_8h.html#a1d5dfa1885ffb3cc5c4f91309e9ca777">matchSubImage_X11_center</a> (Display *displayLocation, IplImage *subImage, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the center of a sub image in root X11 window, rather than the top-left corner.  <a href="#a1d5dfa1885ffb3cc5c4f91309e9ca777"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xlib_8h.html#ad67a5c4cc8b4708c8c6bb28135df92dc">matchSubImage_X11_location</a> (Display *displayLocation, const char *subImage_location, int search_method, int tolerance)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the location of a sub image in the X11 root window.  <a href="#ad67a5c4cc8b4708c8c6bb28135df92dc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xlib_8h.html#ac5fbc2afb3b53bd4788c53e16523995a">matchSubImage_X11_location_center</a> (Display *displayLocation, const char *subImage_location, int search_method, int tolerance)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the center of a sub image in the root X11 window, rather than the top-left corner.  <a href="#ac5fbc2afb3b53bd4788c53e16523995a"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The source code to access Xlib from inside libcvautomation. </p>
<p>This source file builds in the necessary functionality to use xlib functions inside libcvautomation. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Bradlee Speice </dd></dl>

<p>Definition in file <a class="el" href="libcvautomation-xlib_8h_source.html">libcvautomation-xlib.h</a>.</p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a575e80fc9cf076026e127a57888423d4"></a><!-- doxytag: member="libcvautomation&#45;xlib.h::cvaOpenDisplay" ref="a575e80fc9cf076026e127a57888423d4" args="(char *displayName)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Display * <a class="el" href="libcvautomation-xlib_8h.html#a575e80fc9cf076026e127a57888423d4">cvaOpenDisplay</a> </td>
          <td>(</td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>displayName</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Simple wrapper for XOpenDisplay. </p>
<p>Currently this function literally just passes off to XOpenDisplay, but is designed to be used in the future if extra functionality is needed. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">displayName</td><td>The name of the display to open - '' is a valid name </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the opened X11 Display </dd></dl>
<dl class="warning"><dt><b>Warning:</b></dt><dd>You must open a display to use any functions. </dd>
<dd>
The program using this library is responsible to close the display as well. </dd></dl>

</div>
</div>
<a class="anchor" id="a65ab3bc56b956970a6b3d31c624d464a"></a><!-- doxytag: member="libcvautomation&#45;xlib.h::cvaCloseDisplay" ref="a65ab3bc56b956970a6b3d31c624d464a" args="(Display *displayLocation)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="libcvautomation-xlib_8h.html#a65ab3bc56b956970a6b3d31c624d464a">cvaCloseDisplay</a> </td>
          <td>(</td>
          <td class="paramtype">Display *&#160;</td>
          <td class="paramname"><em>displayLocation</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Simple wrapper for XCloseDisplay. </p>
<p>Currently this function literally just passes off to XCloseDisplay, but is designed to be used in the future if extra functionality is needed. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">displayLocation</td><td>Pointer to the display to close </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing </dd></dl>

</div>
</div>
<a class="anchor" id="abdedf5cd2aceeda00f665747bf1eeece"></a><!-- doxytag: member="libcvautomation&#45;xlib.h::matchSubImage_X11" ref="abdedf5cd2aceeda00f665747bf1eeece" args="(Display *displayLocation, IplImage *subImage, int searchMethod, int tolerance)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structcvaPoint.html">cvaPoint</a> <a class="el" href="libcvautomation-xlib_8h.html#abdedf5cd2aceeda00f665747bf1eeece">matchSubImage_X11</a> </td>
          <td>(</td>
          <td class="paramtype">Display *&#160;</td>
          <td class="paramname"><em>displayLocation</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IplImage *&#160;</td>
          <td class="paramname"><em>subImage</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>searchMethod</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>tolerance</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return the location of a sub image in the X11 root window. </p>
<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#ad37dfe0e025507d2437ea297232e8265" title="Return the location of a sub image in its root image.">matchSubImage()</a> </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">displayLocation</td><td>Pointer to the currently open X11 Display </td></tr>
    <tr><td class="paramname">subImage</td><td>The sub image (in IplImage format) to search for in the root X11 window </td></tr>
    <tr><td class="paramname">searchMethod</td><td>The search method to use when searching for <code>subImage</code> in the root X11 window </td></tr>
    <tr><td class="paramname">tolerance</td><td>The tolerance to use when searching for <code>subImage</code> in the root X11 window </td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The location of the sub image in root X11 window </dd></dl>

</div>
</div>
<a class="anchor" id="a1d5dfa1885ffb3cc5c4f91309e9ca777"></a><!-- doxytag: member="libcvautomation&#45;xlib.h::matchSubImage_X11_center" ref="a1d5dfa1885ffb3cc5c4f91309e9ca777" args="(Display *displayLocation, IplImage *subImage, int searchMethod, int tolerance)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structcvaPoint.html">cvaPoint</a> <a class="el" href="libcvautomation-xlib_8h.html#a1d5dfa1885ffb3cc5c4f91309e9ca777">matchSubImage_X11_center</a> </td>
          <td>(</td>
          <td class="paramtype">Display *&#160;</td>
          <td class="paramname"><em>displayLocation</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IplImage *&#160;</td>
          <td class="paramname"><em>subImage</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>searchMethod</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>tolerance</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></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>
<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#a0f847f63a736bddcc78ebf857be0813f" title="Return the center of a sub image in its root image, rather than the top-left corner.">matchSubImage_center()</a> </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">displayLocation</td><td>Pointer to the currently open X11 Display </td></tr>
    <tr><td class="paramname">subImage</td><td>The sub image (in IplImage format) to search for in the root X11 window </td></tr>
    <tr><td class="paramname">searchMethod</td><td>The search method to use when searching for <code>subImage</code> in the root X11 window </td></tr>
    <tr><td class="paramname">tolerance</td><td>The tolerance to use when searching for <code>subImage</code> in the root X11 window </td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The center location of the sub image in the root X11 window </dd></dl>

</div>
</div>
<a class="anchor" id="ad67a5c4cc8b4708c8c6bb28135df92dc"></a><!-- doxytag: member="libcvautomation&#45;xlib.h::matchSubImage_X11_location" ref="ad67a5c4cc8b4708c8c6bb28135df92dc" 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"><a class="el" href="structcvaPoint.html">cvaPoint</a> <a class="el" href="libcvautomation-xlib_8h.html#ad67a5c4cc8b4708c8c6bb28135df92dc">matchSubImage_X11_location</a> </td>
          <td>(</td>
          <td class="paramtype">Display *&#160;</td>
          <td class="paramname"><em>displayLocation</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>subImage_location</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>searchMethod</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>tolerance</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return the location of a sub image in the X11 root window. </p>
<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#a938c40be84667f64b51c8f1fa3725b43" title="Return the location of a sub image in its root image.">matchSubImage_location()</a> </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">displayLocation</td><td>Pointer to the currently open X11 Display </td></tr>
    <tr><td class="paramname">subImage_location</td><td>The location of the sub image to search for in the root X11 window </td></tr>
    <tr><td class="paramname">searchMethod</td><td>The search method to use when searching for <code>subImage</code> in the root X11 window </td></tr>
    <tr><td class="paramname">tolerance</td><td>The tolerance to use when searching for <code>subImage</code> in the root X11 window </td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The center location of the sub image in the root X11 window </dd></dl>

</div>
</div>
<a class="anchor" id="ac5fbc2afb3b53bd4788c53e16523995a"></a><!-- doxytag: member="libcvautomation&#45;xlib.h::matchSubImage_X11_location_center" ref="ac5fbc2afb3b53bd4788c53e16523995a" 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"><a class="el" href="structcvaPoint.html">cvaPoint</a> <a class="el" href="libcvautomation-xlib_8h.html#ac5fbc2afb3b53bd4788c53e16523995a">matchSubImage_X11_location_center</a> </td>
          <td>(</td>
          <td class="paramtype">Display *&#160;</td>
          <td class="paramname"><em>displayLocation</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>subImage_location</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>searchMethod</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>tolerance</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></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>
<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#a0403ac35c77946e86f6436fd891fa6ac" title="Return the center of a sub image in its root image, rather than the top-left corner.">matchSubImage_location_center()</a> </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">displayLocation</td><td>Pointer to the currently open X11 Display </td></tr>
    <tr><td class="paramname">subImage_location</td><td>The location of the sub image to search for in the root X11 window </td></tr>
    <tr><td class="paramname">searchMethod</td><td>The search method to use when searching for <code>subImage</code> in the root X11 window </td></tr>
    <tr><td class="paramname">tolerance</td><td>The tolerance to use when searching for <code>subImage</code> in the root X11 window </td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The center location of the sub image in the root X11 window </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>


<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 11 2012 17:42:49 for libcvautomation by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>