_s_d_l__visualtest__screenshot_8h.html (10377B)
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xmlns="http://www.w3.org/1999/xhtml"> 3<head> 4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5<meta http-equiv="X-UA-Compatible" content="IE=9"/> 6<meta name="generator" content="Doxygen 1.8.4"/> 7<title>SDL Visual Test: C:/Users/DELL/Work/sdlvisualtest/visualtest/include/SDL_visualtest_screenshot.h File Reference</title> 8<link href="tabs.css" rel="stylesheet" type="text/css"/> 9<script type="text/javascript" src="jquery.js"></script> 10<script type="text/javascript" src="dynsections.js"></script> 11<link href="search/search.css" rel="stylesheet" type="text/css"/> 12<script type="text/javascript" src="search/search.js"></script> 13<script type="text/javascript"> 14 $(document).ready(function() { searchBox.OnSelectItem(0); }); 15</script> 16<link href="doxygen.css" rel="stylesheet" type="text/css" /> 17</head> 18<body> 19<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 20<div id="titlearea"> 21<table cellspacing="0" cellpadding="0"> 22 <tbody> 23 <tr style="height: 56px;"> 24 <td style="padding-left: 0.5em;"> 25 <div id="projectname">SDL Visual Test 26 </div> 27 </td> 28 </tr> 29 </tbody> 30</table> 31</div> 32<!-- end header part --> 33<!-- Generated by Doxygen 1.8.4 --> 34<script type="text/javascript"> 35var searchBox = new SearchBox("searchBox", "search",false,'Search'); 36</script> 37 <div id="navrow1" class="tabs"> 38 <ul class="tablist"> 39 <li><a href="index.html"><span>Main Page</span></a></li> 40 <li><a href="annotated.html"><span>Data Structures</span></a></li> 41 <li class="current"><a href="files.html"><span>Files</span></a></li> 42 <li> 43 <div id="MSearchBox" class="MSearchBoxInactive"> 44 <span class="left"> 45 <img id="MSearchSelect" src="search/mag_sel.png" 46 onmouseover="return searchBox.OnSearchSelectShow()" 47 onmouseout="return searchBox.OnSearchSelectHide()" 48 alt=""/> 49 <input type="text" id="MSearchField" value="Search" accesskey="S" 50 onfocus="searchBox.OnSearchFieldFocus(true)" 51 onblur="searchBox.OnSearchFieldFocus(false)" 52 onkeyup="searchBox.OnSearchFieldChange(event)"/> 53 </span><span class="right"> 54 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> 55 </span> 56 </div> 57 </li> 58 </ul> 59 </div> 60 <div id="navrow2" class="tabs2"> 61 <ul class="tablist"> 62 <li><a href="files.html"><span>File List</span></a></li> 63 <li><a href="globals.html"><span>Globals</span></a></li> 64 </ul> 65 </div> 66<!-- window showing the filter options --> 67<div id="MSearchSelectWindow" 68 onmouseover="return searchBox.OnSearchSelectShow()" 69 onmouseout="return searchBox.OnSearchSelectHide()" 70 onkeydown="return searchBox.OnSearchSelectKey(event)"> 71<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div> 72 73<!-- iframe showing the search results (closed by default) --> 74<div id="MSearchResultsWindow"> 75<iframe src="javascript:void(0)" frameborder="0" 76 name="MSearchResults" id="MSearchResults"> 77</iframe> 78</div> 79 80<div id="nav-path" class="navpath"> 81 <ul> 82<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul> 83</div> 84</div><!-- top --> 85<div class="header"> 86 <div class="summary"> 87<a href="#define-members">Macros</a> | 88<a href="#func-members">Functions</a> </div> 89 <div class="headertitle"> 90<div class="title">SDL_visualtest_screenshot.h File Reference</div> </div> 91</div><!--header--> 92<div class="contents"> 93<div class="textblock"><code>#include "<a class="el" href="_s_d_l__visualtest__process_8h_source.html">SDL_visualtest_process.h</a>"</code><br/> 94</div> 95<p><a href="_s_d_l__visualtest__screenshot_8h_source.html">Go to the source code of this file.</a></p> 96<table class="memberdecls"> 97<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 98Functions</h2></td></tr> 99<tr class="memitem:aefe6b7dbca1fbfb7aef081545c3ca66d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__screenshot_8h.html#aefe6b7dbca1fbfb7aef081545c3ca66d">SDLVisualTest_ScreenshotProcess</a> (<a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> *pinfo, char *prefix)</td></tr> 100<tr class="separator:aefe6b7dbca1fbfb7aef081545c3ca66d"><td class="memSeparator" colspan="2"> </td></tr> 101<tr class="memitem:a812c545e97db11a756145d43b3a8e5ee"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__screenshot_8h.html#a812c545e97db11a756145d43b3a8e5ee">SDLVisualTest_ScreenshotDesktop</a> (char *filename)</td></tr> 102<tr class="separator:a812c545e97db11a756145d43b3a8e5ee"><td class="memSeparator" colspan="2"> </td></tr> 103<tr class="memitem:ac7b5335651144961676abc2116c38299"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__screenshot_8h.html#ac7b5335651144961676abc2116c38299">SDLVisualTest_VerifyScreenshots</a> (char *args, char *test_dir, char *verify_dir)</td></tr> 104<tr class="separator:ac7b5335651144961676abc2116c38299"><td class="memSeparator" colspan="2"> </td></tr> 105</table> 106<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 107<div class="textblock"><p>Header for the screenshot API. </p> 108</div><h2 class="groupheader">Function Documentation</h2> 109<a class="anchor" id="a812c545e97db11a756145d43b3a8e5ee"></a> 110<div class="memitem"> 111<div class="memproto"> 112 <table class="memname"> 113 <tr> 114 <td class="memname">int SDLVisualTest_ScreenshotDesktop </td> 115 <td>(</td> 116 <td class="paramtype">char * </td> 117 <td class="paramname"><em>filename</em>)</td><td></td> 118 <td></td> 119 </tr> 120 </table> 121</div><div class="memdoc"> 122<p>Takes a screenshot of the desktop and saves it into the file with path <code>filename</code>.</p> 123<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl> 124 125</div> 126</div> 127<a class="anchor" id="aefe6b7dbca1fbfb7aef081545c3ca66d"></a> 128<div class="memitem"> 129<div class="memproto"> 130 <table class="memname"> 131 <tr> 132 <td class="memname">int SDLVisualTest_ScreenshotProcess </td> 133 <td>(</td> 134 <td class="paramtype"><a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> * </td> 135 <td class="paramname"><em>pinfo</em>, </td> 136 </tr> 137 <tr> 138 <td class="paramkey"></td> 139 <td></td> 140 <td class="paramtype">char * </td> 141 <td class="paramname"><em>prefix</em> </td> 142 </tr> 143 <tr> 144 <td></td> 145 <td>)</td> 146 <td></td><td></td> 147 </tr> 148 </table> 149</div><div class="memdoc"> 150<p>Takes a screenshot of each window owned by the process <code>pinfo</code> and saves it in a file <code>prefix-i.png</code> where <code>prefix</code> is the full path to the file along with a prefix given to each screenshot.</p> 151<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl> 152 153</div> 154</div> 155<a class="anchor" id="ac7b5335651144961676abc2116c38299"></a> 156<div class="memitem"> 157<div class="memproto"> 158 <table class="memname"> 159 <tr> 160 <td class="memname">int SDLVisualTest_VerifyScreenshots </td> 161 <td>(</td> 162 <td class="paramtype">char * </td> 163 <td class="paramname"><em>args</em>, </td> 164 </tr> 165 <tr> 166 <td class="paramkey"></td> 167 <td></td> 168 <td class="paramtype">char * </td> 169 <td class="paramname"><em>test_dir</em>, </td> 170 </tr> 171 <tr> 172 <td class="paramkey"></td> 173 <td></td> 174 <td class="paramtype">char * </td> 175 <td class="paramname"><em>verify_dir</em> </td> 176 </tr> 177 <tr> 178 <td></td> 179 <td>)</td> 180 <td></td><td></td> 181 </tr> 182 </table> 183</div><div class="memdoc"> 184<p>Compare a screenshot taken previously with SUT arguments <code>args</code> that is located in <code>test_dir</code> with a verification image that is located in <code>verify_dir</code>.</p> 185<dl class="section return"><dt>Returns</dt><dd>-1 on failure, 0 if the images were not equal, 1 if the images are equal and 2 if the verification image is not present. </dd></dl> 186 187</div> 188</div> 189</div><!-- contents --> 190<!-- start footer part --> 191<hr class="footer"/><address class="footer"><small> 192Generated on Thu Sep 26 2013 00:18:23 for SDL Visual Test by  <a href="http://www.doxygen.org/index.html"> 193<img class="footer" src="doxygen.png" alt="doxygen"/> 194</a> 1.8.4 195</small></address> 196</body> 197</html>