joseph-aquino
/
2d-platformer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2d-platformer/vendor/SFML-3.0.0/doc/html/classsf_1_1InputStream.html

386 lines
24 KiB
HTML
Raw Blame History

<!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>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link rel="stylesheet" type="text/css" href="search/search.css" />
<link rel="stylesheet" type="text/css" href="searchOverrides.css" />
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">SFML 3.0.0</span>
</div>
</div>
<div id="content">
<div>
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="topics.html"><span>Topics</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="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.svg" 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="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacesf.html">sf</a></li><li class="navelem"><a class="el" href="classsf_1_1InputStream.html">InputStream</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classsf_1_1InputStream-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">sf::InputStream Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__system.html">System module</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Abstract class for custom file input streams.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="InputStream_8hpp_source.html">SFML/System/InputStream.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for sf::InputStream:</div>
<div class="dyncontent">
<div class="center">
<img src="classsf_1_1InputStream.png" usemap="#sf::InputStream_map" alt=""/>
<map id="sf::InputStream_map" name="sf::InputStream_map">
<area href="classsf_1_1FileInputStream.html" title="Implementation of input stream based on a file." alt="sf::FileInputStream" shape="rect" coords="0,56,140,80"/>
<area href="classsf_1_1MemoryInputStream.html" title="Implementation of input stream based on a memory chunk." alt="sf::MemoryInputStream" shape="rect" coords="150,56,290,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad13ffa81ecdae8a97b596144b7f824c3" id="r_ad13ffa81ecdae8a97b596144b7f824c3"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad13ffa81ecdae8a97b596144b7f824c3">~InputStream</a> ()=default</td></tr>
<tr class="memdesc:ad13ffa81ecdae8a97b596144b7f824c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor. <br /></td></tr>
<tr class="separator:ad13ffa81ecdae8a97b596144b7f824c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a966518d3a4cba44ae5c28847865c487d" id="r_a966518d3a4cba44ae5c28847865c487d"><td class="memItemLeft" align="right" valign="top">virtual std::optional&lt; std::size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a966518d3a4cba44ae5c28847865c487d">read</a> (void *data, std::size_t size)=0</td></tr>
<tr class="memdesc:a966518d3a4cba44ae5c28847865c487d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read data from the stream. <br /></td></tr>
<tr class="separator:a966518d3a4cba44ae5c28847865c487d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab53feb45aa824cc2117362ab79b38352" id="r_ab53feb45aa824cc2117362ab79b38352"><td class="memItemLeft" align="right" valign="top">virtual std::optional&lt; std::size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab53feb45aa824cc2117362ab79b38352">seek</a> (std::size_t position)=0</td></tr>
<tr class="memdesc:ab53feb45aa824cc2117362ab79b38352"><td class="mdescLeft">&#160;</td><td class="mdescRight">Change the current reading position. <br /></td></tr>
<tr class="separator:ab53feb45aa824cc2117362ab79b38352"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03ec284866fd46ef2a3673e022f89895" id="r_a03ec284866fd46ef2a3673e022f89895"><td class="memItemLeft" align="right" valign="top">virtual std::optional&lt; std::size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a03ec284866fd46ef2a3673e022f89895">tell</a> ()=0</td></tr>
<tr class="memdesc:a03ec284866fd46ef2a3673e022f89895"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current reading position in the stream. <br /></td></tr>
<tr class="separator:a03ec284866fd46ef2a3673e022f89895"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d735fa531dd65747f743b09331ea7c8" id="r_a2d735fa531dd65747f743b09331ea7c8"><td class="memItemLeft" align="right" valign="top">virtual std::optional&lt; std::size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2d735fa531dd65747f743b09331ea7c8">getSize</a> ()=0</td></tr>
<tr class="memdesc:a2d735fa531dd65747f743b09331ea7c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the size of the stream. <br /></td></tr>
<tr class="separator:a2d735fa531dd65747f743b09331ea7c8"><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>Abstract class for custom file input streams. </p>
<p>This class allows users to define their own file input sources from which SFML can load resources.</p>
<p>SFML resource classes like <code><a class="el" href="classsf_1_1Texture.html" title="Image living on the graphics card that can be used for drawing.">sf::Texture</a></code> and <code><a class="el" href="classsf_1_1SoundBuffer.html" title="Storage for audio samples defining a sound.">sf::SoundBuffer</a></code> provide <code>loadFromFile</code> and <code>loadFromMemory</code> functions, which read data from conventional sources. However, if you have data coming from a different source (over a network, embedded, encrypted, compressed, etc) you can derive your own class from <code><a class="el" href="classsf_1_1InputStream.html" title="Abstract class for custom file input streams.">sf::InputStream</a></code> and load SFML resources with their <code>loadFromStream</code> function.</p>
<p>Usage example: </p><div class="fragment"><div class="line"><span class="comment">// custom stream class that reads from inside a zip file</span></div>
<div class="line"><span class="keyword">class </span>ZipStream : <span class="keyword">public</span> <a class="code hl_class" href="classsf_1_1InputStream.html">sf::InputStream</a></div>
<div class="line">{</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line"> </div>
<div class="line"> ZipStream(<span class="keyword">const</span> std::string&amp; archive);</div>
<div class="line"> </div>
<div class="line"> [[nodiscard]] <span class="keywordtype">bool</span> open(<span class="keyword">const</span> std::filesystem::path&amp; filename);</div>
<div class="line"> </div>
<div class="line"> [[nodiscard]] std::optional&lt;std::size_t&gt; <a class="code hl_function" href="#a966518d3a4cba44ae5c28847865c487d">read</a>(<span class="keywordtype">void</span>* data, std::size_t size);</div>
<div class="line"> </div>
<div class="line"> [[nodiscard]] std::optional&lt;std::size_t&gt; <a class="code hl_function" href="#ab53feb45aa824cc2117362ab79b38352">seek</a>(std::size_t position);</div>
<div class="line"> </div>
<div class="line"> [[nodiscard]] std::optional&lt;std::size_t&gt; <a class="code hl_function" href="#a03ec284866fd46ef2a3673e022f89895">tell</a>();</div>
<div class="line"> </div>
<div class="line"> std::optional&lt;std::size_t&gt; <a class="code hl_function" href="#a2d735fa531dd65747f743b09331ea7c8">getSize</a>();</div>
<div class="line"> </div>
<div class="line"><span class="keyword">private</span>:</div>
<div class="line"> </div>
<div class="line"> ...</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line"><span class="comment">// now you can load textures...</span></div>
<div class="line">ZipStream stream(<span class="stringliteral">&quot;resources.zip&quot;</span>);</div>
<div class="line"> </div>
<div class="line"><span class="keywordflow">if</span> (!stream.open(<span class="stringliteral">&quot;images/img.png&quot;</span>))</div>
<div class="line">{</div>
<div class="line"> <span class="comment">// Handle error...</span></div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keyword">const</span> <a class="code hl_class" href="classsf_1_1Texture.html">sf::Texture</a> texture(stream);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// musics...</span></div>
<div class="line"><a class="code hl_class" href="classsf_1_1Music.html">sf::Music</a> music;</div>
<div class="line">ZipStream stream(<span class="stringliteral">&quot;resources.zip&quot;</span>);</div>
<div class="line"> </div>
<div class="line"><span class="keywordflow">if</span> (!stream.open(<span class="stringliteral">&quot;musics/msc.ogg&quot;</span>))</div>
<div class="line">{</div>
<div class="line"> <span class="comment">// Handle error...</span></div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordflow">if</span> (!music.<a class="code hl_function" href="classsf_1_1Music.html#a4e55d1910a26858b44778c26b237d673">openFromStream</a>(stream))</div>
<div class="line">{</div>
<div class="line"> <span class="comment">// Handle error...</span></div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="comment">// etc.</span></div>
<div class="ttc" id="aclasssf_1_1InputStream_html"><div class="ttname"><a href="classsf_1_1InputStream.html">sf::InputStream</a></div><div class="ttdoc">Abstract class for custom file input streams.</div><div class="ttdef"><b>Definition</b> <a href="InputStream_8hpp_source.html#l00045">InputStream.hpp:46</a></div></div>
<div class="ttc" id="aclasssf_1_1InputStream_html_a03ec284866fd46ef2a3673e022f89895"><div class="ttname"><a href="#a03ec284866fd46ef2a3673e022f89895">sf::InputStream::tell</a></div><div class="ttdeci">virtual std::optional&lt; std::size_t &gt; tell()=0</div><div class="ttdoc">Get the current reading position in the stream.</div></div>
<div class="ttc" id="aclasssf_1_1InputStream_html_a2d735fa531dd65747f743b09331ea7c8"><div class="ttname"><a href="#a2d735fa531dd65747f743b09331ea7c8">sf::InputStream::getSize</a></div><div class="ttdeci">virtual std::optional&lt; std::size_t &gt; getSize()=0</div><div class="ttdoc">Return the size of the stream.</div></div>
<div class="ttc" id="aclasssf_1_1InputStream_html_a966518d3a4cba44ae5c28847865c487d"><div class="ttname"><a href="#a966518d3a4cba44ae5c28847865c487d">sf::InputStream::read</a></div><div class="ttdeci">virtual std::optional&lt; std::size_t &gt; read(void *data, std::size_t size)=0</div><div class="ttdoc">Read data from the stream.</div></div>
<div class="ttc" id="aclasssf_1_1InputStream_html_ab53feb45aa824cc2117362ab79b38352"><div class="ttname"><a href="#ab53feb45aa824cc2117362ab79b38352">sf::InputStream::seek</a></div><div class="ttdeci">virtual std::optional&lt; std::size_t &gt; seek(std::size_t position)=0</div><div class="ttdoc">Change the current reading position.</div></div>
<div class="ttc" id="aclasssf_1_1Music_html"><div class="ttname"><a href="classsf_1_1Music.html">sf::Music</a></div><div class="ttdoc">Streamed music played from an audio file.</div><div class="ttdef"><b>Definition</b> <a href="Music_8hpp_source.html#l00052">Music.hpp:53</a></div></div>
<div class="ttc" id="aclasssf_1_1Music_html_a4e55d1910a26858b44778c26b237d673"><div class="ttname"><a href="classsf_1_1Music.html#a4e55d1910a26858b44778c26b237d673">sf::Music::openFromStream</a></div><div class="ttdeci">bool openFromStream(InputStream &amp;stream)</div><div class="ttdoc">Open a music from an audio file in a custom stream.</div></div>
<div class="ttc" id="aclasssf_1_1Texture_html"><div class="ttname"><a href="classsf_1_1Texture.html">sf::Texture</a></div><div class="ttdoc">Image living on the graphics card that can be used for drawing.</div><div class="ttdef"><b>Definition</b> <a href="Texture_8hpp_source.html#l00055">Texture.hpp:56</a></div></div>
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><code><a class="el" href="classsf_1_1FileInputStream.html" title="Implementation of input stream based on a file.">FileInputStream</a></code>, <code><a class="el" href="classsf_1_1MemoryInputStream.html" title="Implementation of input stream based on a memory chunk.">MemoryInputStream</a></code> </dd></dl>
<p class="definition">Definition at line <a class="el" href="InputStream_8hpp_source.html#l00045">45</a> of file <a class="el" href="InputStream_8hpp_source.html">InputStream.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad13ffa81ecdae8a97b596144b7f824c3" name="ad13ffa81ecdae8a97b596144b7f824c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad13ffa81ecdae8a97b596144b7f824c3">&#9670;&#160;</a></span>~InputStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual sf::InputStream::~InputStream </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2d735fa531dd65747f743b09331ea7c8" name="a2d735fa531dd65747f743b09331ea7c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d735fa531dd65747f743b09331ea7c8">&#9670;&#160;</a></span>getSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::optional&lt; std::size_t &gt; sf::InputStream::getSize </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the size of the stream. </p>
<dl class="section return"><dt>Returns</dt><dd>The total number of bytes available in the stream, or <code>std::nullopt</code> on error </dd></dl>
<p>Implemented in <a class="el" href="classsf_1_1FileInputStream.html#a0d3e4a80753bb4dad741e90cc67df9a1">sf::FileInputStream</a>, and <a class="el" href="classsf_1_1MemoryInputStream.html#a9d726aa826f5fff217f50147fc5da7c3">sf::MemoryInputStream</a>.</p>
</div>
</div>
<a id="a966518d3a4cba44ae5c28847865c487d" name="a966518d3a4cba44ae5c28847865c487d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a966518d3a4cba44ae5c28847865c487d">&#9670;&#160;</a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::optional&lt; std::size_t &gt; sf::InputStream::read </td>
<td>(</td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>data</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>size</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data from the stream. </p>
<p>After reading, the stream's reading position must be advanced by the amount of bytes read.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Buffer where to copy the read data </td></tr>
<tr><td class="paramname">size</td><td>Desired number of bytes to read</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes actually read, or <code>std::nullopt</code> on error </dd></dl>
<p>Implemented in <a class="el" href="classsf_1_1FileInputStream.html#a179a69a4b7acdd19000af0e32601fdca">sf::FileInputStream</a>, and <a class="el" href="classsf_1_1MemoryInputStream.html#a326c6f46abfcb93efd9657464a19d167">sf::MemoryInputStream</a>.</p>
</div>
</div>
<a id="ab53feb45aa824cc2117362ab79b38352" name="ab53feb45aa824cc2117362ab79b38352"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab53feb45aa824cc2117362ab79b38352">&#9670;&#160;</a></span>seek()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::optional&lt; std::size_t &gt; sf::InputStream::seek </td>
<td>(</td>
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>position</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Change the current reading position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>The position to seek to, from the beginning</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The position actually sought to, or <code>std::nullopt</code> on error </dd></dl>
<p>Implemented in <a class="el" href="classsf_1_1FileInputStream.html#a3e989548005120c4a3d0ae05d3efa671">sf::FileInputStream</a>, and <a class="el" href="classsf_1_1MemoryInputStream.html#a4ff6b44dddfb2589af7ed1236bd97278">sf::MemoryInputStream</a>.</p>
</div>
</div>
<a id="a03ec284866fd46ef2a3673e022f89895" name="a03ec284866fd46ef2a3673e022f89895"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03ec284866fd46ef2a3673e022f89895">&#9670;&#160;</a></span>tell()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::optional&lt; std::size_t &gt; sf::InputStream::tell </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current reading position in the stream. </p>
<dl class="section return"><dt>Returns</dt><dd>The current position, or <code>std::nullopt</code> on error. </dd></dl>
<p>Implemented in <a class="el" href="classsf_1_1FileInputStream.html#a61deec14469a0f0c568147a95d5f387c">sf::FileInputStream</a>, and <a class="el" href="classsf_1_1MemoryInputStream.html#aee76d370a82ab66d05af35f0b131756a">sf::MemoryInputStream</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="InputStream_8hpp_source.html">InputStream.hpp</a></li>
</ul>
</div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
SFML is licensed under the terms and conditions of the <a href="https://www.sfml-dev.org/license.php">zlib/png license</a>.<br />
Copyright &copy; Laurent Gomila &nbsp;::&nbsp;
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> &nbsp;::&nbsp;
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink