| <!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"> |
| <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.9.1"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>32blit API: blit::File Class 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="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> |
| <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 style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">32blit API |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.1 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</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"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('classblit_1_1File.html',''); initResizable(); }); |
| /* @license-end */ |
| </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="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classblit_1_1File-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">blit::File Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><code>#include <<a class="el" href="file_8hpp_source.html">engine/file.hpp</a>></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:a30f396fcd91d1fcbd833819bdf9273f2"><td class="memItemLeft" align="right" valign="top"><a id="a30f396fcd91d1fcbd833819bdf9273f2"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>File</b> (const std::string &filename, int mode=OpenMode::read)</td></tr> |
| <tr class="separator:a30f396fcd91d1fcbd833819bdf9273f2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0f1ba344497980543532284ad54634a5"><td class="memItemLeft" align="right" valign="top"><a id="a0f1ba344497980543532284ad54634a5"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>File</b> (const uint8_t *buf, uint32_t buf_len)</td></tr> |
| <tr class="separator:a0f1ba344497980543532284ad54634a5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2523335715abab1ecc599f50cc4c176a"><td class="memItemLeft" align="right" valign="top"><a id="a2523335715abab1ecc599f50cc4c176a"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>File</b> (const <a class="el" href="classblit_1_1File.html">File</a> &)=delete</td></tr> |
| <tr class="separator:a2523335715abab1ecc599f50cc4c176a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0dfe15c6c3abd26044098dec34f9d180"><td class="memItemLeft" align="right" valign="top"><a id="a0dfe15c6c3abd26044098dec34f9d180"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>File</b> (<a class="el" href="classblit_1_1File.html">File</a> &&other) noexcept</td></tr> |
| <tr class="separator:a0dfe15c6c3abd26044098dec34f9d180"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a787ac338aadc520fee2f65d42d4fbf7b"><td class="memItemLeft" align="right" valign="top"><a id="a787ac338aadc520fee2f65d42d4fbf7b"></a> |
| <a class="el" href="classblit_1_1File.html">File</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classblit_1_1File.html">File</a> &)=delete</td></tr> |
| <tr class="separator:a787ac338aadc520fee2f65d42d4fbf7b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5567cbf650b0d347eec2d91e2f5fb64c"><td class="memItemLeft" align="right" valign="top"><a id="a5567cbf650b0d347eec2d91e2f5fb64c"></a> |
| <a class="el" href="classblit_1_1File.html">File</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classblit_1_1File.html">File</a> &&other) noexcept</td></tr> |
| <tr class="separator:a5567cbf650b0d347eec2d91e2f5fb64c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6e05100e1e8b60de8f0621e8740c3c75"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classblit_1_1File.html#a6e05100e1e8b60de8f0621e8740c3c75">open</a> (const std::string &file, int mode=OpenMode::read)</td></tr> |
| <tr class="separator:a6e05100e1e8b60de8f0621e8740c3c75"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a385c02f069b2ace22731104a284d9559"><td class="memItemLeft" align="right" valign="top"><a id="a385c02f069b2ace22731104a284d9559"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>open</b> (const uint8_t *buf, uint32_t buf_len)</td></tr> |
| <tr class="separator:a385c02f069b2ace22731104a284d9559"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a489f3ac4cab172d811cc2daf2dc19083"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblit_1_1File.html#a489f3ac4cab172d811cc2daf2dc19083">read</a> (uint32_t offset, uint32_t length, char *buffer)</td></tr> |
| <tr class="separator:a489f3ac4cab172d811cc2daf2dc19083"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a865f6fc1ba5b797db31d45cb80539f77"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblit_1_1File.html#a865f6fc1ba5b797db31d45cb80539f77">write</a> (uint32_t offset, uint32_t length, const char *buffer)</td></tr> |
| <tr class="separator:a865f6fc1ba5b797db31d45cb80539f77"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad64b7d1c9db678598f3dd0c27c24521e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblit_1_1File.html#ad64b7d1c9db678598f3dd0c27c24521e">close</a> ()</td></tr> |
| <tr class="separator:ad64b7d1c9db678598f3dd0c27c24521e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2464fed32d893b7b5e2c6485e1278bfc"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classblit_1_1File.html#a2464fed32d893b7b5e2c6485e1278bfc">get_length</a> ()</td></tr> |
| <tr class="separator:a2464fed32d893b7b5e2c6485e1278bfc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa12df85536f9a8f9487f9bbfdb386f44"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classblit_1_1File.html#aa12df85536f9a8f9487f9bbfdb386f44">is_open</a> () const</td></tr> |
| <tr class="separator:aa12df85536f9a8f9487f9bbfdb386f44"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab8b7cf440f3cdc06e06c61b965126a10"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classblit_1_1File.html#ab8b7cf440f3cdc06e06c61b965126a10">get_ptr</a> () const</td></tr> |
| <tr class="separator:ab8b7cf440f3cdc06e06c61b965126a10"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:aebfe8c4c1731bcbc214b6e1e500374fe"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblit_1_1File.html#aebfe8c4c1731bcbc214b6e1e500374fe">add_buffer_file</a> (std::string path, const uint8_t *ptr, uint32_t len)</td></tr> |
| <tr class="separator:aebfe8c4c1731bcbc214b6e1e500374fe"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Class for accessing files on the SD card (device), the game directory (SDL) or in memory. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="aebfe8c4c1731bcbc214b6e1e500374fe"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aebfe8c4c1731bcbc214b6e1e500374fe">◆ </a></span>add_buffer_file()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void blit::File::add_buffer_file </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>path</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const uint8_t * </td> |
| <td class="paramname"><em>ptr</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>len</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Creates an in-memory file, which can be used like a regular (read-only) file.</p> |
| <p>This is useful for porting code which assumes files, or for transparently moving data to flash for extra performance.</p> |
| <p>Example using a packed asset: </p><div class="fragment"><div class="line"><a class="code" href="classblit_1_1File.html#aebfe8c4c1731bcbc214b6e1e500374fe">File::add_buffer_file</a>(<span class="stringliteral">"asset_name.bin"</span>, asset_name, asset_name_length);</div> |
| <div class="ttc" id="aclassblit_1_1File_html_aebfe8c4c1731bcbc214b6e1e500374fe"><div class="ttname"><a href="classblit_1_1File.html#aebfe8c4c1731bcbc214b6e1e500374fe">blit::File::add_buffer_file</a></div><div class="ttdeci">static void add_buffer_file(std::string path, const uint8_t *ptr, uint32_t len)</div><div class="ttdef"><b>Definition:</b> file.cpp:259</div></div> |
| </div><!-- fragment --><p>Notes: The directory part of the path is not created if it does not exist, so <a class="el" href="namespaceblit.html#ab92ff5e8a00c9d9aa66585127d61d6c6">list_files</a>/<a class="el" href="namespaceblit.html#a89f9e08aba94bc53fc00b1b14c79e31f">directory_exists</a> may not work as expected in that case: (Assuming <code>path/to</code> does not exist on the SD card) </p><div class="fragment"><div class="line"><a class="code" href="classblit_1_1File.html#aebfe8c4c1731bcbc214b6e1e500374fe">File::add_buffer_file</a>(<span class="stringliteral">"path/to/a.file"</span>);</div> |
| <div class="line"> </div> |
| <div class="line"><a class="code" href="namespaceblit.html#a5f37fe2d6326ba141626b2c3e6d3fa42">file_exists</a>(<span class="stringliteral">"path/to/a.file"</span>); <span class="comment">// true</span></div> |
| <div class="line"><a class="code" href="namespaceblit.html#a89f9e08aba94bc53fc00b1b14c79e31f">directory_exists</a>(<span class="stringliteral">"path/to"</span>); <span class="comment">// false!</span></div> |
| <div class="line"> </div> |
| <div class="line"><a class="code" href="namespaceblit.html#ab92ff5e8a00c9d9aa66585127d61d6c6">list_files</a>(<span class="stringliteral">"path/to"</span>); <span class="comment">// vector containing info for "a.file"</span></div> |
| <div class="line"><a class="code" href="namespaceblit.html#ab92ff5e8a00c9d9aa66585127d61d6c6">list_files</a>(<span class="stringliteral">"path"</span>); <span class="comment">// empty!</span></div> |
| <div class="ttc" id="anamespaceblit_html_a5f37fe2d6326ba141626b2c3e6d3fa42"><div class="ttname"><a href="namespaceblit.html#a5f37fe2d6326ba141626b2c3e6d3fa42">blit::file_exists</a></div><div class="ttdeci">bool file_exists(const std::string &path)</div><div class="ttdef"><b>Definition:</b> file.cpp:70</div></div> |
| <div class="ttc" id="anamespaceblit_html_a89f9e08aba94bc53fc00b1b14c79e31f"><div class="ttname"><a href="namespaceblit.html#a89f9e08aba94bc53fc00b1b14c79e31f">blit::directory_exists</a></div><div class="ttdeci">bool directory_exists(const std::string &path)</div><div class="ttdef"><b>Definition:</b> file.cpp:81</div></div> |
| <div class="ttc" id="anamespaceblit_html_ab92ff5e8a00c9d9aa66585127d61d6c6"><div class="ttname"><a href="namespaceblit.html#ab92ff5e8a00c9d9aa66585127d61d6c6">blit::list_files</a></div><div class="ttdeci">std::vector< FileInfo > list_files(const std::string &path, std::function< bool(const FileInfo &)> filter)</div><div class="ttdef"><b>Definition:</b> file.cpp:32</div></div> |
| </div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">path</td><td>Path for the file </td></tr> |
| <tr><td class="paramname">ptr</td><td>Pointer to file data </td></tr> |
| <tr><td class="paramname">len</td><td>Length of file data </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ad64b7d1c9db678598f3dd0c27c24521e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad64b7d1c9db678598f3dd0c27c24521e">◆ </a></span>close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void blit::File::close </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Close the file. Also called automatically by the destructor. </p> |
| |
| </div> |
| </div> |
| <a id="a2464fed32d893b7b5e2c6485e1278bfc"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2464fed32d893b7b5e2c6485e1278bfc">◆ </a></span>get_length()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint32_t blit::File::get_length </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get file length</p> |
| <dl class="section return"><dt>Returns</dt><dd>Length of the file in bytes. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ab8b7cf440f3cdc06e06c61b965126a10"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab8b7cf440f3cdc06e06c61b965126a10">◆ </a></span>get_ptr()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const uint8_t* blit::File::get_ptr </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>pointer to data for in-memory files </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa12df85536f9a8f9487f9bbfdb386f44"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa12df85536f9a8f9487f9bbfdb386f44">◆ </a></span>is_open()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool blit::File::is_open </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> if file is open </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a6e05100e1e8b60de8f0621e8740c3c75"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6e05100e1e8b60de8f0621e8740c3c75">◆ </a></span>open()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool blit::File::open </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>file</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>mode</em> = <code>OpenMode::read</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Open a file. If a file is already open it will be automatically closed.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">file</td><td>Path to open. </td></tr> |
| <tr><td class="paramname">mode</td><td><a class="el" href="namespaceblit.html#ad9d2ea50c0698f25e2185a42aefaf2da">OpenMode</a> to open file as. Cannot contain <a class="el" href="namespaceblit.html#ad9d2ea50c0698f25e2185a42aefaf2daa9bb479cd265b7a8fa5ab8f2542c836d6" title="Open file for writing.">write</a> for in-memory files.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if file opened successfully </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a489f3ac4cab172d811cc2daf2dc19083"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a489f3ac4cab172d811cc2daf2dc19083">◆ </a></span>read()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int32_t blit::File::read </td> |
| <td>(</td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>offset</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>length</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">char * </td> |
| <td class="paramname"><em>buffer</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Read a block of data from the file. Should not be called if the file was not opened for reading.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">offset</td><td>Offset to read from </td></tr> |
| <tr><td class="paramname">length</td><td>Length to read </td></tr> |
| <tr><td class="paramname">buffer</td><td>Pointer to buffer to store data into, should be at least <code>length</code> bytes</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Number of bytes read successfully or -1 if an error occurred. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a865f6fc1ba5b797db31d45cb80539f77"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a865f6fc1ba5b797db31d45cb80539f77">◆ </a></span>write()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int32_t blit::File::write </td> |
| <td>(</td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>offset</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>length</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>buffer</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Write a block of data to the file. Should not be called if the file was not opened for writing.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">offset</td><td>Offset to write to </td></tr> |
| <tr><td class="paramname">length</td><td>Length to write </td></tr> |
| <tr><td class="paramname">buffer</td><td>Pointer to data to write, should be at least <code>length</code> bytes</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Number of bytes written successfully or -1 if an error occurred. </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>engine/<a class="el" href="file_8hpp_source.html">file.hpp</a></li> |
| <li>engine/file.cpp</li> |
| </ul> |
| </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="namespaceblit.html">blit</a></li><li class="navelem"><a class="el" href="classblit_1_1File.html">File</a></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.9.1 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
