blob: 9f31746ca683d26183e0665f266b3ebb2742ef16 [file] [edit]
<!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: engine/file.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>
<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&amp;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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('file_8hpp_source.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="headertitle">
<div class="title">file.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">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160; </div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &lt;cstdint&gt;</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;functional&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</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="namespaceblit.html">blit</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"><a class="line" href="namespaceblit.html#ad9d2ea50c0698f25e2185a42aefaf2da"> 11</a></span>&#160; <span class="keyword">enum</span> <a class="code" href="namespaceblit.html#ad9d2ea50c0698f25e2185a42aefaf2da">OpenMode</a> {</div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="namespaceblit.html#ad9d2ea50c0698f25e2185a42aefaf2daa12ee24d6260ba3bd9707a4fdfd40ccc0"> 13</a></span>&#160; <a class="code" href="namespaceblit.html#ad9d2ea50c0698f25e2185a42aefaf2daa12ee24d6260ba3bd9707a4fdfd40ccc0">read</a> = 1 &lt;&lt; 0,</div>
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="namespaceblit.html#ad9d2ea50c0698f25e2185a42aefaf2daa9bb479cd265b7a8fa5ab8f2542c836d6"> 15</a></span>&#160; <a class="code" href="namespaceblit.html#ad9d2ea50c0698f25e2185a42aefaf2daa9bb479cd265b7a8fa5ab8f2542c836d6">write</a> = 1 &lt;&lt; 1,</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <a class="code" href="namespaceblit.html#ad9d2ea50c0698f25e2185a42aefaf2daadeaac90da6d3d63f29946e4d39d02ac8">cached</a> = 1 &lt;&lt; 2</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="namespaceblit.html#ad9d2ea50c0698f25e2185a42aefaf2daadeaac90da6d3d63f29946e4d39d02ac8"> 18</a></span>&#160; };</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="namespaceblit.html#a9dce8d50bda1ad1f667704154784ec9a"> 20</a></span>&#160; <span class="keyword">enum</span> <a class="code" href="namespaceblit.html#a9dce8d50bda1ad1f667704154784ec9a">FileFlags</a> {</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <a class="code" href="namespaceblit.html#a9dce8d50bda1ad1f667704154784ec9aaad227e107cf262004cb464d0f60cc894">directory</a> = 1</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="namespaceblit.html#a9dce8d50bda1ad1f667704154784ec9aaad227e107cf262004cb464d0f60cc894"> 23</a></span>&#160; };</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structblit_1_1FileInfo.html"> 25</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structblit_1_1FileInfo.html">FileInfo</a> {</div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structblit_1_1FileInfo.html#a1c4e95fa16a4b227299198beac096d92"> 27</a></span>&#160; std::string <a class="code" href="structblit_1_1FileInfo.html#a1c4e95fa16a4b227299198beac096d92">name</a>;</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="structblit_1_1FileInfo.html#a7d77f6fdc013f2c2c6292fd767ff8a5c"> 29</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="structblit_1_1FileInfo.html#a7d77f6fdc013f2c2c6292fd767ff8a5c">flags</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="structblit_1_1FileInfo.html#a73e0dd28da4e6a8e98081fc4aa868898"> 31</a></span>&#160; uint32_t <a class="code" href="structblit_1_1FileInfo.html#a73e0dd28da4e6a8e98081fc4aa868898">size</a>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; };</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="namespaceblit.html#a18156ec64cd60f8456e23a7a18d9dcb5">is_storage_available</a>();</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; std::vector&lt;FileInfo&gt; <a class="code" href="namespaceblit.html#ab92ff5e8a00c9d9aa66585127d61d6c6">list_files</a>(<span class="keyword">const</span> std::string &amp;path, std::function&lt;<span class="keywordtype">bool</span>(<span class="keyword">const</span> <a class="code" href="structblit_1_1FileInfo.html">FileInfo</a> &amp;)&gt; filter = <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="namespaceblit.html#a5f37fe2d6326ba141626b2c3e6d3fa42">file_exists</a>(<span class="keyword">const</span> std::string &amp;path);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="namespaceblit.html#a89f9e08aba94bc53fc00b1b14c79e31f">directory_exists</a>(<span class="keyword">const</span> std::string &amp;path);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="namespaceblit.html#ab67d5b03fda42d8547eb0612fd3919a3">create_directory</a>(<span class="keyword">const</span> std::string &amp;path);</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; <span class="keywordtype">bool</span> <a class="code" href="namespaceblit.html#a3d354697b3c47bfee95490940dbc7e16">rename_file</a>(<span class="keyword">const</span> std::string &amp;old_name, <span class="keyword">const</span> std::string &amp;new_name);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="namespaceblit.html#afc2b88de8c3f238959bbe12c5cc6f4d1">remove_file</a>(<span class="keyword">const</span> std::string &amp;path);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classblit_1_1File.html"> 48</a></span>&#160; <span class="keyword">class </span><a class="code" href="classblit_1_1File.html">File</a> final {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <a class="code" href="classblit_1_1File.html">File</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <a class="code" href="classblit_1_1File.html">File</a>(<span class="keyword">const</span> std::string &amp;filename, <span class="keywordtype">int</span> mode = OpenMode::read) {<a class="code" href="classblit_1_1File.html#a6e05100e1e8b60de8f0621e8740c3c75">open</a>(filename, mode);}</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <a class="code" href="classblit_1_1File.html">File</a>(<span class="keyword">const</span> uint8_t *buf, uint32_t buf_len) {<a class="code" href="classblit_1_1File.html#a6e05100e1e8b60de8f0621e8740c3c75">open</a>(buf, buf_len);}</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="classblit_1_1File.html">File</a>(<span class="keyword">const</span> <a class="code" href="classblit_1_1File.html">File</a> &amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="classblit_1_1File.html">File</a>(<a class="code" href="classblit_1_1File.html">File</a> &amp;&amp;other) noexcept {</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; *<span class="keyword">this</span> = std::move(other);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; }</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; ~<a class="code" href="classblit_1_1File.html">File</a>() {</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <a class="code" href="classblit_1_1File.html#ad64b7d1c9db678598f3dd0c27c24521e">close</a>();</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; }</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <a class="code" href="classblit_1_1File.html">File</a> &amp;operator=(<span class="keyword">const</span> <a class="code" href="classblit_1_1File.html">File</a> &amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <a class="code" href="classblit_1_1File.html">File</a> &amp;operator=(<a class="code" href="classblit_1_1File.html">File</a> &amp;&amp;other) noexcept {</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordflow">if</span> (<span class="keyword">this</span> != &amp;other) {</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <a class="code" href="classblit_1_1File.html#ad64b7d1c9db678598f3dd0c27c24521e">close</a>();</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; std::swap(fh, other.fh);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; std::swap(buf, other.buf);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; std::swap(buf_len, other.buf_len);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; }</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; }</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classblit_1_1File.html#a6e05100e1e8b60de8f0621e8740c3c75">open</a>(<span class="keyword">const</span> std::string &amp;file, <span class="keywordtype">int</span> mode = OpenMode::read);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classblit_1_1File.html#a6e05100e1e8b60de8f0621e8740c3c75">open</a>(<span class="keyword">const</span> uint8_t *buf, uint32_t buf_len);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; int32_t <a class="code" href="classblit_1_1File.html#a489f3ac4cab172d811cc2daf2dc19083">read</a>(uint32_t offset, uint32_t length, <span class="keywordtype">char</span> *buffer);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; int32_t <a class="code" href="classblit_1_1File.html#a865f6fc1ba5b797db31d45cb80539f77">write</a>(uint32_t offset, uint32_t length, <span class="keyword">const</span> <span class="keywordtype">char</span> *buffer);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classblit_1_1File.html#ad64b7d1c9db678598f3dd0c27c24521e">close</a>();</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; uint32_t <a class="code" href="classblit_1_1File.html#a2464fed32d893b7b5e2c6485e1278bfc">get_length</a>();</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="classblit_1_1File.html#aa12df85536f9a8f9487f9bbfdb386f44"> 82</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classblit_1_1File.html#aa12df85536f9a8f9487f9bbfdb386f44">is_open</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordflow">return</span> buf != <span class="keyword">nullptr</span> || fh != <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; }</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classblit_1_1File.html#ab8b7cf440f3cdc06e06c61b965126a10"> 87</a></span>&#160; <span class="keyword">const</span> uint8_t *<a class="code" href="classblit_1_1File.html#ab8b7cf440f3cdc06e06c61b965126a10">get_ptr</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">return</span> buf;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; }</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classblit_1_1File.html#aebfe8c4c1731bcbc214b6e1e500374fe">add_buffer_file</a>(std::string path, <span class="keyword">const</span> uint8_t *ptr, uint32_t len);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordtype">void</span> *fh = <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="comment">// buffer &quot;files&quot;</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keyword">const</span> uint8_t *buf = <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; uint32_t buf_len;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keywordtype">bool</span> is_cached = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; };</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;}</div>
<div class="ttc" id="aclassblit_1_1File_html"><div class="ttname"><a href="classblit_1_1File.html">blit::File</a></div><div class="ttdef"><b>Definition:</b> file.hpp:48</div></div>
<div class="ttc" id="aclassblit_1_1File_html_a2464fed32d893b7b5e2c6485e1278bfc"><div class="ttname"><a href="classblit_1_1File.html#a2464fed32d893b7b5e2c6485e1278bfc">blit::File::get_length</a></div><div class="ttdeci">uint32_t get_length()</div><div class="ttdef"><b>Definition:</b> file.cpp:224</div></div>
<div class="ttc" id="aclassblit_1_1File_html_a489f3ac4cab172d811cc2daf2dc19083"><div class="ttname"><a href="classblit_1_1File.html#a489f3ac4cab172d811cc2daf2dc19083">blit::File::read</a></div><div class="ttdeci">int32_t read(uint32_t offset, uint32_t length, char *buffer)</div><div class="ttdef"><b>Definition:</b> file.cpp:177</div></div>
<div class="ttc" id="aclassblit_1_1File_html_a6e05100e1e8b60de8f0621e8740c3c75"><div class="ttname"><a href="classblit_1_1File.html#a6e05100e1e8b60de8f0621e8740c3c75">blit::File::open</a></div><div class="ttdeci">bool open(const std::string &amp;file, int mode=OpenMode::read)</div><div class="ttdef"><b>Definition:</b> file.cpp:140</div></div>
<div class="ttc" id="aclassblit_1_1File_html_a865f6fc1ba5b797db31d45cb80539f77"><div class="ttname"><a href="classblit_1_1File.html#a865f6fc1ba5b797db31d45cb80539f77">blit::File::write</a></div><div class="ttdeci">int32_t write(uint32_t offset, uint32_t length, const char *buffer)</div><div class="ttdef"><b>Definition:</b> file.cpp:197</div></div>
<div class="ttc" id="aclassblit_1_1File_html_aa12df85536f9a8f9487f9bbfdb386f44"><div class="ttname"><a href="classblit_1_1File.html#aa12df85536f9a8f9487f9bbfdb386f44">blit::File::is_open</a></div><div class="ttdeci">bool is_open() const</div><div class="ttdef"><b>Definition:</b> file.hpp:82</div></div>
<div class="ttc" id="aclassblit_1_1File_html_ab8b7cf440f3cdc06e06c61b965126a10"><div class="ttname"><a href="classblit_1_1File.html#ab8b7cf440f3cdc06e06c61b965126a10">blit::File::get_ptr</a></div><div class="ttdeci">const uint8_t * get_ptr() const</div><div class="ttdef"><b>Definition:</b> file.hpp:87</div></div>
<div class="ttc" id="aclassblit_1_1File_html_ad64b7d1c9db678598f3dd0c27c24521e"><div class="ttname"><a href="classblit_1_1File.html#ad64b7d1c9db678598f3dd0c27c24521e">blit::File::close</a></div><div class="ttdeci">void close()</div><div class="ttdef"><b>Definition:</b> file.cpp:204</div></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 class="ttc" id="anamespaceblit_html"><div class="ttname"><a href="namespaceblit.html">blit</a></div><div class="ttdef"><b>Definition:</b> audio.cpp:10</div></div>
<div class="ttc" id="anamespaceblit_html_a18156ec64cd60f8456e23a7a18d9dcb5"><div class="ttname"><a href="namespaceblit.html#a18156ec64cd60f8456e23a7a18d9dcb5">blit::is_storage_available</a></div><div class="ttdeci">bool is_storage_available()</div><div class="ttdef"><b>Definition:</b> file.cpp:21</div></div>
<div class="ttc" id="anamespaceblit_html_a3d354697b3c47bfee95490940dbc7e16"><div class="ttname"><a href="namespaceblit.html#a3d354697b3c47bfee95490940dbc7e16">blit::rename_file</a></div><div class="ttdeci">bool rename_file(const std::string &amp;old_name, const std::string &amp;new_name)</div><div class="ttdef"><b>Definition:</b> file.cpp:104</div></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 &amp;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 &amp;path)</div><div class="ttdef"><b>Definition:</b> file.cpp:81</div></div>
<div class="ttc" id="anamespaceblit_html_a9dce8d50bda1ad1f667704154784ec9a"><div class="ttname"><a href="namespaceblit.html#a9dce8d50bda1ad1f667704154784ec9a">blit::FileFlags</a></div><div class="ttdeci">FileFlags</div><div class="ttdef"><b>Definition:</b> file.hpp:20</div></div>
<div class="ttc" id="anamespaceblit_html_a9dce8d50bda1ad1f667704154784ec9aaad227e107cf262004cb464d0f60cc894"><div class="ttname"><a href="namespaceblit.html#a9dce8d50bda1ad1f667704154784ec9aaad227e107cf262004cb464d0f60cc894">blit::directory</a></div><div class="ttdeci">@ directory</div><div class="ttdoc">Is a directory.</div><div class="ttdef"><b>Definition:</b> file.hpp:22</div></div>
<div class="ttc" id="anamespaceblit_html_ab67d5b03fda42d8547eb0612fd3919a3"><div class="ttname"><a href="namespaceblit.html#ab67d5b03fda42d8547eb0612fd3919a3">blit::create_directory</a></div><div class="ttdeci">bool create_directory(const std::string &amp;path)</div><div class="ttdef"><b>Definition:</b> file.cpp:92</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&lt; FileInfo &gt; list_files(const std::string &amp;path, std::function&lt; bool(const FileInfo &amp;)&gt; filter)</div><div class="ttdef"><b>Definition:</b> file.cpp:32</div></div>
<div class="ttc" id="anamespaceblit_html_ad9d2ea50c0698f25e2185a42aefaf2da"><div class="ttname"><a href="namespaceblit.html#ad9d2ea50c0698f25e2185a42aefaf2da">blit::OpenMode</a></div><div class="ttdeci">OpenMode</div><div class="ttdef"><b>Definition:</b> file.hpp:11</div></div>
<div class="ttc" id="anamespaceblit_html_ad9d2ea50c0698f25e2185a42aefaf2daa12ee24d6260ba3bd9707a4fdfd40ccc0"><div class="ttname"><a href="namespaceblit.html#ad9d2ea50c0698f25e2185a42aefaf2daa12ee24d6260ba3bd9707a4fdfd40ccc0">blit::read</a></div><div class="ttdeci">@ read</div><div class="ttdoc">Open file for reading.</div><div class="ttdef"><b>Definition:</b> file.hpp:13</div></div>
<div class="ttc" id="anamespaceblit_html_ad9d2ea50c0698f25e2185a42aefaf2daa9bb479cd265b7a8fa5ab8f2542c836d6"><div class="ttname"><a href="namespaceblit.html#ad9d2ea50c0698f25e2185a42aefaf2daa9bb479cd265b7a8fa5ab8f2542c836d6">blit::write</a></div><div class="ttdeci">@ write</div><div class="ttdoc">Open file for writing.</div><div class="ttdef"><b>Definition:</b> file.hpp:15</div></div>
<div class="ttc" id="anamespaceblit_html_ad9d2ea50c0698f25e2185a42aefaf2daadeaac90da6d3d63f29946e4d39d02ac8"><div class="ttname"><a href="namespaceblit.html#ad9d2ea50c0698f25e2185a42aefaf2daadeaac90da6d3d63f29946e4d39d02ac8">blit::cached</a></div><div class="ttdeci">@ cached</div><div class="ttdoc">Copy file to the temp area in flash for faster access.</div><div class="ttdef"><b>Definition:</b> file.hpp:17</div></div>
<div class="ttc" id="anamespaceblit_html_afc2b88de8c3f238959bbe12c5cc6f4d1"><div class="ttname"><a href="namespaceblit.html#afc2b88de8c3f238959bbe12c5cc6f4d1">blit::remove_file</a></div><div class="ttdeci">bool remove_file(const std::string &amp;path)</div><div class="ttdef"><b>Definition:</b> file.cpp:115</div></div>
<div class="ttc" id="astructblit_1_1FileInfo_html"><div class="ttname"><a href="structblit_1_1FileInfo.html">blit::FileInfo</a></div><div class="ttdef"><b>Definition:</b> file.hpp:25</div></div>
<div class="ttc" id="astructblit_1_1FileInfo_html_a1c4e95fa16a4b227299198beac096d92"><div class="ttname"><a href="structblit_1_1FileInfo.html#a1c4e95fa16a4b227299198beac096d92">blit::FileInfo::name</a></div><div class="ttdeci">std::string name</div><div class="ttdoc">Name of the file.</div><div class="ttdef"><b>Definition:</b> file.hpp:27</div></div>
<div class="ttc" id="astructblit_1_1FileInfo_html_a73e0dd28da4e6a8e98081fc4aa868898"><div class="ttname"><a href="structblit_1_1FileInfo.html#a73e0dd28da4e6a8e98081fc4aa868898">blit::FileInfo::size</a></div><div class="ttdeci">uint32_t size</div><div class="ttdoc">Size of the file.</div><div class="ttdef"><b>Definition:</b> file.hpp:31</div></div>
<div class="ttc" id="astructblit_1_1FileInfo_html_a7d77f6fdc013f2c2c6292fd767ff8a5c"><div class="ttname"><a href="structblit_1_1FileInfo.html#a7d77f6fdc013f2c2c6292fd767ff8a5c">blit::FileInfo::flags</a></div><div class="ttdeci">int flags</div><div class="ttdoc">Flags (see FileFlags)</div><div class="ttdef"><b>Definition:</b> file.hpp:29</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_996f45160da62e1a3d7f6046fad68f51.html">engine</a></li><li class="navelem"><b>file.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.9.1 </li>
</ul>
</div>
</body>
</html>