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.html

340 lines
15 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 File 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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="goldfish.png"/></td>
<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>
</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.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="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">gf_audio.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Audio interface.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;<a class="el" href="gf__pre_8h_source.html">gf_pre.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="gf__macro_8h_source.html">gf_macro.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="audio_8h_source.html">gf_type/audio.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="core_8h_source.html">gf_type/core.h</a>&gt;</code><br />
<code>#include &lt;stddef.h&gt;</code><br />
</div>
<p><a href="gf__audio_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a52e61cbf2518774a590141631e053330" id="r_a52e61cbf2518774a590141631e053330"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgf__audio__t.html">gf_audio_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gf__audio_8h.html#a52e61cbf2518774a590141631e053330">gf_audio_create</a> (<a class="el" href="structgf__engine__t.html">gf_engine_t</a> *engine)</td></tr>
<tr class="memdesc:a52e61cbf2518774a590141631e053330"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create audio interface. <br /></td></tr>
<tr class="separator:a52e61cbf2518774a590141631e053330"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5022a62ecc7ba83ccb5da4a1add398b" id="r_ab5022a62ecc7ba83ccb5da4a1add398b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gf__audio_8h.html#ab5022a62ecc7ba83ccb5da4a1add398b">gf_audio_destroy</a> (<a class="el" href="structgf__audio__t.html">gf_audio_t</a> *audio)</td></tr>
<tr class="memdesc:ab5022a62ecc7ba83ccb5da4a1add398b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy audio interface. <br /></td></tr>
<tr class="separator:ab5022a62ecc7ba83ccb5da4a1add398b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae34c8bd9d398a4335a1c6f9cc290ebdb" id="r_ae34c8bd9d398a4335a1c6f9cc290ebdb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gf__audio_8h.html#ae34c8bd9d398a4335a1c6f9cc290ebdb">gf_audio_decoder_destroy</a> (<a class="el" href="structgf__audio__decoder__t.html">gf_audio_decoder_t</a> *decoder)</td></tr>
<tr class="memdesc:ae34c8bd9d398a4335a1c6f9cc290ebdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy audio decoder. <br /></td></tr>
<tr class="separator:ae34c8bd9d398a4335a1c6f9cc290ebdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a644b31417fc839bb2be69a88c2e77fbe" id="r_a644b31417fc839bb2be69a88c2e77fbe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gf__audio_8h.html#a644b31417fc839bb2be69a88c2e77fbe">gf_audio_load_file</a> (<a class="el" href="structgf__audio__t.html">gf_audio_t</a> *audio, const char *path)</td></tr>
<tr class="memdesc:a644b31417fc839bb2be69a88c2e77fbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load and play file. <br /></td></tr>
<tr class="separator:a644b31417fc839bb2be69a88c2e77fbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a6428af79e540740776ae0d202c3962" id="r_a7a6428af79e540740776ae0d202c3962"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gf__audio_8h.html#a7a6428af79e540740776ae0d202c3962">gf_audio_load</a> (<a class="el" href="structgf__audio__t.html">gf_audio_t</a> *audio, const void *data, size_t size)</td></tr>
<tr class="memdesc:a7a6428af79e540740776ae0d202c3962"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load and play data. <br /></td></tr>
<tr class="separator:a7a6428af79e540740776ae0d202c3962"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Audio interface. </p>
<p class="definition">Definition in file <a class="el" href="gf__audio_8h_source.html">gf_audio.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a52e61cbf2518774a590141631e053330" name="a52e61cbf2518774a590141631e053330"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52e61cbf2518774a590141631e053330">&#9670;&#160;</a></span>gf_audio_create()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structgf__audio__t.html">gf_audio_t</a> * gf_audio_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgf__engine__t.html">gf_engine_t</a> *&#160;</td>
<td class="paramname"><em>engine</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create audio interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">engine</td><td>Engine instance </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Audio interface </dd></dl>
<p class="definition">Definition at line <a class="el" href="gf__audio_8c_source.html#l00155">155</a> of file <a class="el" href="gf__audio_8c_source.html">gf_audio.c</a>.</p>
</div>
</div>
<a id="ae34c8bd9d398a4335a1c6f9cc290ebdb" name="ae34c8bd9d398a4335a1c6f9cc290ebdb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae34c8bd9d398a4335a1c6f9cc290ebdb">&#9670;&#160;</a></span>gf_audio_decoder_destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void gf_audio_decoder_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgf__audio__decoder__t.html">gf_audio_decoder_t</a> *&#160;</td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy audio decoder. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>Audio decoder </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="gf__audio_8c_source.html#l00199">199</a> of file <a class="el" href="gf__audio_8c_source.html">gf_audio.c</a>.</p>
</div>
</div>
<a id="ab5022a62ecc7ba83ccb5da4a1add398b" name="ab5022a62ecc7ba83ccb5da4a1add398b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab5022a62ecc7ba83ccb5da4a1add398b">&#9670;&#160;</a></span>gf_audio_destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void gf_audio_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgf__audio__t.html">gf_audio_t</a> *&#160;</td>
<td class="paramname"><em>audio</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy audio interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">audio</td><td>Audio interface </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="gf__audio_8c_source.html#l00217">217</a> of file <a class="el" href="gf__audio_8c_source.html">gf_audio.c</a>.</p>
</div>
</div>
<a id="a7a6428af79e540740776ae0d202c3962" name="a7a6428af79e540740776ae0d202c3962"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a6428af79e540740776ae0d202c3962">&#9670;&#160;</a></span>gf_audio_load()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gf_audio_load </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgf__audio__t.html">gf_audio_t</a> *&#160;</td>
<td class="paramname"><em>audio</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load and play data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">audio</td><td>Audio interface </td></tr>
<tr><td class="paramname">data</td><td>Data </td></tr>
<tr><td class="paramname">size</td><td>Data size </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>0</code> if successful, otherwise <code>-1</code> </dd></dl>
<p class="definition">Definition at line <a class="el" href="gf__audio_8c_source.html#l00088">88</a> of file <a class="el" href="gf__audio_8c_source.html">gf_audio.c</a>.</p>
</div>
</div>
<a id="a644b31417fc839bb2be69a88c2e77fbe" name="a644b31417fc839bb2be69a88c2e77fbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a644b31417fc839bb2be69a88c2e77fbe">&#9670;&#160;</a></span>gf_audio_load_file()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gf_audio_load_file </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgf__audio__t.html">gf_audio_t</a> *&#160;</td>
<td class="paramname"><em>audio</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>path</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load and play file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">audio</td><td>Audio interface </td></tr>
<tr><td class="paramname">path</td><td>Path </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>0</code> if successful, otherwise <code>-1</code> </dd></dl>
<p class="definition">Definition at line <a class="el" href="gf__audio_8c_source.html#l00136">136</a> of file <a class="el" href="gf__audio_8c_source.html">gf_audio.c</a>.</p>
</div>
</div>
</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