DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF


			
				
					
						
						
							
							<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DISTRHO Plugin Framework: TimePosition::BarBeatTick 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>
<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">DISTRHO Plugin Framework
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></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 id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="structTimePosition.html">TimePosition</a></li><li class="navelem"><a class="el" href="structTimePosition_1_1BarBeatTick.html">BarBeatTick</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structTimePosition_1_1BarBeatTick-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">TimePosition::BarBeatTick Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="DistrhoDetails_8hpp_source.html">DistrhoDetails.hpp</a>&gt;</code></p>
<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:abff8c9586a4e82694e7d6bac3e8da1ef"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTimePosition_1_1BarBeatTick.html#abff8c9586a4e82694e7d6bac3e8da1ef">BarBeatTick</a> () noexcept</td></tr>
<tr class="separator:abff8c9586a4e82694e7d6bac3e8da1ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6ea776260b58800bff63f515351bd3a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTimePosition_1_1BarBeatTick.html#ae6ea776260b58800bff63f515351bd3a">clear</a> () noexcept</td></tr>
<tr class="separator:ae6ea776260b58800bff63f515351bd3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a45a05047e923285af0fbeacb371e3f4e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTimePosition_1_1BarBeatTick.html#a45a05047e923285af0fbeacb371e3f4e">valid</a></td></tr>
<tr class="separator:a45a05047e923285af0fbeacb371e3f4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad104eba852516842d8c4776f9d495d21"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTimePosition_1_1BarBeatTick.html#ad104eba852516842d8c4776f9d495d21">bar</a></td></tr>
<tr class="separator:ad104eba852516842d8c4776f9d495d21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4be3edce420539cbb21bc1b0278201c"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTimePosition_1_1BarBeatTick.html#af4be3edce420539cbb21bc1b0278201c">beat</a></td></tr>
<tr class="separator:af4be3edce420539cbb21bc1b0278201c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aecb8a1a98db84c6d03c39278f86a0324"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTimePosition_1_1BarBeatTick.html#aecb8a1a98db84c6d03c39278f86a0324">tick</a></td></tr>
<tr class="separator:aecb8a1a98db84c6d03c39278f86a0324"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5205e95c8f8021006bde2eae774d5b62"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTimePosition_1_1BarBeatTick.html#a5205e95c8f8021006bde2eae774d5b62">barStartTick</a></td></tr>
<tr class="separator:a5205e95c8f8021006bde2eae774d5b62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4805c98ceeedca9fb886de068c50cb88"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTimePosition_1_1BarBeatTick.html#a4805c98ceeedca9fb886de068c50cb88">beatsPerBar</a></td></tr>
<tr class="separator:a4805c98ceeedca9fb886de068c50cb88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d0f3681391ab7d3d37abcae24c72257"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTimePosition_1_1BarBeatTick.html#a3d0f3681391ab7d3d37abcae24c72257">beatType</a></td></tr>
<tr class="separator:a3d0f3681391ab7d3d37abcae24c72257"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8cfc3f2709a79e733e58556712da062"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTimePosition_1_1BarBeatTick.html#ab8cfc3f2709a79e733e58556712da062">ticksPerBeat</a></td></tr>
<tr class="separator:ab8cfc3f2709a79e733e58556712da062"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7cb9ae9b30da287828ebddee5caff2f"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTimePosition_1_1BarBeatTick.html#af7cb9ae9b30da287828ebddee5caff2f">beatsPerMinute</a></td></tr>
<tr class="separator:af7cb9ae9b30da287828ebddee5caff2f"><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>Bar-Beat-Tick time position. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="abff8c9586a4e82694e7d6bac3e8da1ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abff8c9586a4e82694e7d6bac3e8da1ef">&#9670;&nbsp;</a></span>BarBeatTick()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">TimePosition::BarBeatTick::BarBeatTick </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Default constructor for a null BBT time position. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae6ea776260b58800bff63f515351bd3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6ea776260b58800bff63f515351bd3a">&#9670;&nbsp;</a></span>clear()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void TimePosition::BarBeatTick::clear </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Reinitialize this position using the default null initialization. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a45a05047e923285af0fbeacb371e3f4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45a05047e923285af0fbeacb371e3f4e">&#9670;&nbsp;</a></span>valid</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool TimePosition::BarBeatTick::valid</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Wherever the host transport is using BBT.<br  />
If false you must not read from this struct. </p>

</div>
</div>
<a id="ad104eba852516842d8c4776f9d495d21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad104eba852516842d8c4776f9d495d21">&#9670;&nbsp;</a></span>bar</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t TimePosition::BarBeatTick::bar</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Current bar.<br  />
Should always be &gt; 0.<br  />
The first bar is bar '1'. </p>

</div>
</div>
<a id="af4be3edce420539cbb21bc1b0278201c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4be3edce420539cbb21bc1b0278201c">&#9670;&nbsp;</a></span>beat</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t TimePosition::BarBeatTick::beat</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Current beat within bar.<br  />
Should always be &gt; 0 and &lt;= <em>beatsPerBar</em>.<br  />
The first beat is beat '1'. </p>

</div>
</div>
<a id="aecb8a1a98db84c6d03c39278f86a0324"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aecb8a1a98db84c6d03c39278f86a0324">&#9670;&nbsp;</a></span>tick</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double TimePosition::BarBeatTick::tick</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Current tick within beat.<br  />
Should always be &gt;= 0 and &lt; <em>ticksPerBeat</em>.<br  />
The first tick is tick '0'. </p><dl class="section note"><dt>Note</dt><dd>Fraction part of tick is only available on some plugin formats. </dd></dl>

</div>
</div>
<a id="a5205e95c8f8021006bde2eae774d5b62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5205e95c8f8021006bde2eae774d5b62">&#9670;&nbsp;</a></span>barStartTick</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double TimePosition::BarBeatTick::barStartTick</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Number of ticks that have elapsed between frame 0 and the first beat of the current measure. </p>

</div>
</div>
<a id="a4805c98ceeedca9fb886de068c50cb88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4805c98ceeedca9fb886de068c50cb88">&#9670;&nbsp;</a></span>beatsPerBar</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float TimePosition::BarBeatTick::beatsPerBar</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Time signature "numerator". </p>

</div>
</div>
<a id="a3d0f3681391ab7d3d37abcae24c72257"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d0f3681391ab7d3d37abcae24c72257">&#9670;&nbsp;</a></span>beatType</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float TimePosition::BarBeatTick::beatType</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Time signature "denominator". </p>

</div>
</div>
<a id="ab8cfc3f2709a79e733e58556712da062"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8cfc3f2709a79e733e58556712da062">&#9670;&nbsp;</a></span>ticksPerBeat</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double TimePosition::BarBeatTick::ticksPerBeat</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Number of ticks within a beat.<br  />
Usually a moderately large integer with many denominators, such as 1920.0. </p>

</div>
</div>
<a id="af7cb9ae9b30da287828ebddee5caff2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7cb9ae9b30da287828ebddee5caff2f">&#9670;&nbsp;</a></span>beatsPerMinute</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double TimePosition::BarBeatTick::beatsPerMinute</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Number of beats per minute. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>distrho/<a class="el" href="DistrhoDetails_8hpp_source.html">DistrhoDetails.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>