shithub: leaf

ref: c9f87b8761155abf2cab26cb809bcf89016697f3
dir: /docs/leaf/group__tpbsaw.html/

View raw version
<!-- HTML header for doxygen 1.8.18-->
<!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.8.16" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>LEAF: tPBSaw</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>
    <script type="text/javascript" src="../js/iframeResizer.contentWindow.min.js"></script>
    <!-- <script src="/js/template.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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script> 
    <link href="doxygen.css" rel="stylesheet" type="text/css" />
    <link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
    <!-- <link rel="stylesheet" href="/css/tachyons.css" type="text/css" /> -->
</head>
<body class="bg-washed-green black-70 ph0 sans-serif" onload="iframeResizePipe()">
    <div>
        <!-- do not remove this div, it is closed by doxygen! -->
        <div id="titlearea">
            <table cellspacing="0" cellpadding="0">
                <tbody>
                    <tr>
                    </tr>
                </tbody>
            </table>
        </div>
        <!-- end header part -->
    </div>
</body>
</html><!-- Generated by Doxygen 1.8.16 -->
<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');
/* @license-end */
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</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><!-- top -->
<!-- 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="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">tPBSaw<div class="ingroups"><a class="el" href="group__oscillators.html">Oscillators</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Saw wave oscillator with polyBLEP anti-aliasing.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaefe02484a169c2babc92686caa77b211"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpbsaw.html#gaefe02484a169c2babc92686caa77b211">tPBSaw_init</a> (tPBSaw *const osc, <a class="el" href="struct_l_e_a_f.html">LEAF</a> *const leaf)</td></tr>
<tr class="memdesc:gaefe02484a169c2babc92686caa77b211"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a tPBSaw to the default mempool of a <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> instance.  <a href="group__tpbsaw.html#gaefe02484a169c2babc92686caa77b211">More...</a><br /></td></tr>
<tr class="separator:gaefe02484a169c2babc92686caa77b211"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga51843ccbdaef8d5251e11a0812c8e627"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpbsaw.html#ga51843ccbdaef8d5251e11a0812c8e627">tPBSaw_initToPool</a> (tPBSaw *const osc, tMempool *const mempool)</td></tr>
<tr class="memdesc:ga51843ccbdaef8d5251e11a0812c8e627"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a tPBSaw to a specified mempool.  <a href="group__tpbsaw.html#ga51843ccbdaef8d5251e11a0812c8e627">More...</a><br /></td></tr>
<tr class="separator:ga51843ccbdaef8d5251e11a0812c8e627"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3e00510154f54b8f7c8e8611217198ae"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpbsaw.html#ga3e00510154f54b8f7c8e8611217198ae">tPBSaw_free</a> (tPBSaw *const osc)</td></tr>
<tr class="memdesc:ga3e00510154f54b8f7c8e8611217198ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free a tPBSaw from its mempool.  <a href="group__tpbsaw.html#ga3e00510154f54b8f7c8e8611217198ae">More...</a><br /></td></tr>
<tr class="separator:ga3e00510154f54b8f7c8e8611217198ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga406a4319bcbae4c0f0dfaba1d5631328"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpbsaw.html#ga406a4319bcbae4c0f0dfaba1d5631328">tPBSaw_tick</a> (tPBSaw *const osc)</td></tr>
<tr class="separator:ga406a4319bcbae4c0f0dfaba1d5631328"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7e1f3a7848d2bcdab21f6cfe2e476bdc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpbsaw.html#ga7e1f3a7848d2bcdab21f6cfe2e476bdc">tPBSaw_setFreq</a> (tPBSaw *const osc, float freq)</td></tr>
<tr class="separator:ga7e1f3a7848d2bcdab21f6cfe2e476bdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Saw wave oscillator with polyBLEP anti-aliasing. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaefe02484a169c2babc92686caa77b211"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaefe02484a169c2babc92686caa77b211">&#9670;&nbsp;</a></span>tPBSaw_init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void tPBSaw_init </td>
          <td>(</td>
          <td class="paramtype">tPBSaw *const&#160;</td>
          <td class="paramname"><em>osc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_l_e_a_f.html">LEAF</a> *const&#160;</td>
          <td class="paramname"><em>leaf</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialize a tPBSaw to the default mempool of a <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">osc</td><td>A pointer to the tPBSaw to initialize. </td></tr>
    <tr><td class="paramname">leaf</td><td>A pointer to the leaf instance. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga51843ccbdaef8d5251e11a0812c8e627"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga51843ccbdaef8d5251e11a0812c8e627">&#9670;&nbsp;</a></span>tPBSaw_initToPool()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void tPBSaw_initToPool </td>
          <td>(</td>
          <td class="paramtype">tPBSaw *const&#160;</td>
          <td class="paramname"><em>osc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">tMempool *const&#160;</td>
          <td class="paramname"><em>mempool</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialize a tPBSaw to a specified mempool. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">osc</td><td>A pointer to the tPBSaw to initialize. </td></tr>
    <tr><td class="paramname">mempool</td><td>A pointer to the tMempool to use. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga3e00510154f54b8f7c8e8611217198ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3e00510154f54b8f7c8e8611217198ae">&#9670;&nbsp;</a></span>tPBSaw_free()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void tPBSaw_free </td>
          <td>(</td>
          <td class="paramtype">tPBSaw *const&#160;</td>
          <td class="paramname"><em>osc</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Free a tPBSaw from its mempool. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">osc</td><td>A pointer to the tPBSaw to free. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga406a4319bcbae4c0f0dfaba1d5631328"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga406a4319bcbae4c0f0dfaba1d5631328">&#9670;&nbsp;</a></span>tPBSaw_tick()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float tPBSaw_tick </td>
          <td>(</td>
          <td class="paramtype">tPBSaw *const&#160;</td>
          <td class="paramname"><em>osc</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">osc</td><td>A pointer to the relevant tPBSaw. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga7e1f3a7848d2bcdab21f6cfe2e476bdc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7e1f3a7848d2bcdab21f6cfe2e476bdc">&#9670;&nbsp;</a></span>tPBSaw_setFreq()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void tPBSaw_setFreq </td>
          <td>(</td>
          <td class="paramtype">tPBSaw *const&#160;</td>
          <td class="paramname"><em>osc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>freq</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">osc</td><td>A pointer to the relevant tPBSaw.  </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
</body>
</html>