nishi/nishbox
1
Fork 0
mirror of https://github.com/nishiowo/nishbox synced 2025-04-21 20:24:39 +00:00
Code Issues Packages Projects Releases Wiki Activity
nishbox/engine/gf__audio_8h_source.html

161 lines
16 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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GoldFish Engine: include/gf_audio.h 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 id="projectrow">
<td id="projectalign">
<div id="projectname">GoldFish Engine
</div>
<div id="projectbrief">Quite simple and lightweight game engine</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('gf__audio_8h_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">
<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">gf_audio.h</div></div>
</div><!--header-->
<div class="contents">
<a href="gf__audio_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#ifndef __GF_AUDIO_H__</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#define __GF_AUDIO_H__</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;<a class="code" href="gf__pre_8h.html">gf_pre.h</a>&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &lt;<a class="code" href="gf__macro_8h.html">gf_macro.h</a>&gt;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">/* Type */</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &lt;<a class="code" href="audio_8h.html">gf_type/audio.h</a>&gt;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">/* Engine */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include &lt;<a class="code" href="core_8h.html">gf_type/core.h</a>&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">/* Standard */</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include &lt;stddef.h&gt;</span></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><a class="code hl_define" href="gf__macro_8h.html#a64ddd31b0795e397b5d944e6f1821357">GF_EXPORT</a> <a class="code hl_struct" href="structgf__audio__t.html">gf_audio_t</a>* <a class="code hl_function" href="gf__audio_8h.html#a52e61cbf2518774a590141631e053330">gf_audio_create</a>(<a class="code hl_struct" href="structgf__engine__t.html">gf_engine_t</a>* engine);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><a class="code hl_define" href="gf__macro_8h.html#a64ddd31b0795e397b5d944e6f1821357">GF_EXPORT</a> <span class="keywordtype">void</span> <a class="code hl_function" href="gf__audio_8h.html#ab5022a62ecc7ba83ccb5da4a1add398b">gf_audio_destroy</a>(<a class="code hl_struct" href="structgf__audio__t.html">gf_audio_t</a>* audio);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><a class="code hl_define" href="gf__macro_8h.html#a64ddd31b0795e397b5d944e6f1821357">GF_EXPORT</a> <span class="keywordtype">void</span> <a class="code hl_function" href="gf__audio_8h.html#ae34c8bd9d398a4335a1c6f9cc290ebdb">gf_audio_decoder_destroy</a>(<a class="code hl_struct" href="structgf__audio__decoder__t.html">gf_audio_decoder_t</a>* decoder);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><a class="code hl_define" href="gf__macro_8h.html#a64ddd31b0795e397b5d944e6f1821357">GF_EXPORT</a> gf_audio_id_t <a class="code hl_function" href="gf__audio_8h.html#af3ae4fe048705bae7ce8a377976a4c2d">gf_audio_load_file</a>(<a class="code hl_struct" href="structgf__audio__t.html">gf_audio_t</a>* audio, <span class="keyword">const</span> <span class="keywordtype">char</span>* path);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><a class="code hl_define" href="gf__macro_8h.html#a64ddd31b0795e397b5d944e6f1821357">GF_EXPORT</a> gf_audio_id_t <a class="code hl_function" href="gf__audio_8h.html#a391139463501e0f9962974b208d9e4b2">gf_audio_load</a>(<a class="code hl_struct" href="structgf__audio__t.html">gf_audio_t</a>* audio, <span class="keyword">const</span> <span class="keywordtype">void</span>* data, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><a class="code hl_define" href="gf__macro_8h.html#a64ddd31b0795e397b5d944e6f1821357">GF_EXPORT</a> <span class="keywordtype">void</span> <a class="code hl_function" href="gf__audio_8h.html#af319f87c14e6b784de694c065d147c80">gf_audio_pause</a>(<a class="code hl_struct" href="structgf__audio__t.html">gf_audio_t</a>* audio, gf_audio_id_t <span class="keywordtype">id</span>);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><a class="code hl_define" href="gf__macro_8h.html#a64ddd31b0795e397b5d944e6f1821357">GF_EXPORT</a> <span class="keywordtype">void</span> <a class="code hl_function" href="gf__audio_8h.html#a336ebd4c24f26fb744114f955292f58b">gf_audio_resume</a>(<a class="code hl_struct" href="structgf__audio__t.html">gf_audio_t</a>* audio, gf_audio_id_t <span class="keywordtype">id</span>);</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><a class="code hl_define" href="gf__macro_8h.html#a64ddd31b0795e397b5d944e6f1821357">GF_EXPORT</a> <span class="keywordtype">void</span> <a class="code hl_function" href="gf__audio_8h.html#a270465ee43fdc71840bd1a5dbd0a1ec1">gf_audio_stop</a>(<a class="code hl_struct" href="structgf__audio__t.html">gf_audio_t</a>* audio, gf_audio_id_t <span class="keywordtype">id</span>);</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aaudio_8h_html"><div class="ttname"><a href="audio_8h.html">audio.h</a></div><div class="ttdoc">Type definitions related to audio interface.</div></div>
<div class="ttc" id="acore_8h_html"><div class="ttname"><a href="core_8h.html">core.h</a></div><div class="ttdoc">Type definitions related to core.</div></div>
<div class="ttc" id="agf__audio_8h_html_a270465ee43fdc71840bd1a5dbd0a1ec1"><div class="ttname"><a href="gf__audio_8h.html#a270465ee43fdc71840bd1a5dbd0a1ec1">gf_audio_stop</a></div><div class="ttdeci">void gf_audio_stop(gf_audio_t *audio, gf_audio_id_t id)</div><div class="ttdoc">Stop audio.</div><div class="ttdef"><b>Definition</b> <a href="gf__audio_8c_source.html#l00275">gf_audio.c:275</a></div></div>
<div class="ttc" id="agf__audio_8h_html_a336ebd4c24f26fb744114f955292f58b"><div class="ttname"><a href="gf__audio_8h.html#a336ebd4c24f26fb744114f955292f58b">gf_audio_resume</a></div><div class="ttdeci">void gf_audio_resume(gf_audio_t *audio, gf_audio_id_t id)</div><div class="ttdoc">Resume audio.</div><div class="ttdef"><b>Definition</b> <a href="gf__audio_8c_source.html#l00263">gf_audio.c:263</a></div></div>
<div class="ttc" id="agf__audio_8h_html_a391139463501e0f9962974b208d9e4b2"><div class="ttname"><a href="gf__audio_8h.html#a391139463501e0f9962974b208d9e4b2">gf_audio_load</a></div><div class="ttdeci">gf_audio_id_t gf_audio_load(gf_audio_t *audio, const void *data, size_t size)</div><div class="ttdoc">Load and play data.</div><div class="ttdef"><b>Definition</b> <a href="gf__audio_8c_source.html#l00097">gf_audio.c:97</a></div></div>
<div class="ttc" id="agf__audio_8h_html_a52e61cbf2518774a590141631e053330"><div class="ttname"><a href="gf__audio_8h.html#a52e61cbf2518774a590141631e053330">gf_audio_create</a></div><div class="ttdeci">gf_audio_t * gf_audio_create(gf_engine_t *engine)</div><div class="ttdoc">Create audio interface.</div><div class="ttdef"><b>Definition</b> <a href="gf__audio_8c_source.html#l00170">gf_audio.c:170</a></div></div>
<div class="ttc" id="agf__audio_8h_html_ab5022a62ecc7ba83ccb5da4a1add398b"><div class="ttname"><a href="gf__audio_8h.html#ab5022a62ecc7ba83ccb5da4a1add398b">gf_audio_destroy</a></div><div class="ttdeci">void gf_audio_destroy(gf_audio_t *audio)</div><div class="ttdoc">Destroy audio interface.</div><div class="ttdef"><b>Definition</b> <a href="gf__audio_8c_source.html#l00246">gf_audio.c:246</a></div></div>
<div class="ttc" id="agf__audio_8h_html_ae34c8bd9d398a4335a1c6f9cc290ebdb"><div class="ttname"><a href="gf__audio_8h.html#ae34c8bd9d398a4335a1c6f9cc290ebdb">gf_audio_decoder_destroy</a></div><div class="ttdeci">void gf_audio_decoder_destroy(gf_audio_decoder_t *decoder)</div><div class="ttdoc">Destroy audio decoder.</div><div class="ttdef"><b>Definition</b> <a href="gf__audio_8c_source.html#l00226">gf_audio.c:226</a></div></div>
<div class="ttc" id="agf__audio_8h_html_af319f87c14e6b784de694c065d147c80"><div class="ttname"><a href="gf__audio_8h.html#af319f87c14e6b784de694c065d147c80">gf_audio_pause</a></div><div class="ttdeci">void gf_audio_pause(gf_audio_t *audio, gf_audio_id_t id)</div><div class="ttdoc">Pause audio.</div><div class="ttdef"><b>Definition</b> <a href="gf__audio_8c_source.html#l00269">gf_audio.c:269</a></div></div>
<div class="ttc" id="agf__audio_8h_html_af3ae4fe048705bae7ce8a377976a4c2d"><div class="ttname"><a href="gf__audio_8h.html#af3ae4fe048705bae7ce8a377976a4c2d">gf_audio_load_file</a></div><div class="ttdeci">gf_audio_id_t gf_audio_load_file(gf_audio_t *audio, const char *path)</div><div class="ttdoc">Load and play file.</div><div class="ttdef"><b>Definition</b> <a href="gf__audio_8c_source.html#l00151">gf_audio.c:151</a></div></div>
<div class="ttc" id="agf__macro_8h_html"><div class="ttname"><a href="gf__macro_8h.html">gf_macro.h</a></div><div class="ttdoc">Macro.</div></div>
<div class="ttc" id="agf__macro_8h_html_a64ddd31b0795e397b5d944e6f1821357"><div class="ttname"><a href="gf__macro_8h.html#a64ddd31b0795e397b5d944e6f1821357">GF_EXPORT</a></div><div class="ttdeci">#define GF_EXPORT</div><div class="ttdoc">Macro for platform-dependent symbol export/import.</div><div class="ttdef"><b>Definition</b> <a href="gf__macro_8h_source.html#l00190">gf_macro.h:190</a></div></div>
<div class="ttc" id="agf__pre_8h_html"><div class="ttname"><a href="gf__pre_8h.html">gf_pre.h</a></div><div class="ttdoc">Required headers before anything.</div></div>
<div class="ttc" id="astructgf__audio__decoder__t_html"><div class="ttname"><a href="structgf__audio__decoder__t.html">gf_audio_decoder_t</a></div><div class="ttdoc">Audio decoder.</div><div class="ttdef"><b>Definition</b> <a href="audio_8h_source.html#l00069">audio.h:69</a></div></div>
<div class="ttc" id="astructgf__audio__t_html"><div class="ttname"><a href="structgf__audio__t.html">gf_audio_t</a></div><div class="ttdoc">Audio interface.</div><div class="ttdef"><b>Definition</b> <a href="audio_8h_source.html#l00097">audio.h:97</a></div></div>
<div class="ttc" id="astructgf__engine__t_html"><div class="ttname"><a href="structgf__engine__t.html">gf_engine_t</a></div><div class="ttdoc">Engine instance.</div><div class="ttdef"><b>Definition</b> <a href="core_8h_source.html#l00046">core.h:46</a></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="gf__audio_8h.html">gf_audio.h</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.8 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink