mirror of https://github.com/AxioDL/amuse.git
188 lines
12 KiB
HTML
188 lines
12 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.11"/>
|
||
|
|
<title>Amuse: amuse::EffectChorusImp< T > Class Template 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>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(document).ready(initResizable);
|
||
|
|
$(window).load(resizeHeight);
|
||
|
|
</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">Amuse
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
||
|
|
<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 Page</span></a></li>
|
||
|
|
<li class="current"><a href="annotated.html"><span>Classes</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>Class List</span></a></li>
|
||
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
||
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||
|
|
</ul>
|
||
|
|
</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">
|
||
|
|
$(document).ready(function(){initNavTree('classamuse_1_1_effect_chorus_imp.html','');});
|
||
|
|
</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="#nested-classes">Classes</a> |
|
||
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
||
|
|
<a href="classamuse_1_1_effect_chorus_imp-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">amuse::EffectChorusImp< T > Class Template Reference</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p><code>#include <<a class="el" href="_effect_chorus_8hpp_source.html">EffectChorus.hpp</a>></code></p>
|
||
|
|
<div class="dynheader">
|
||
|
|
Inheritance diagram for amuse::EffectChorusImp< T >:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><img src="classamuse_1_1_effect_chorus_imp__inherit__graph.png" border="0" usemap="#amuse_1_1_effect_chorus_imp_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
|
||
|
|
<map name="amuse_1_1_effect_chorus_imp_3_01_t_01_4_inherit__map" id="amuse_1_1_effect_chorus_imp_3_01_t_01_4_inherit__map">
|
||
|
|
<area shape="rect" id="node2" href="classamuse_1_1_effect_base.html" title="{amuse::EffectBase\< T \>\n||+ applyEffect()\l}" alt="" coords="17,145,188,223"/>
|
||
|
|
<area shape="rect" id="node3" href="classamuse_1_1_effect_base_typeless.html" title="{amuse::EffectBaseTypeless\n||+ ~EffectBaseTypeless()\l}" alt="" coords="5,5,200,83"/>
|
||
|
|
<area shape="rect" id="node4" href="classamuse_1_1_effect_chorus.html" title="{amuse::EffectChorus\n||+ setBaseDelay()\l+ setVariation()\l+ setPeriod()\l}" alt="" coords="213,131,363,237"/>
|
||
|
|
</map>
|
||
|
|
</div>
|
||
|
|
<div class="dynheader">
|
||
|
|
Collaboration diagram for amuse::EffectChorusImp< T >:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><img src="classamuse_1_1_effect_chorus_imp__coll__graph.png" border="0" usemap="#amuse_1_1_effect_chorus_imp_3_01_t_01_4_coll__map" alt="Collaboration graph"/></div>
|
||
|
|
<map name="amuse_1_1_effect_chorus_imp_3_01_t_01_4_coll__map" id="amuse_1_1_effect_chorus_imp_3_01_t_01_4_coll__map">
|
||
|
|
<area shape="rect" id="node2" href="classamuse_1_1_effect_base.html" title="{amuse::EffectBase\< T \>\n||+ applyEffect()\l}" alt="" coords="17,145,188,223"/>
|
||
|
|
<area shape="rect" id="node3" href="classamuse_1_1_effect_base_typeless.html" title="{amuse::EffectBaseTypeless\n||+ ~EffectBaseTypeless()\l}" alt="" coords="5,5,200,83"/>
|
||
|
|
<area shape="rect" id="node4" href="classamuse_1_1_effect_chorus.html" title="{amuse::EffectChorus\n||+ setBaseDelay()\l+ setVariation()\l+ setPeriod()\l}" alt="" coords="213,131,363,237"/>
|
||
|
|
</map>
|
||
|
|
</div>
|
||
|
|
<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:a6d371f4add167bba8a4a8a6760741ab5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6d371f4add167bba8a4a8a6760741ab5"></a>
|
||
|
|
 </td><td class="memItemRight" valign="bottom"><b>EffectChorusImp</b> (uint32_t baseDelay, uint32_t variation, uint32_t period, double sampleRate)</td></tr>
