Sophie

Sophie

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

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_RWops Struct 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><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="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Class&#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="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structSDL__RWops-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SDL_RWops Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="SDL__rwops_8h_source.html">SDL_rwops.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a45f66dbb683a88281d96f83ca18c525f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__RWops.html#a45f66dbb683a88281d96f83ca18c525f">Sint64</a> (SDLCALL *size)(struct <a class="el" href="structSDL__RWops.html">SDL_RWops</a> *context)</td></tr>
<tr class="separator:a45f66dbb683a88281d96f83ca18c525f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a767114391a3d1b4a7c214da3e164acf5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__RWops.html#a767114391a3d1b4a7c214da3e164acf5">Sint64</a> (SDLCALL *seek)(struct <a class="el" href="structSDL__RWops.html">SDL_RWops</a> *context</td></tr>
<tr class="separator:a767114391a3d1b4a7c214da3e164acf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd9a3c6e840d285c1e30cadaf99097b2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__RWops.html#acd9a3c6e840d285c1e30cadaf99097b2">size_t</a> (SDLCALL *read)(struct <a class="el" href="structSDL__RWops.html">SDL_RWops</a> *context</td></tr>
<tr class="separator:acd9a3c6e840d285c1e30cadaf99097b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f12fd517afffba5bfaff4643d6792b1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__RWops.html#a5f12fd517afffba5bfaff4643d6792b1">size_t</a> (SDLCALL *write)(struct <a class="el" href="structSDL__RWops.html">SDL_RWops</a> *context</td></tr>
<tr class="separator:a5f12fd517afffba5bfaff4643d6792b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab303bcbb0f6742a141ba8b2998923f47"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__RWops.html#ab303bcbb0f6742a141ba8b2998923f47">int</a> (SDLCALL *close)(struct <a class="el" href="structSDL__RWops.html">SDL_RWops</a> *context)</td></tr>
<tr class="separator:ab303bcbb0f6742a141ba8b2998923f47"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab1ee9d9e4f61b3b30f26160c282ae416"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab1ee9d9e4f61b3b30f26160c282ae416"></a>
<a class="el" href="SDL__stdinc_8h.html#a2c1a61d5c466bb74680be0a8cc1b455d">Sint64</a>&#160;</td><td class="memItemRight" valign="bottom"><b>offset</b></td></tr>
<tr class="separator:ab1ee9d9e4f61b3b30f26160c282ae416"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95b96dcc6690897bfaf2d059f4378ed2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a95b96dcc6690897bfaf2d059f4378ed2"></a>
<a class="el" href="SDL__stdinc_8h.html#a2c1a61d5c466bb74680be0a8cc1b455d">Sint64</a> <a class="el" href="structSDL__RWops.html#ab303bcbb0f6742a141ba8b2998923f47">int</a>&#160;</td><td class="memItemRight" valign="bottom"><b>whence</b></td></tr>
<tr class="separator:a95b96dcc6690897bfaf2d059f4378ed2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f68b93789331775de802d51a2934f0a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f68b93789331775de802d51a2934f0a"></a>
<a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>ptr</b></td></tr>
<tr class="separator:a3f68b93789331775de802d51a2934f0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab078bcf43a916d469ff550c60ab4b3f2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab078bcf43a916d469ff550c60ab4b3f2"></a>
<a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> <a class="el" href="structSDL__RWops.html#acd9a3c6e840d285c1e30cadaf99097b2">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>size</b></td></tr>
<tr class="separator:ab078bcf43a916d469ff550c60ab4b3f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7786282ec28451085908f70048ee32c8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7786282ec28451085908f70048ee32c8"></a>
<a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> <a class="el" href="structSDL__RWops.html#acd9a3c6e840d285c1e30cadaf99097b2">size_t</a> <a class="el" href="structSDL__RWops.html#acd9a3c6e840d285c1e30cadaf99097b2">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>maxnum</b></td></tr>
<tr class="separator:a7786282ec28451085908f70048ee32c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51baff579726790887a4ca41ce14873c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a51baff579726790887a4ca41ce14873c"></a>
const <a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>ptr</b></td></tr>
<tr class="separator:a51baff579726790887a4ca41ce14873c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74d37eb068407bd5cdbdb845e4c4663a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74d37eb068407bd5cdbdb845e4c4663a"></a>
const <a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> <a class="el" href="structSDL__RWops.html#acd9a3c6e840d285c1e30cadaf99097b2">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>size</b></td></tr>
<tr class="separator:a74d37eb068407bd5cdbdb845e4c4663a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a630921d5c84cf48a4a10f9a75e1caa10"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a630921d5c84cf48a4a10f9a75e1caa10"></a>
const <a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> <a class="el" href="structSDL__RWops.html#acd9a3c6e840d285c1e30cadaf99097b2">size_t</a> <a class="el" href="structSDL__RWops.html#acd9a3c6e840d285c1e30cadaf99097b2">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>num</b></td></tr>
<tr class="separator:a630921d5c84cf48a4a10f9a75e1caa10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a099017bfceaac24ced0e4d08a4e0a023"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a099017bfceaac24ced0e4d08a4e0a023"></a>
<a class="el" href="SDL__stdinc_8h.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><b>type</b></td></tr>
<tr class="separator:a099017bfceaac24ced0e4d08a4e0a023"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bf0dec0395f771b30c841fc7296164b"><td class="memItemLeft" ><a class="anchor" id="a2bf0dec0395f771b30c841fc7296164b"></a>
union {</td></tr>
<tr class="memitem:ac027ba61657e45cfc49e1ff17692502f"><td class="memItemLeft" >
&#160;&#160;&#160;struct {</td></tr>
<tr class="memitem:aa54a2f80accacc5817e21b2eeab013e2"><td class="memItemLeft" >
&#160;&#160;&#160;&#160;&#160;&#160;SDL_bool&#160;&#160;&#160;<b>autoclose</b></td></tr>
<tr class="separator:aa54a2f80accacc5817e21b2eeab013e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62a662a6ca693515919d0fef0e452750"><td class="memItemLeft" >
&#160;&#160;&#160;&#160;&#160;&#160;FILE *&#160;&#160;&#160;<b>fp</b></td></tr>
<tr class="separator:a62a662a6ca693515919d0fef0e452750"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac027ba61657e45cfc49e1ff17692502f"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<b>stdio</b></td></tr>
<tr class="separator:ac027ba61657e45cfc49e1ff17692502f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa90f322b49b7bb649799553528dd8942"><td class="memItemLeft" >
&#160;&#160;&#160;struct {</td></tr>
<tr class="memitem:af9b6ec0e7b423bf310be30c8f9d1d5cc"><td class="memItemLeft" >
&#160;&#160;&#160;&#160;&#160;&#160;<a class="el" href="SDL__stdinc_8h.html#a2944638813a090aa23e62f4da842c3e2">Uint8</a> *&#160;&#160;&#160;<b>base</b></td></tr>
<tr class="separator:af9b6ec0e7b423bf310be30c8f9d1d5cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7e52883bb994e0f9e1da7c0a9710ec9"><td class="memItemLeft" >
&#160;&#160;&#160;&#160;&#160;&#160;<a class="el" href="SDL__stdinc_8h.html#a2944638813a090aa23e62f4da842c3e2">Uint8</a> *&#160;&#160;&#160;<b>here</b></td></tr>
<tr class="separator:ae7e52883bb994e0f9e1da7c0a9710ec9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1836e858a809a7c7f862a7001e0f0f76"><td class="memItemLeft" >
&#160;&#160;&#160;&#160;&#160;&#160;<a class="el" href="SDL__stdinc_8h.html#a2944638813a090aa23e62f4da842c3e2">Uint8</a> *&#160;&#160;&#160;<b>stop</b></td></tr>
<tr class="separator:a1836e858a809a7c7f862a7001e0f0f76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa90f322b49b7bb649799553528dd8942"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<b>mem</b></td></tr>
<tr class="separator:aa90f322b49b7bb649799553528dd8942"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44ca573858722e98e36ad347e9b414fb"><td class="memItemLeft" >
&#160;&#160;&#160;struct {</td></tr>
<tr class="memitem:a5bd3b383e2db19c7a75f3a62637217b8"><td class="memItemLeft" >
&#160;&#160;&#160;&#160;&#160;&#160;<a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> *&#160;&#160;&#160;<b>data1</b></td></tr>
<tr class="separator:a5bd3b383e2db19c7a75f3a62637217b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada8aace38b67159344aeb16425e42041"><td class="memItemLeft" >
&#160;&#160;&#160;&#160;&#160;&#160;<a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> *&#160;&#160;&#160;<b>data2</b></td></tr>
<tr class="separator:ada8aace38b67159344aeb16425e42041"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44ca573858722e98e36ad347e9b414fb"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<b>unknown</b></td></tr>
<tr class="separator:a44ca573858722e98e36ad347e9b414fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bf0dec0395f771b30c841fc7296164b"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><b>hidden</b></td></tr>
<tr class="separator:a2bf0dec0395f771b30c841fc7296164b"><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>This is the read/write operation structure &ndash; very basic. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab303bcbb0f6742a141ba8b2998923f47"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SDL_RWops::int </td>
          <td>(</td>
          <td class="paramtype">SDLCALL *&#160;</td>
          <td class="paramname"><em>close</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Close and free an allocated <a class="el" href="structSDL__RWops.html">SDL_RWops</a> structure.</p>
<dl class="section return"><dt>Returns</dt><dd>0 if successful or -1 on write error when flushing data. </dd></dl>

</div>
</div>
<a class="anchor" id="a45f66dbb683a88281d96f83ca18c525f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SDL_RWops::Sint64 </td>
          <td>(</td>
          <td class="paramtype">SDLCALL *&#160;</td>
          <td class="paramname"><em>size</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Return the size of the file in this rwops, or -1 if unknown </p>

</div>
</div>
<a class="anchor" id="a767114391a3d1b4a7c214da3e164acf5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SDL_RWops::Sint64 </td>
          <td>(</td>
          <td class="paramtype">SDLCALL *&#160;</td>
          <td class="paramname"><em>seek</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Seek to <code>offset</code> relative to <code>whence</code>, one of stdio's whence values: RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END</p>
<dl class="section return"><dt>Returns</dt><dd>the final offset in the data stream, or -1 on error. </dd></dl>

</div>
</div>
<a class="anchor" id="acd9a3c6e840d285c1e30cadaf99097b2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SDL_RWops::size_t </td>
          <td>(</td>
          <td class="paramtype">SDLCALL *&#160;</td>
          <td class="paramname"><em>read</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Read up to <code>maxnum</code> objects each of size <code>size</code> from the data stream to the area pointed at by <code>ptr</code>.</p>
<dl class="section return"><dt>Returns</dt><dd>the number of objects read, or 0 at error or end of file. </dd></dl>

</div>
</div>
<a class="anchor" id="a5f12fd517afffba5bfaff4643d6792b1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SDL_RWops::size_t </td>
          <td>(</td>
          <td class="paramtype">SDLCALL *&#160;</td>
          <td class="paramname"><em>write</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Write exactly <code>num</code> objects each of size <code>size</code> from the area pointed at by <code>ptr</code> to data stream.</p>
<dl class="section return"><dt>Returns</dt><dd>the number of objects written, or 0 at error or end of file. </dd></dl>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="SDL__rwops_8h_source.html">SDL_rwops.h</a></li>
</ul>
</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>