CDevJoud/Minecraft-Community-Edition
1
0
Fork 0
mirror of https://github.com/CDevJoud/Minecraft-Community-Edition.git synced 2026-07-16 12:20:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
78b593f8f88ec4eeea429e826b294f4afce908bc
Minecraft-Community-Edition/doc/html/_memory_input_stream_8hpp_source.html
Joud Kandeel ef7efddeef added docs
2026-04-01 20:47:40 +02:00

142 lines
12 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.16.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Minecraft Community Edition: IO/Stream/MemoryInputStream.hpp Source File</title>
<link rel="icon" href="logo channel.png" type="image/x-icon" />
<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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectrow">
<td id="projectalign">
<div id="projectname">Minecraft Community Edition<span id="projectnumber">&#160;0.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('_memory_input_stream_8hpp_source.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle"><div class="title">MemoryInputStream.hpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include &quot;InputStream.hpp&quot;</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">namespace </span>mce {</div>
<div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="classmce_1_1_memory_input_stream.html"> 13</a></span> <span class="keyword">class </span><a class="code hl_function" href="classmce_1_1_memory_input_stream.html#a6f8edd8bbe3b0fe735cce8f43f2a41b4">MemoryInputStream</a> final : <span class="keyword">public</span> <a class="code hl_class" href="classmce_1_1_input_stream.html">InputStream</a> {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_function" href="classmce_1_1_memory_input_stream.html#a6f8edd8bbe3b0fe735cce8f43f2a41b4">MemoryInputStream</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classmce_1_1_memory_input_stream.html#a11da8b6c2f59d0a5987bf06b93245bb1">read</a>(<span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> size) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classmce_1_1_memory_input_stream.html#ac3771e7c4a9f8bb4a6e10581683fb97b">readString</a>(<span class="keywordtype">char</span>*&amp; buffer, <span class="keywordtype">size_t</span>&amp; size);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classmce_1_1_memory_input_stream.html#a30df68220fde1b86deee930444e729d1">seek</a>(<span class="keywordtype">size_t</span> position) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classmce_1_1_memory_input_stream.html#a229ade412a4c8843a77d68b5a99814c0">tell</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classmce_1_1_memory_input_stream.html#a220e82b4a2096923f91b02058a354c1a">getSize</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* data = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keywordtype">size_t</span> size;</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keywordtype">size_t</span> offset; <span class="comment">// the reading position</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> };</div>
</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span>}</div>
<div class="ttc" id="aclassmce_1_1_input_stream_html"><div class="ttname"><a href="classmce_1_1_input_stream.html">mce::InputStream</a></div><div class="ttdef"><b>Definition</b> InputStream.hpp:6</div></div>
<div class="ttc" id="aclassmce_1_1_memory_input_stream_html_a11da8b6c2f59d0a5987bf06b93245bb1"><div class="ttname"><a href="classmce_1_1_memory_input_stream.html#a11da8b6c2f59d0a5987bf06b93245bb1">mce::MemoryInputStream::read</a></div><div class="ttdeci">virtual size_t read(void *buffer, size_t size) override</div><div class="ttdoc">Read bytes from the memory buffer into the provided buffer.</div><div class="ttdef"><b>Definition</b> MemoryInputStream.cpp:12</div></div>
<div class="ttc" id="aclassmce_1_1_memory_input_stream_html_a220e82b4a2096923f91b02058a354c1a"><div class="ttname"><a href="classmce_1_1_memory_input_stream.html#a220e82b4a2096923f91b02058a354c1a">mce::MemoryInputStream::getSize</a></div><div class="ttdeci">virtual size_t getSize() override</div><div class="ttdoc">Get the total size of the memory buffer.</div><div class="ttdef"><b>Definition</b> MemoryInputStream.cpp:47</div></div>
<div class="ttc" id="aclassmce_1_1_memory_input_stream_html_a229ade412a4c8843a77d68b5a99814c0"><div class="ttname"><a href="classmce_1_1_memory_input_stream.html#a229ade412a4c8843a77d68b5a99814c0">mce::MemoryInputStream::tell</a></div><div class="ttdeci">virtual size_t tell() override</div><div class="ttdoc">Get the current read position in the buffer.</div><div class="ttdef"><b>Definition</b> MemoryInputStream.cpp:41</div></div>
<div class="ttc" id="aclassmce_1_1_memory_input_stream_html_a30df68220fde1b86deee930444e729d1"><div class="ttname"><a href="classmce_1_1_memory_input_stream.html#a30df68220fde1b86deee930444e729d1">mce::MemoryInputStream::seek</a></div><div class="ttdeci">virtual size_t seek(size_t position) override</div><div class="ttdoc">Seek to an absolute position in the memory buffer.</div><div class="ttdef"><b>Definition</b> MemoryInputStream.cpp:34</div></div>
<div class="ttc" id="aclassmce_1_1_memory_input_stream_html_a6f8edd8bbe3b0fe735cce8f43f2a41b4"><div class="ttname"><a href="classmce_1_1_memory_input_stream.html#a6f8edd8bbe3b0fe735cce8f43f2a41b4">mce::MemoryInputStream::MemoryInputStream</a></div><div class="ttdeci">MemoryInputStream(const void *data, size_t size)</div><div class="ttdoc">Construct a memory input stream over existing data.</div><div class="ttdef"><b>Definition</b> MemoryInputStream.cpp:8</div></div>
<div class="ttc" id="aclassmce_1_1_memory_input_stream_html_ac3771e7c4a9f8bb4a6e10581683fb97b"><div class="ttname"><a href="classmce_1_1_memory_input_stream.html#ac3771e7c4a9f8bb4a6e10581683fb97b">mce::MemoryInputStream::readString</a></div><div class="ttdeci">size_t readString(char *&amp;buffer, size_t &amp;size)</div><div class="ttdoc">Read a NUL-terminated string from the stream.</div><div class="ttdef"><b>Definition</b> MemoryInputStream.cpp:24</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>IO</b></li><li class="navelem"><b>Stream</b></li><li class="navelem"><b>MemoryInputStream.hpp</b></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink