libAthena
/
athena
mirror of https://github.com/libAthena/athena.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
athena/_memory_writer_8hpp_source....

135 lines
26 KiB
HTML
Raw Normal View History

Update docs
2016-09-17 20:12:02 +00:00
<!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.11"/>
<title>Athena IO Library: include/athena/MemoryWriter.hpp Source File</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Athena IO Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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="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>
</ul>
</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">
$(document).ready(function(){initNavTree('_memory_writer_8hpp_source.html','');});
</script>
<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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">MemoryWriter.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef MEMORYWRITER_HPP</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define MEMORYWRITER_HPP</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &lt;functional&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &quot;athena/IStreamWriter.hpp&quot;</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceathena.html">athena</a></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;{</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">namespace </span>io</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;{</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="classathena_1_1io_1_1_memory_writer.html"> 22</a></span>&#160;<span class="keyword">class </span><a class="code" href="classathena_1_1io_1_1_memory_writer.html">MemoryWriter</a> : <span class="keyword">public</span> <a class="code" href="classathena_1_1io_1_1_i_stream_writer.html">IStreamWriter</a></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;{</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="classathena_1_1io_1_1_memory_writer.html">MemoryWriter</a>();</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classathena_1_1io_1_1_memory_writer.html">MemoryWriter</a>(atUint8* <a class="code" href="classathena_1_1io_1_1_memory_writer.html#affc1d82274beef12db8b4eb03dd4b461">data</a>, atUint64 <a class="code" href="classathena_1_1io_1_1_memory_writer.html#a6bea1a6d81d168a5144b910ec5cca049">length</a>, <span class="keywordtype">bool</span> takeOwnership = <span class="keyword">false</span>);</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classathena_1_1io_1_1_memory_writer.html#a587bb3fa6c9fd13858def341cb5e5e4e">seek</a>(atInt64 pos, SeekOrigin origin = SeekOrigin::Current);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classathena_1_1io_1_1_memory_writer.html#a22edeaafb8bf223c8d0d34544d2b7c2d"> 47</a></span>&#160; <span class="keyword">inline</span> atUint64 <a class="code" href="classathena_1_1io_1_1_memory_writer.html#a22edeaafb8bf223c8d0d34544d2b7c2d">position</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00048"></a><span cl
<div class="ttc" id="classathena_1_1io_1_1_memory_writer_html_ab2dc0557c8688a81014ab41197a8984f"><div class="ttname"><a href="classathena_1_1io_1_1_memory_writer.html#ab2dc0557c8688a81014ab41197a8984f">athena::io::MemoryWriter::filepath</a></div><div class="ttdeci">std::string filepath() const </div><div class="ttdoc">Returns the target file. </div><div class="ttdef"><b>Definition:</b> <a href="_memory_writer_8hpp_source.html#l00084">MemoryWriter.hpp:84</a></div></div>
<div class="ttc" id="classathena_1_1io_1_1_memory_writer_html_affc1d82274beef12db8b4eb03dd4b461"><div class="ttname"><a href="classathena_1_1io_1_1_memory_writer.html#affc1d82274beef12db8b4eb03dd4b461">athena::io::MemoryWriter::data</a></div><div class="ttdeci">atUint8 * data() const </div><div class="ttdoc">Returns a copy of the current buffer. Changes to the copy do not affect the buffer so it&amp;#39;s perfectly...</div></div>
<div class="ttc" id="classathena_1_1io_1_1_memory_writer_html_a22edeaafb8bf223c8d0d34544d2b7c2d"><div class="ttname"><a href="classathena_1_1io_1_1_memory_writer.html#a22edeaafb8bf223c8d0d34544d2b7c2d">athena::io::MemoryWriter::position</a></div><div class="ttdeci">atUint64 position() const </div><div class="ttdoc">Returns the current position in the stream. </div><div class="ttdef"><b>Definition:</b> <a href="_memory_writer_8hpp_source.html#l00047">MemoryWriter.hpp:47</a></div></div>
<div class="ttc" id="classathena_1_1io_1_1_memory_writer_html_abe6e6f6decb8d8ca6f47befdf8bb9fe2"><div class="ttname"><a href="classathena_1_1io_1_1_memory_writer.html#abe6e6f6decb8d8ca6f47befdf8bb9fe2">athena::io::MemoryWriter::writeUBytes</a></div><div class="ttdeci">void writeUBytes(const atUint8 *data, atUint64 len)</div><div class="ttdoc">Writes the given buffer with the specified length, buffers can be bigger than the length however it&amp;#39;s...</div></div>
<div class="ttc" id="classathena_1_1io_1_1_memory_writer_html_a6bea1a6d81d168a5144b910ec5cca049"><div class="ttname"><a href="classathena_1_1io_1_1_memory_writer.html#a6bea1a6d81d168a5144b910ec5cca049">athena::io::MemoryWriter::length</a></div><div class="ttdeci">atUint64 length() const </div><div class="ttdoc">Returns the length of the stream. </div><div class="ttdef"><b>Definition:</b> <a href="_memory_writer_8hpp_source.html#l00054">MemoryWriter.hpp:54</a></div></div>
<div class="ttc" id="classathena_1_1io_1_1_memory_writer_html_a587bb3fa6c9fd13858def341cb5e5e4e"><div class="ttname"><a href="classathena_1_1io_1_1_memory_writer.html#a587bb3fa6c9fd13858def341cb5e5e4e">athena::io::MemoryWriter::seek</a></div><div class="ttdeci">void seek(atInt64 pos, SeekOrigin origin=SeekOrigin::Current)</div><div class="ttdoc">Sets the buffers position relative to the specified position. It seeks relative to the current posit...</div></div>
<div class="ttc" id="classathena_1_1io_1_1_memory_writer_html_ac1366ed879a89a42caa10099107e873e"><div class="ttname"><a href="classathena_1_1io_1_1_memory_writer.html#ac1366ed879a89a42caa10099107e873e">athena::io::MemoryWriter::setFilepath</a></div><div class="ttdeci">void setFilepath(const std::string &amp;filepath)</div><div class="ttdoc">Sets the target file. </div><div class="ttdef"><b>Definition:</b> <a href="_memory_writer_8hpp_source.html#l00078">MemoryWriter.hpp:78</a></div></div>
<div class="ttc" id="namespaceathena_html"><div class="ttname"><a href="namespaceathena.html">athena</a></div><div class="ttdef"><b>Definition:</b> <a href="_a_l_t_t_p_enums_8hpp_source.html#l00006">ALTTPEnums.hpp:6</a></div></div>
<div class="ttc" id="classathena_1_1io_1_1_memory_writer_html_a08e201f22c2e0d519660cfb3ea1ed33d"><div class="ttname"><a href="classathena_1_1io_1_1_memory_writer.html#a08e201f22c2e0d519660cfb3ea1ed33d">athena::io::MemoryWriter::m_filepath</a></div><div class="ttdeci">std::string m_filepath</div><div class="ttdoc">Path to the target file. </div><div class="ttdef"><b>Definition:</b> <a href="_memory_writer_8hpp_source.html#l00109">MemoryWriter.hpp:109</a></div></div>
<div class="ttc" id="classathena_1_1io_1_1_i_stream_writer_html"><div class="ttname"><a href="classathena_1_1io_1_1_i_stream_writer.html">athena::io::IStreamWriter</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_stream_writer_8hpp_source.html#l00012">IStreamWriter.hpp:12</a></div></div>
<div class="ttc" id="classathena_1_1io_1_1_memory_copy_writer_html"><div class="ttname"><a href="classathena_1_1io_1_1_memory_copy_writer.html">athena::io::MemoryCopyWriter</a></div><div class="ttdef"><b>Definition:</b> <a href="_memory_writer_8hpp_source.html#l00112">MemoryWriter.hpp:112</a></div></div>
<div class="ttc" id="classathena_1_1io_1_1_memory_writer_html_a8d11c051ab5ecf740110cc576548958f"><div class="ttname"><a href="classathena_1_1io_1_1_memory_writer.html#a8d11c051ab5ecf740110cc576548958f">athena::io::MemoryWriter::save</a></div><div class="ttdeci">void save(const std::string &amp;filename=&quot;&quot;)</div><div class="ttdoc">Saves the file to the specified file. </div></div>
<div class="ttc" id="classathena_1_1io_1_1_memory_writer_html_a32cbcd645e5194480a6921f44075e9b6"><div class="ttname"><a href="classathena_1_1io_1_1_memory_writer.html#a32cbcd645e5194480a6921f44075e9b6">athena::io::MemoryWriter::setData</a></div><div class="ttdeci">void setData(atUint8 *data, atUint64 length, bool takeOwnership=false)</div><div class="ttdoc">Sets the buffer to the given one, deleting the current one if it owns it. </div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9b3fbfcb7fc609b7105d1ff63111043b.html">athena</a></li><li class="navelem"><b>MemoryWriter.hpp</b></li>
<li class="footer">Generated on Sat Sep 17 2016 13:10:08 for Athena IO Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>