/usr/share/doc/libcsfml-doc/html/InputStream_8h_source.htm is in libcsfml-doc 2.3-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 | <!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>
<title>CSFML - C binding of the Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">CSFML</span>
</div>
</div>
<div id="content">
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="annotated.htm"><span>Data Structures</span></a></li>
<li class="current"><a href="files.htm"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.htm"><span>File List</span></a></li>
<li><a href="globals.htm"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.htm">include</a></li><li class="navelem"><a class="el" href="dir_c0a853e81d6f1c1f0a3eb7a27dc24256.htm">SFML</a></li><li class="navelem"><a class="el" href="dir_83d50c0b1f1eceb6f182949162e90861.htm">System</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">InputStream.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="InputStream_8h.htm">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// SFML - Simple and Fast Multimedia Library</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">//</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// This software is provided 'as-is', without any express or implied warranty.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// In no event will the authors be held liable for any damages arising from the use of this software.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// Permission is granted to anyone to use this software for any purpose,</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// including commercial applications, and to alter it and redistribute it freely,</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// subject to the following restrictions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">//</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// 1. The origin of this software must not be misrepresented;</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// you must not claim that you wrote the original software.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// If you use this software in a product, an acknowledgment</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// in the product documentation would be appreciated but is not required.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">//</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// 2. Altered source versions must be plainly marked as such,</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// and must not be misrepresented as being the original software.</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">//</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// 3. This notice may not be removed or altered from any source distribution.</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">//</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef SFML_INPUTSTREAM_H</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define SFML_INPUTSTREAM_H</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Headers</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span><span class="preprocessor">#include <<a class="code" href="System_2Export_8h.htm">SFML/System/Export.h</a>></span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="InputStream_8h.htm#a54413f8ca84d902c9cb3b779d2693853"> 34</a></span> <span class="keyword">typedef</span> <a class="code" href="Config_8h.htm#a10b5f72059b7444ded9ad782274361af">sfInt64</a> (*<a class="code" href="InputStream_8h.htm#a54413f8ca84d902c9cb3b779d2693853">sfInputStreamReadFunc</a>)(<span class="keywordtype">void</span>* data, <a class="code" href="Config_8h.htm#a10b5f72059b7444ded9ad782274361af">sfInt64</a> size, <span class="keywordtype">void</span>* userData);</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="InputStream_8h.htm#a2ac5fcb7114cbe3002dbd23e3f569c86"> 35</a></span> <span class="keyword">typedef</span> <a class="code" href="Config_8h.htm#a10b5f72059b7444ded9ad782274361af">sfInt64</a> (*<a class="code" href="InputStream_8h.htm#a2ac5fcb7114cbe3002dbd23e3f569c86">sfInputStreamSeekFunc</a>)(<a class="code" href="Config_8h.htm#a10b5f72059b7444ded9ad782274361af">sfInt64</a> position, <span class="keywordtype">void</span>* userData);</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="InputStream_8h.htm#a8bd8d780e53b02eea2dd10097316aaef"> 36</a></span> <span class="keyword">typedef</span> <a class="code" href="Config_8h.htm#a10b5f72059b7444ded9ad782274361af">sfInt64</a> (*<a class="code" href="InputStream_8h.htm#a8bd8d780e53b02eea2dd10097316aaef">sfInputStreamTellFunc</a>)(<span class="keywordtype">void</span>* userData);</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="InputStream_8h.htm#a181fdafc6fe86fa5cf5b423772e5e7e0"> 37</a></span> <span class="keyword">typedef</span> <a class="code" href="Config_8h.htm#a10b5f72059b7444ded9ad782274361af">sfInt64</a> (*<a class="code" href="InputStream_8h.htm#a181fdafc6fe86fa5cf5b423772e5e7e0">sfInputStreamGetSizeFunc</a>)(<span class="keywordtype">void</span>* userData);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structsfInputStream.htm"> 44</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structsfInputStream.htm">sfInputStream</a></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> {</div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structsfInputStream.htm#a1e0e01811d39948d88ab48fb699b35ab"> 46</a></span>  <a class="code" href="InputStream_8h.htm#a54413f8ca84d902c9cb3b779d2693853">sfInputStreamReadFunc</a> <a class="code" href="structsfInputStream.htm#a1e0e01811d39948d88ab48fb699b35ab">read</a>; </div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structsfInputStream.htm#a2cc2a43577f60e8bdf5ec996d56a61b8"> 47</a></span>  <a class="code" href="InputStream_8h.htm#a2ac5fcb7114cbe3002dbd23e3f569c86">sfInputStreamSeekFunc</a> <a class="code" href="structsfInputStream.htm#a2cc2a43577f60e8bdf5ec996d56a61b8">seek</a>; </div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structsfInputStream.htm#a77eb62116437c5e537c41251bb1a1aef"> 48</a></span>  <a class="code" href="InputStream_8h.htm#a8bd8d780e53b02eea2dd10097316aaef">sfInputStreamTellFunc</a> <a class="code" href="structsfInputStream.htm#a77eb62116437c5e537c41251bb1a1aef">tell</a>; </div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structsfInputStream.htm#a7b0547791e8623d25665f3f548c56155"> 49</a></span>  <a class="code" href="InputStream_8h.htm#a181fdafc6fe86fa5cf5b423772e5e7e0">sfInputStreamGetSizeFunc</a> <a class="code" href="structsfInputStream.htm#a7b0547791e8623d25665f3f548c56155">getSize</a>; </div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structsfInputStream.htm#a30735244b50522aef5bec127e32723da"> 50</a></span>  <span class="keywordtype">void</span>* <a class="code" href="structsfInputStream.htm#a30735244b50522aef5bec127e32723da">userData</a>; </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> } <a class="code" href="InputStream_8h.htm#aa9dcdd6f4acaf3c6dfcb6fa1569a9eb3">sfInputStream</a>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#endif // SFML_INPUTSTREAM_H</span></div><div class="ttc" id="structsfInputStream_htm_a2cc2a43577f60e8bdf5ec996d56a61b8"><div class="ttname"><a href="structsfInputStream.htm#a2cc2a43577f60e8bdf5ec996d56a61b8">sfInputStream::seek</a></div><div class="ttdeci">sfInputStreamSeekFunc seek</div><div class="ttdoc">Function to set the current read position. </div><div class="ttdef"><b>Definition:</b> <a href="InputStream_8h_source.htm#l00047">InputStream.h:47</a></div></div>
<div class="ttc" id="Config_8h_htm_a10b5f72059b7444ded9ad782274361af"><div class="ttname"><a href="Config_8h.htm#a10b5f72059b7444ded9ad782274361af">sfInt64</a></div><div class="ttdeci">signed long long sfInt64</div><div class="ttdef"><b>Definition:</b> <a href="Config_8h_source.htm#l00147">Config.h:147</a></div></div>
<div class="ttc" id="structsfInputStream_htm_a30735244b50522aef5bec127e32723da"><div class="ttname"><a href="structsfInputStream.htm#a30735244b50522aef5bec127e32723da">sfInputStream::userData</a></div><div class="ttdeci">void * userData</div><div class="ttdoc">User data that will be passed to the callbacks. </div><div class="ttdef"><b>Definition:</b> <a href="InputStream_8h_source.htm#l00050">InputStream.h:50</a></div></div>
<div class="ttc" id="structsfInputStream_htm_a77eb62116437c5e537c41251bb1a1aef"><div class="ttname"><a href="structsfInputStream.htm#a77eb62116437c5e537c41251bb1a1aef">sfInputStream::tell</a></div><div class="ttdeci">sfInputStreamTellFunc tell</div><div class="ttdoc">Function to get the current read position. </div><div class="ttdef"><b>Definition:</b> <a href="InputStream_8h_source.htm#l00048">InputStream.h:48</a></div></div>
<div class="ttc" id="InputStream_8h_htm_a54413f8ca84d902c9cb3b779d2693853"><div class="ttname"><a href="InputStream_8h.htm#a54413f8ca84d902c9cb3b779d2693853">sfInputStreamReadFunc</a></div><div class="ttdeci">sfInt64(* sfInputStreamReadFunc)(void *data, sfInt64 size, void *userData)</div><div class="ttdef"><b>Definition:</b> <a href="InputStream_8h_source.htm#l00034">InputStream.h:34</a></div></div>
<div class="ttc" id="structsfInputStream_htm"><div class="ttname"><a href="structsfInputStream.htm">sfInputStream</a></div><div class="ttdoc">Set of callbacks that allow users to define custom file streams. </div><div class="ttdef"><b>Definition:</b> <a href="InputStream_8h_source.htm#l00044">InputStream.h:44</a></div></div>
<div class="ttc" id="InputStream_8h_htm_a181fdafc6fe86fa5cf5b423772e5e7e0"><div class="ttname"><a href="InputStream_8h.htm#a181fdafc6fe86fa5cf5b423772e5e7e0">sfInputStreamGetSizeFunc</a></div><div class="ttdeci">sfInt64(* sfInputStreamGetSizeFunc)(void *userData)</div><div class="ttdef"><b>Definition:</b> <a href="InputStream_8h_source.htm#l00037">InputStream.h:37</a></div></div>
<div class="ttc" id="InputStream_8h_htm_a2ac5fcb7114cbe3002dbd23e3f569c86"><div class="ttname"><a href="InputStream_8h.htm#a2ac5fcb7114cbe3002dbd23e3f569c86">sfInputStreamSeekFunc</a></div><div class="ttdeci">sfInt64(* sfInputStreamSeekFunc)(sfInt64 position, void *userData)</div><div class="ttdef"><b>Definition:</b> <a href="InputStream_8h_source.htm#l00035">InputStream.h:35</a></div></div>
<div class="ttc" id="structsfInputStream_htm_a1e0e01811d39948d88ab48fb699b35ab"><div class="ttname"><a href="structsfInputStream.htm#a1e0e01811d39948d88ab48fb699b35ab">sfInputStream::read</a></div><div class="ttdeci">sfInputStreamReadFunc read</div><div class="ttdoc">Function to read data from the stream. </div><div class="ttdef"><b>Definition:</b> <a href="InputStream_8h_source.htm#l00046">InputStream.h:46</a></div></div>
<div class="ttc" id="System_2Export_8h_htm"><div class="ttname"><a href="System_2Export_8h.htm">Export.h</a></div></div>
<div class="ttc" id="structsfInputStream_htm_a7b0547791e8623d25665f3f548c56155"><div class="ttname"><a href="structsfInputStream.htm#a7b0547791e8623d25665f3f548c56155">sfInputStream::getSize</a></div><div class="ttdeci">sfInputStreamGetSizeFunc getSize</div><div class="ttdoc">Function to get the total number of bytes in the stream. </div><div class="ttdef"><b>Definition:</b> <a href="InputStream_8h_source.htm#l00049">InputStream.h:49</a></div></div>
<div class="ttc" id="InputStream_8h_htm_aa9dcdd6f4acaf3c6dfcb6fa1569a9eb3"><div class="ttname"><a href="InputStream_8h.htm#aa9dcdd6f4acaf3c6dfcb6fa1569a9eb3">sfInputStream</a></div><div class="ttdeci">struct sfInputStream sfInputStream</div><div class="ttdoc">Set of callbacks that allow users to define custom file streams. </div></div>
<div class="ttc" id="InputStream_8h_htm_a8bd8d780e53b02eea2dd10097316aaef"><div class="ttname"><a href="InputStream_8h.htm#a8bd8d780e53b02eea2dd10097316aaef">sfInputStreamTellFunc</a></div><div class="ttdeci">sfInt64(* sfInputStreamTellFunc)(void *userData)</div><div class="ttdef"><b>Definition:</b> <a href="InputStream_8h_source.htm#l00036">InputStream.h:36</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
Copyright © Laurent Gomila ::
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> ::
</div>
</div>
</body>
</html>
|