DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
391 Commits
7 Branches
225MB
Tree: e20bc6408d
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'e20bc6408d'
${ noResults }
DPF/structTimePosition_1_1BarBe...

318 lines
15KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.8.6"/>

  7. <title>DISTRHO Plugin Framework: TimePosition::BarBeatTick Struct Reference</title>

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  9. <script type="text/javascript" src="jquery.js"></script>

  10. <script type="text/javascript" src="dynsections.js"></script>

  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  12. <script type="text/javascript" src="search/search.js"></script>

  13. <script type="text/javascript">

  14.   $(document).ready(function() { searchBox.OnSelectItem(0); });

  15. </script>

  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  17. </head>

  18. <body>

  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  20. <div id="titlearea">

  21. <table cellspacing="0" cellpadding="0">

  22.  <tbody>

  23.  <tr style="height: 56px;">

  24.   <td style="padding-left: 0.5em;">

  25.    <div id="projectname">DISTRHO Plugin Framework

  26.    </div>

  27.   </td>

  28.  </tr>

  29.  </tbody>

  30. </table>

  31. </div>

  32. <!-- end header part -->

  33. <!-- Generated by Doxygen 1.8.6 -->

  34. <script type="text/javascript">

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  36. </script>

  37.   <div id="navrow1" class="tabs">

  38.     <ul class="tablist">

  39.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>

  40.       <li><a href="modules.html"><span>Modules</span></a></li>

  41.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>

  42.       <li><a href="files.html"><span>Files</span></a></li>

  43.       <li>

  44.         <div id="MSearchBox" class="MSearchBoxInactive">

  45.         <span class="left">

  46.           <img id="MSearchSelect" src="search/mag_sel.png"

  47.                onmouseover="return searchBox.OnSearchSelectShow()"

  48.                onmouseout="return searchBox.OnSearchSelectHide()"

  49.                alt=""/>

  50.           <input type="text" id="MSearchField" value="Search" accesskey="S"

  51.                onfocus="searchBox.OnSearchFieldFocus(true)" 

  52.                onblur="searchBox.OnSearchFieldFocus(false)" 

  53.                onkeyup="searchBox.OnSearchFieldChange(event)"/>

  54.           </span><span class="right">

  55.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

  61.   <div id="navrow2" class="tabs2">

  62.     <ul class="tablist">

  63.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>

  64.       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>

  65.       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>

  66.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>

  67.     </ul>

  68.   </div>

  69. <!-- window showing the filter options -->

  70. <div id="MSearchSelectWindow"

  71.      onmouseover="return searchBox.OnSearchSelectShow()"

  72.      onmouseout="return searchBox.OnSearchSelectHide()"

  73.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  74. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Pages</a></div>

  75. 

  76. <!-- iframe showing the search results (closed by default) -->

  77. <div id="MSearchResultsWindow">

  78. <iframe src="javascript:void(0)" frameborder="0" 

  79.         name="MSearchResults" id="MSearchResults">

  80. </iframe>

  81. </div>

  82. 

  83. <div id="nav-path" class="navpath">

  84.   <ul>

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

  86. </div>

  87. </div><!-- top -->

  88. <div class="header">

  89.   <div class="summary">

  90. <a href="#pub-methods">Public Member Functions</a> &#124;

  91. <a href="#pub-attribs">Public Attributes</a> &#124;

  92. <a href="structTimePosition_1_1BarBeatTick-members.html">List of all members</a>  </div>

  93.   <div class="headertitle">

  94. <div class="title">TimePosition::BarBeatTick Struct Reference</div>  </div>

  95. </div><!--header-->

  96. <div class="contents">

  97. 

  98. <p><code>#include &lt;<a class="el" href="DistrhoPlugin_8hpp_source.html">DistrhoPlugin.hpp</a>&gt;</code></p>

  99. <table class="memberdecls">

  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  101. Public Member Functions</h2></td></tr>

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

  103. <tr class="separator:abff8c9586a4e82694e7d6bac3e8da1ef"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  105. <tr class="separator:ae6ea776260b58800bff63f515351bd3a"><td class="memSeparator" colspan="2">&#160;</td></tr>

  106. </table><table class="memberdecls">

  107. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>

  108. Public Attributes</h2></td></tr>

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

  110. <tr class="separator:a45a05047e923285af0fbeacb371e3f4e"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  112. <tr class="separator:ad104eba852516842d8c4776f9d495d21"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  114. <tr class="separator:af4be3edce420539cbb21bc1b0278201c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  115. <tr class="memitem:ad38d7364a5441f1f49c3538f5691a299"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTimePosition_1_1BarBeatTick.html#ad38d7364a5441f1f49c3538f5691a299">tick</a></td></tr>

  116. <tr class="separator:ad38d7364a5441f1f49c3538f5691a299"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  118. <tr class="separator:a5205e95c8f8021006bde2eae774d5b62"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  120. <tr class="separator:a4805c98ceeedca9fb886de068c50cb88"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  122. <tr class="separator:a3d0f3681391ab7d3d37abcae24c72257"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  124. <tr class="separator:ab8cfc3f2709a79e733e58556712da062"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  126. <tr class="separator:af7cb9ae9b30da287828ebddee5caff2f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  127. </table>

  128. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  129. <div class="textblock"><p>Bar-Beat-Tick time position. </p>

  130. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  131. <a class="anchor" id="abff8c9586a4e82694e7d6bac3e8da1ef"></a>

  132. <div class="memitem">

  133. <div class="memproto">

  134. <table class="mlabels">

  135.   <tr>

  136.   <td class="mlabels-left">

  137.       <table class="memname">

  138.         <tr>

  139.           <td class="memname">TimePosition::BarBeatTick::BarBeatTick </td>

  140.           <td>(</td>

  141.           <td class="paramname"></td><td>)</td>

  142.           <td></td>

  143.         </tr>

  144.       </table>

  145.   </td>

  146.   <td class="mlabels-right">

  147. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  148.   </tr>

  149. </table>

  150. </div><div class="memdoc">

  151. <p>Default constructor for a null BBT time position. </p>

  152. 

  153. </div>

  154. </div>

  155. <h2 class="groupheader">Member Function Documentation</h2>

  156. <a class="anchor" id="ae6ea776260b58800bff63f515351bd3a"></a>

  157. <div class="memitem">

  158. <div class="memproto">

  159. <table class="mlabels">

  160.   <tr>

  161.   <td class="mlabels-left">

  162.       <table class="memname">

  163.         <tr>

  164.           <td class="memname">void TimePosition::BarBeatTick::clear </td>

  165.           <td>(</td>

  166.           <td class="paramname"></td><td>)</td>

  167.           <td></td>

  168.         </tr>

  169.       </table>

  170.   </td>

  171.   <td class="mlabels-right">

  172. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  173.   </tr>

  174. </table>

  175. </div><div class="memdoc">

  176. <p>Reinitialize this position using the default null initialization. </p>

  177. 

  178. </div>

  179. </div>

  180. <h2 class="groupheader">Member Data Documentation</h2>

  181. <a class="anchor" id="a45a05047e923285af0fbeacb371e3f4e"></a>

  182. <div class="memitem">

  183. <div class="memproto">

  184.       <table class="memname">

  185.         <tr>

  186.           <td class="memname">bool TimePosition::BarBeatTick::valid</td>

  187.         </tr>

  188.       </table>

  189. </div><div class="memdoc">

  190. <p>Wherever the host transport is using BBT.<br/>

  191. If false you must not read from this struct. </p>

  192. 

  193. </div>

  194. </div>

  195. <a class="anchor" id="ad104eba852516842d8c4776f9d495d21"></a>

  196. <div class="memitem">

  197. <div class="memproto">

  198.       <table class="memname">

  199.         <tr>

  200.           <td class="memname">int32_t TimePosition::BarBeatTick::bar</td>

  201.         </tr>

  202.       </table>

  203. </div><div class="memdoc">

  204. <p>Current bar.<br/>

  205. Should always be &gt; 0.<br/>

  206. The first bar is bar '1'. </p>

  207. 

  208. </div>

  209. </div>

  210. <a class="anchor" id="af4be3edce420539cbb21bc1b0278201c"></a>

  211. <div class="memitem">

  212. <div class="memproto">

  213.       <table class="memname">

  214.         <tr>

  215.           <td class="memname">int32_t TimePosition::BarBeatTick::beat</td>

  216.         </tr>

  217.       </table>

  218. </div><div class="memdoc">

  219. <p>Current beat within bar.<br/>

  220. Should always be &gt; 0 and &lt;= <em>beatsPerBar</em>.<br/>

  221. The first beat is beat '1'. </p>

  222. 

  223. </div>

  224. </div>

  225. <a class="anchor" id="ad38d7364a5441f1f49c3538f5691a299"></a>

  226. <div class="memitem">

  227. <div class="memproto">

  228.       <table class="memname">

  229.         <tr>

  230.           <td class="memname">int32_t TimePosition::BarBeatTick::tick</td>

  231.         </tr>

  232.       </table>

  233. </div><div class="memdoc">

  234. <p>Current tick within beat.<br/>

  235. Should always be &gt;= 0 and &lt; <em>ticksPerBeat</em>.<br/>

  236. The first tick is tick '0'. </p>

  237. 

  238. </div>

  239. </div>

  240. <a class="anchor" id="a5205e95c8f8021006bde2eae774d5b62"></a>

  241. <div class="memitem">

  242. <div class="memproto">

  243.       <table class="memname">

  244.         <tr>

  245.           <td class="memname">double TimePosition::BarBeatTick::barStartTick</td>

  246.         </tr>

  247.       </table>

  248. </div><div class="memdoc">

  249. <p>Number of ticks that have elapsed between frame 0 and the first beat of the current measure. </p>

  250. 

  251. </div>

  252. </div>

  253. <a class="anchor" id="a4805c98ceeedca9fb886de068c50cb88"></a>

  254. <div class="memitem">

  255. <div class="memproto">

  256.       <table class="memname">

  257.         <tr>

  258.           <td class="memname">float TimePosition::BarBeatTick::beatsPerBar</td>

  259.         </tr>

  260.       </table>

  261. </div><div class="memdoc">

  262. <p>Time signature "numerator". </p>

  263. 

  264. </div>

  265. </div>

  266. <a class="anchor" id="a3d0f3681391ab7d3d37abcae24c72257"></a>

  267. <div class="memitem">

  268. <div class="memproto">

  269.       <table class="memname">

  270.         <tr>

  271.           <td class="memname">float TimePosition::BarBeatTick::beatType</td>

  272.         </tr>

  273.       </table>

  274. </div><div class="memdoc">

  275. <p>Time signature "denominator". </p>

  276. 

  277. </div>

  278. </div>

  279. <a class="anchor" id="ab8cfc3f2709a79e733e58556712da062"></a>

  280. <div class="memitem">

  281. <div class="memproto">

  282.       <table class="memname">

  283.         <tr>

  284.           <td class="memname">double TimePosition::BarBeatTick::ticksPerBeat</td>

  285.         </tr>

  286.       </table>

  287. </div><div class="memdoc">

  288. <p>Number of ticks within a beat.<br/>

  289. Usually a moderately large integer with many denominators, such as 1920.0. </p>

  290. 

  291. </div>

  292. </div>

  293. <a class="anchor" id="af7cb9ae9b30da287828ebddee5caff2f"></a>

  294. <div class="memitem">

  295. <div class="memproto">

  296.       <table class="memname">

  297.         <tr>

  298.           <td class="memname">double TimePosition::BarBeatTick::beatsPerMinute</td>

  299.         </tr>

  300.       </table>

  301. </div><div class="memdoc">

  302. <p>Number of beats per minute. </p>

  303. 

  304. </div>

  305. </div>

  306. <hr/>The documentation for this struct was generated from the following file:<ul>

  307. <li>distrho/<a class="el" href="DistrhoPlugin_8hpp_source.html">DistrhoPlugin.hpp</a></li>

  308. </ul>

  309. </div><!-- contents -->

  310. <!-- start footer part -->

  311. <hr class="footer"/><address class="footer"><small>

  312. Generated on Mon Jun 24 2019 11:54:44 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

  313. <img class="footer" src="doxygen.png" alt="doxygen"/>

  314. </a> 1.8.6

  315. </small></address>

  316. </body>

  317. </html>