Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 7281b619e6b612f5388cfad6b0e56530 > files > 102

sdl2-docs-2.0.3-4.mga5.noarch.rpm

<!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"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>My Project: SDL_test_common.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">My Project
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<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="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>
<!-- 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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</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>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">SDL_test_common.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="SDL_8h_source.html">SDL.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="begin__code_8h_source.html">begin_code.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="close__code_8h_source.html">close_code.h</a>&quot;</code><br />
</div>
<p><a href="SDL__test__common_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDLTest__CommonState.html">SDLTest_CommonState</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a6ca4df6b9e1495a80a2929a5187cb9b9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ca4df6b9e1495a80a2929a5187cb9b9"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_WINDOW_WIDTH</b>&#160;&#160;&#160;640</td></tr>
<tr class="separator:a6ca4df6b9e1495a80a2929a5187cb9b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a030ebc610fddb0a18d62829ab376bf85"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a030ebc610fddb0a18d62829ab376bf85"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_WINDOW_HEIGHT</b>&#160;&#160;&#160;480</td></tr>
<tr class="separator:a030ebc610fddb0a18d62829ab376bf85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5d2ba75c3cd702f1a269c406902ddcb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5d2ba75c3cd702f1a269c406902ddcb"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>VERBOSE_VIDEO</b>&#160;&#160;&#160;0x00000001</td></tr>
<tr class="separator:ab5d2ba75c3cd702f1a269c406902ddcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a535ac3889907ff97e556a3cae117cc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a535ac3889907ff97e556a3cae117cc"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>VERBOSE_MODES</b>&#160;&#160;&#160;0x00000002</td></tr>
<tr class="separator:a3a535ac3889907ff97e556a3cae117cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7bdcd39423e8261d05407ab758feb037"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7bdcd39423e8261d05407ab758feb037"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>VERBOSE_RENDER</b>&#160;&#160;&#160;0x00000004</td></tr>
<tr class="separator:a7bdcd39423e8261d05407ab758feb037"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e5a47c9aaa54a2b134b0066f48b4e0c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e5a47c9aaa54a2b134b0066f48b4e0c"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>VERBOSE_EVENT</b>&#160;&#160;&#160;0x00000008</td></tr>
<tr class="separator:a3e5a47c9aaa54a2b134b0066f48b4e0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab607cbf4694150235976fc1ef6e68387"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab607cbf4694150235976fc1ef6e68387"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>VERBOSE_AUDIO</b>&#160;&#160;&#160;0x00000010</td></tr>
<tr class="separator:ab607cbf4694150235976fc1ef6e68387"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8752973417c10ede61c07fba67c65f7a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structSDLTest__CommonState.html">SDLTest_CommonState</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__test__common_8h.html#a8752973417c10ede61c07fba67c65f7a">SDLTest_CommonCreateState</a> (char **argv, <a class="el" href="SDL__stdinc_8h.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> flags)</td></tr>
<tr class="memdesc:a8752973417c10ede61c07fba67c65f7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse command line parameters and create common state.  <a href="#a8752973417c10ede61c07fba67c65f7a">More...</a><br /></td></tr>
<tr class="separator:a8752973417c10ede61c07fba67c65f7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ffe001ae2299720a92b80812dbc48b9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__test__common_8h.html#a6ffe001ae2299720a92b80812dbc48b9">SDLTest_CommonArg</a> (<a class="el" href="structSDLTest__CommonState.html">SDLTest_CommonState</a> *state, <a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> index)</td></tr>
<tr class="memdesc:a6ffe001ae2299720a92b80812dbc48b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process one common argument.  <a href="#a6ffe001ae2299720a92b80812dbc48b9">More...</a><br /></td></tr>
<tr class="separator:a6ffe001ae2299720a92b80812dbc48b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71ea0036b194df15caae753ca03825b1"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__test__common_8h.html#a71ea0036b194df15caae753ca03825b1">SDLTest_CommonUsage</a> (<a class="el" href="structSDLTest__CommonState.html">SDLTest_CommonState</a> *state)</td></tr>
<tr class="memdesc:a71ea0036b194df15caae753ca03825b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns common usage information.  <a href="#a71ea0036b194df15caae753ca03825b1">More...</a><br /></td></tr>
<tr class="separator:a71ea0036b194df15caae753ca03825b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7405405819a77e317a1edda6be974187"><td class="memItemLeft" align="right" valign="top">SDL_bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__test__common_8h.html#a7405405819a77e317a1edda6be974187">SDLTest_CommonInit</a> (<a class="el" href="structSDLTest__CommonState.html">SDLTest_CommonState</a> *state)</td></tr>
<tr class="memdesc:a7405405819a77e317a1edda6be974187"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open test window.  <a href="#a7405405819a77e317a1edda6be974187">More...</a><br /></td></tr>
<tr class="separator:a7405405819a77e317a1edda6be974187"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5fb0eb864d62d6d9f6d932c9abccd1f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__test__common_8h.html#a5fb0eb864d62d6d9f6d932c9abccd1f4">SDLTest_CommonEvent</a> (<a class="el" href="structSDLTest__CommonState.html">SDLTest_CommonState</a> *state, <a class="el" href="unionSDL__Event.html">SDL_Event</a> *<a class="el" href="unionSDL__Event.html">event</a>, <a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> *done)</td></tr>
<tr class="memdesc:a5fb0eb864d62d6d9f6d932c9abccd1f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Common event handler for test windows.  <a href="#a5fb0eb864d62d6d9f6d932c9abccd1f4">More...</a><br /></td></tr>
<tr class="separator:a5fb0eb864d62d6d9f6d932c9abccd1f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d24c255140a7e90c753eb363ef4d96e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__test__common_8h.html#a2d24c255140a7e90c753eb363ef4d96e">SDLTest_CommonQuit</a> (<a class="el" href="structSDLTest__CommonState.html">SDLTest_CommonState</a> *state)</td></tr>
<tr class="memdesc:a2d24c255140a7e90c753eb363ef4d96e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close test window.  <a href="#a2d24c255140a7e90c753eb363ef4d96e">More...</a><br /></td></tr>
<tr class="separator:a2d24c255140a7e90c753eb363ef4d96e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Include file for SDL test framework.</p>
<p>This code is a part of the SDL2_test library, not the main SDL library. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a6ffe001ae2299720a92b80812dbc48b9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> SDLTest_CommonArg </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structSDLTest__CommonState.html">SDLTest_CommonState</a> *&#160;</td>
          <td class="paramname"><em>state</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a>&#160;</td>
          <td class="paramname"><em>index</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Process one common argument. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">state</td><td>The common state describing the test window to create. </td></tr>
    <tr><td class="paramname">index</td><td>The index of the argument to process in argv[].</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of arguments processed (i.e. 1 for &ndash;fullscreen, 2 for &ndash;video [videodriver], or -1 on error. </dd></dl>

</div>
</div>
<a class="anchor" id="a8752973417c10ede61c07fba67c65f7a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structSDLTest__CommonState.html">SDLTest_CommonState</a>* SDLTest_CommonCreateState </td>
          <td>(</td>
          <td class="paramtype">char **&#160;</td>
          <td class="paramname"><em>argv</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="SDL__stdinc_8h.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a>&#160;</td>
          <td class="paramname"><em>flags</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Parse command line parameters and create common state. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">argv</td><td>Array of command line parameters </td></tr>
    <tr><td class="paramname">flags</td><td>Flags indicating which subsystem to initialize (i.e. SDL_INIT_VIDEO | SDL_INIT_AUDIO)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a newly allocated common state object. </dd></dl>

</div>
</div>
<a class="anchor" id="a5fb0eb864d62d6d9f6d932c9abccd1f4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> SDLTest_CommonEvent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structSDLTest__CommonState.html">SDLTest_CommonState</a> *&#160;</td>
          <td class="paramname"><em>state</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="unionSDL__Event.html">SDL_Event</a> *&#160;</td>
          <td class="paramname"><em>event</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> *&#160;</td>
          <td class="paramname"><em>done</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Common event handler for test windows. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">state</td><td>The common state used to create test window. </td></tr>
    <tr><td class="paramname">event</td><td>The event to handle. </td></tr>
    <tr><td class="paramname">done</td><td>Flag indicating we are done. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a7405405819a77e317a1edda6be974187"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SDL_bool SDLTest_CommonInit </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structSDLTest__CommonState.html">SDLTest_CommonState</a> *&#160;</td>
          <td class="paramname"><em>state</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Open test window. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">state</td><td>The common state describing the test window to create.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if initialization succeeded, false otherwise </dd></dl>

</div>
</div>
<a class="anchor" id="a2d24c255140a7e90c753eb363ef4d96e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> SDLTest_CommonQuit </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structSDLTest__CommonState.html">SDLTest_CommonState</a> *&#160;</td>
          <td class="paramname"><em>state</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Close test window. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">state</td><td>The common state used to create test window. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a71ea0036b194df15caae753ca03825b1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* SDLTest_CommonUsage </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structSDLTest__CommonState.html">SDLTest_CommonState</a> *&#160;</td>
          <td class="paramname"><em>state</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns common usage information. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">state</td><td>The common state describing the test window to create.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>String with usage information </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 16 2014 16:33:09 for My Project by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>