|
||
|
|
<tr class="separator:a6d371f4add167bba8a4a8a6760741ab5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a9711d9eab375b99445d0430c235d51e7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9711d9eab375b99445d0430c235d51e7"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><b>applyEffect</b> (T *audio, size_t frameCount, const <a class="el" href="structamuse_1_1_channel_map.html">ChannelMap</a> &chanMap)</td></tr>
|
||
|
|
<tr class="separator:a9711d9eab375b99445d0430c235d51e7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pub_methods_classamuse_1_1_effect_chorus"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classamuse_1_1_effect_chorus')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classamuse_1_1_effect_chorus.html">amuse::EffectChorus</a></td></tr>
|
||
|
|
<tr class="memitem:a3b81f7c286f7e8d1896e2dd887e97826 inherit pub_methods_classamuse_1_1_effect_chorus"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b81f7c286f7e8d1896e2dd887e97826"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><b>setBaseDelay</b> (uint32_t baseDelay)</td></tr>
|
||
|
|
<tr class="separator:a3b81f7c286f7e8d1896e2dd887e97826 inherit pub_methods_classamuse_1_1_effect_chorus"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ae207b261549d2caca454401558ac634e inherit pub_methods_classamuse_1_1_effect_chorus"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae207b261549d2caca454401558ac634e"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><b>setVariation</b> (uint32_t variation)</td></tr>
|
||
|
|
<tr class="separator:ae207b261549d2caca454401558ac634e inherit pub_methods_classamuse_1_1_effect_chorus"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a38bb81e936ba80b677b300883c4ac42a inherit pub_methods_classamuse_1_1_effect_chorus"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38bb81e936ba80b677b300883c4ac42a"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><b>setPeriod</b> (uint32_t period)</td></tr>
|
||
|
|
<tr class="separator:a38bb81e936ba80b677b300883c4ac42a inherit pub_methods_classamuse_1_1_effect_chorus"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
||
|
|
Additional Inherited Members</h2></td></tr>
|
||
|
|
<tr class="inherit_header pub_types_classamuse_1_1_effect_chorus"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classamuse_1_1_effect_chorus')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classamuse_1_1_effect_chorus.html">amuse::EffectChorus</a></td></tr>
|
||
|
|
<tr class="memitem:a1101e7513f0472877cbe93cbc5ae9c68 inherit pub_types_classamuse_1_1_effect_chorus"><td class="memTemplParams" colspan="2"><a class="anchor" id="a1101e7513f0472877cbe93cbc5ae9c68"></a>
|
||
|
|
template<typename T > </td></tr>
|
||
|
|
<tr class="memitem:a1101e7513f0472877cbe93cbc5ae9c68 inherit pub_types_classamuse_1_1_effect_chorus"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><b>ImpType</b> = <a class="el" href="classamuse_1_1_effect_chorus_imp.html">EffectChorusImp</a>< T ></td></tr>
|
||
|
|
<tr class="separator:a1101e7513f0472877cbe93cbc5ae9c68 inherit pub_types_classamuse_1_1_effect_chorus"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><h3>template<typename T><br />
|
||
|
|
class amuse::EffectChorusImp< T ></h3>
|
||
|
|
|
||
|
|
<p>Type-specific implementation of chorus effect </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="_effect_chorus_8hpp_source.html#l00011">11</a> of file <a class="el" href="_effect_chorus_8hpp_source.html">EffectChorus.hpp</a>.</p>
|
||
|
|
</div><hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
|
<li>include/amuse/<a class="el" href="_effect_chorus_8hpp_source.html">EffectChorus.hpp</a></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"><b>amuse</b></li><li class="navelem"><a class="el" href="classamuse_1_1_effect_chorus_imp.html">EffectChorusImp</a></li>
|
||
|
|
<li class="footer">Generated on Wed May 18 2016 20:05:19 for Amuse by
|
||
|
|
<a href="http://www.doxygen.org/index.html">
|
||
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|