wut/struct_a_x_voice.html
2016-10-09 21:24:57 +01:00

394 lines
21 KiB
HTML

<!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.10"/>
<title>WUT: AXVoice Struct 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="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">WUT
&#160;<span id="projectnumber">0.1</span>
</div>
<div id="projectbrief">Wii U Toolchain</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<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="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><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="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
</ul>
</div>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">AXVoice Struct Reference<div class="ingroups"><a class="el" href="group__sndcore2.html">sndcore2</a> &raquo; <a class="el" href="group__sndcore2__voice.html">Voice</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="voice_8h_source.html">voice.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aafd95f8c7a99b9189ede7cdf0871ebe8"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_x_voice.html#aafd95f8c7a99b9189ede7cdf0871ebe8">index</a></td></tr>
<tr class="memdesc:aafd95f8c7a99b9189ede7cdf0871ebe8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The index of this voice out of the total voices. <a href="#aafd95f8c7a99b9189ede7cdf0871ebe8">More...</a><br /></td></tr>
<tr class="separator:aafd95f8c7a99b9189ede7cdf0871ebe8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09242878dd90d1c75af98341c0895b41"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__sndcore2__voice.html#gac06df98e23ea9badc164c48a6e38bafa">AXVoiceState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_x_voice.html#a09242878dd90d1c75af98341c0895b41">state</a></td></tr>
<tr class="memdesc:a09242878dd90d1c75af98341c0895b41"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current play state of this voice. <a href="#a09242878dd90d1c75af98341c0895b41">More...</a><br /></td></tr>
<tr class="separator:a09242878dd90d1c75af98341c0895b41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2b7935b01cdfe9a81d408dc3f2431f1"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_x_voice.html#ae2b7935b01cdfe9a81d408dc3f2431f1">volume</a></td></tr>
<tr class="memdesc:ae2b7935b01cdfe9a81d408dc3f2431f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current volume of this voice. <a href="#ae2b7935b01cdfe9a81d408dc3f2431f1">More...</a><br /></td></tr>
<tr class="separator:ae2b7935b01cdfe9a81d408dc3f2431f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb8502a1392cda13c07d553eaf86c94b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__sndcore2__voice.html#ga424ca8a80e4569cac4dfc138bbe47c1c">AXVoiceRenderer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_x_voice.html#adb8502a1392cda13c07d553eaf86c94b">renderer</a></td></tr>
<tr class="memdesc:adb8502a1392cda13c07d553eaf86c94b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The renderer to use for this voice. <a href="#adb8502a1392cda13c07d553eaf86c94b">More...</a><br /></td></tr>
<tr class="separator:adb8502a1392cda13c07d553eaf86c94b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa62641249cff62aae9126d21faeeb8ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_a_x_voice_link.html">AXVoiceLink</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_x_voice.html#aa62641249cff62aae9126d21faeeb8ad">link</a></td></tr>
<tr class="memdesc:aa62641249cff62aae9126d21faeeb8ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">this is a link used in the stack, we do this in host-memory currently <a href="#aa62641249cff62aae9126d21faeeb8ad">More...</a><br /></td></tr>
<tr class="separator:aa62641249cff62aae9126d21faeeb8ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ad2325751f0463a72f078519bdf29c8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_a_x_voice.html">AXVoice</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_x_voice.html#a4ad2325751f0463a72f078519bdf29c8">cbNext</a></td></tr>
<tr class="memdesc:a4ad2325751f0463a72f078519bdf29c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">A link to the next callback to invoke. <a href="#a4ad2325751f0463a72f078519bdf29c8">More...</a><br /></td></tr>
<tr class="separator:a4ad2325751f0463a72f078519bdf29c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90249de64da5ae5d7acd34da7ea1b857"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_x_voice.html#a90249de64da5ae5d7acd34da7ea1b857">priority</a></td></tr>
<tr class="memdesc:a90249de64da5ae5d7acd34da7ea1b857"><td class="mdescLeft">&#160;</td><td class="mdescRight">The priority of this voice used for force-acquiring a voice. <a href="#a90249de64da5ae5d7acd34da7ea1b857">More...</a><br /></td></tr>
<tr class="separator:a90249de64da5ae5d7acd34da7ea1b857"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79500e7e813fbb691503609458bc86b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__sndcore2__voice.html#ga1f4a6a7ebe0517dc2e061c48cbd60b76">AXVoiceCallbackFn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_x_voice.html#a79500e7e813fbb691503609458bc86b7">callback</a></td></tr>
<tr class="memdesc:a79500e7e813fbb691503609458bc86b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The callback to call if this is force-free'd by another acquire. <a href="#a79500e7e813fbb691503609458bc86b7">More...</a><br /></td></tr>
<tr class="separator:a79500e7e813fbb691503609458bc86b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aecf8a56c7369b86d173cb6253e26b0fe"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_x_voice.html#aecf8a56c7369b86d173cb6253e26b0fe">userContext</a></td></tr>
<tr class="memdesc:aecf8a56c7369b86d173cb6253e26b0fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">The user context to send to the callbacks. <a href="#aecf8a56c7369b86d173cb6253e26b0fe">More...</a><br /></td></tr>
<tr class="separator:aecf8a56c7369b86d173cb6253e26b0fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a998f7f831d62f5e71b6da95a8067f591"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_x_voice.html#a998f7f831d62f5e71b6da95a8067f591">syncBits</a></td></tr>
<tr class="memdesc:a998f7f831d62f5e71b6da95a8067f591"><td class="mdescLeft">&#160;</td><td class="mdescRight">A bitfield representing different things needing to be synced. <a href="#a998f7f831d62f5e71b6da95a8067f591">More...</a><br /></td></tr>
<tr class="separator:a998f7f831d62f5e71b6da95a8067f591"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a474317b6a6ec762b056d56cc8d151346"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_a_x_voice_offsets.html">AXVoiceOffsets</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_x_voice.html#a474317b6a6ec762b056d56cc8d151346">offsets</a></td></tr>
<tr class="memdesc:a474317b6a6ec762b056d56cc8d151346"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current offset data! <a href="#a474317b6a6ec762b056d56cc8d151346">More...</a><br /></td></tr>
<tr class="separator:a474317b6a6ec762b056d56cc8d151346"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64a5eb6af734e601715b83041c4328f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__sndcore2__voice.html#gac060f8cacd4baa7a68f234a71f43ccd9">AXVoiceCallbackExFn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_x_voice.html#a64a5eb6af734e601715b83041c4328f6">callbackEx</a></td></tr>
<tr class="memdesc:a64a5eb6af734e601715b83041c4328f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">An extended version of the callback above. <a href="#a64a5eb6af734e601715b83041c4328f6">More...</a><br /></td></tr>
<tr class="separator:a64a5eb6af734e601715b83041c4328f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeacea92f826181f0ca432d552c8579e8"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_x_voice.html#aeacea92f826181f0ca432d552c8579e8">callbackReason</a></td></tr>
<tr class="memdesc:aeacea92f826181f0ca432d552c8579e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The reason for the callback being invoked. <a href="#aeacea92f826181f0ca432d552c8579e8">More...</a><br /></td></tr>
<tr class="separator:aeacea92f826181f0ca432d552c8579e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0dfa8241b54d17fc418c9dc221bc45b"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_x_voice.html#af0dfa8241b54d17fc418c9dc221bc45b">unk0</a></td></tr>
<tr class="separator:af0dfa8241b54d17fc418c9dc221bc45b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7a90805ff3c6829ced44f062e0968b1"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_x_voice.html#ab7a90805ff3c6829ced44f062e0968b1">unk1</a></td></tr>
<tr class="separator:ab7a90805ff3c6829ced44f062e0968b1"><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>Definition at line <a class="el" href="voice_8h_source.html#l00125">125</a> of file <a class="el" href="voice_8h_source.html">voice.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="aafd95f8c7a99b9189ede7cdf0871ebe8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t index</td>
</tr>
</table>
</div><div class="memdoc">
<p>The index of this voice out of the total voices. </p>
<p>Definition at line <a class="el" href="voice_8h_source.html#l00128">128</a> of file <a class="el" href="voice_8h_source.html">voice.h</a>.</p>
</div>
</div>
<a class="anchor" id="a09242878dd90d1c75af98341c0895b41"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__sndcore2__voice.html#gac06df98e23ea9badc164c48a6e38bafa">AXVoiceState</a> state</td>
</tr>
</table>
</div><div class="memdoc">
<p>Current play state of this voice. </p>
<p>Definition at line <a class="el" href="voice_8h_source.html#l00131">131</a> of file <a class="el" href="voice_8h_source.html">voice.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae2b7935b01cdfe9a81d408dc3f2431f1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t volume</td>
</tr>
</table>
</div><div class="memdoc">
<p>Current volume of this voice. </p>
<p>Definition at line <a class="el" href="voice_8h_source.html#l00134">134</a> of file <a class="el" href="voice_8h_source.html">voice.h</a>.</p>
</div>
</div>
<a class="anchor" id="adb8502a1392cda13c07d553eaf86c94b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__sndcore2__voice.html#ga424ca8a80e4569cac4dfc138bbe47c1c">AXVoiceRenderer</a> renderer</td>
</tr>
</table>
</div><div class="memdoc">
<p>The renderer to use for this voice. </p>
<p>Definition at line <a class="el" href="voice_8h_source.html#l00137">137</a> of file <a class="el" href="voice_8h_source.html">voice.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa62641249cff62aae9126d21faeeb8ad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_a_x_voice_link.html">AXVoiceLink</a> link</td>
</tr>
</table>
</div><div class="memdoc">
<p>this is a link used in the stack, we do this in host-memory currently </p>
<p>Definition at line <a class="el" href="voice_8h_source.html#l00140">140</a> of file <a class="el" href="voice_8h_source.html">voice.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4ad2325751f0463a72f078519bdf29c8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_a_x_voice.html">AXVoice</a>* cbNext</td>
</tr>
</table>
</div><div class="memdoc">
<p>A link to the next callback to invoke. </p>
<p>Definition at line <a class="el" href="voice_8h_source.html#l00143">143</a> of file <a class="el" href="voice_8h_source.html">voice.h</a>.</p>
</div>
</div>
<a class="anchor" id="a90249de64da5ae5d7acd34da7ea1b857"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t priority</td>
</tr>
</table>
</div><div class="memdoc">
<p>The priority of this voice used for force-acquiring a voice. </p>
<p>Definition at line <a class="el" href="voice_8h_source.html#l00146">146</a> of file <a class="el" href="voice_8h_source.html">voice.h</a>.</p>
</div>
</div>
<a class="anchor" id="a79500e7e813fbb691503609458bc86b7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__sndcore2__voice.html#ga1f4a6a7ebe0517dc2e061c48cbd60b76">AXVoiceCallbackFn</a> callback</td>
</tr>
</table>
</div><div class="memdoc">
<p>The callback to call if this is force-free'd by another acquire. </p>
<p>Definition at line <a class="el" href="voice_8h_source.html#l00149">149</a> of file <a class="el" href="voice_8h_source.html">voice.h</a>.</p>
</div>
</div>
<a class="anchor" id="aecf8a56c7369b86d173cb6253e26b0fe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* userContext</td>
</tr>
</table>
</div><div class="memdoc">
<p>The user context to send to the callbacks. </p>
<p>Definition at line <a class="el" href="voice_8h_source.html#l00152">152</a> of file <a class="el" href="voice_8h_source.html">voice.h</a>.</p>
</div>
</div>
<a class="anchor" id="a998f7f831d62f5e71b6da95a8067f591"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t syncBits</td>
</tr>
</table>
</div><div class="memdoc">
<p>A bitfield representing different things needing to be synced. </p>
<p>Definition at line <a class="el" href="voice_8h_source.html#l00155">155</a> of file <a class="el" href="voice_8h_source.html">voice.h</a>.</p>
</div>
</div>
<a class="anchor" id="a474317b6a6ec762b056d56cc8d151346"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_a_x_voice_offsets.html">AXVoiceOffsets</a> offsets</td>
</tr>
</table>
</div><div class="memdoc">
<p>The current offset data! </p>
<p>Definition at line <a class="el" href="voice_8h_source.html#l00160">160</a> of file <a class="el" href="voice_8h_source.html">voice.h</a>.</p>
</div>
</div>
<a class="anchor" id="a64a5eb6af734e601715b83041c4328f6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__sndcore2__voice.html#gac060f8cacd4baa7a68f234a71f43ccd9">AXVoiceCallbackExFn</a> callbackEx</td>
</tr>
</table>
</div><div class="memdoc">
<p>An extended version of the callback above. </p>
<p>Definition at line <a class="el" href="voice_8h_source.html#l00163">163</a> of file <a class="el" href="voice_8h_source.html">voice.h</a>.</p>
</div>
</div>
<a class="anchor" id="aeacea92f826181f0ca432d552c8579e8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t callbackReason</td>
</tr>
</table>
</div><div class="memdoc">
<p>The reason for the callback being invoked. </p>
<p>Definition at line <a class="el" href="voice_8h_source.html#l00166">166</a> of file <a class="el" href="voice_8h_source.html">voice.h</a>.</p>
</div>
</div>
<a class="anchor" id="af0dfa8241b54d17fc418c9dc221bc45b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float unk0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="voice_8h_source.html#l00168">168</a> of file <a class="el" href="voice_8h_source.html">voice.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab7a90805ff3c6829ced44f062e0968b1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float unk1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="voice_8h_source.html#l00169">169</a> of file <a class="el" href="voice_8h_source.html">voice.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>D:/Programming/Projects/wut/include/sndcore2/<a class="el" href="voice_8h_source.html">voice.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>