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.
389 Commits
7 Branches
62MB
Tree: 51186ba54a
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '51186ba54a'
${ noResults }
DPF/structTimePosition_1_1BarBe...

316 lines
14KB
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.13"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

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

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

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

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

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

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

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

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

  16. </head>

  17. <body>

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

  19. <div id="titlearea">

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

  21.  <tbody>

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

  23.   <td id="projectalign" style="padding-left: 0.5em;">

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

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

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

  32. <!-- Generated by Doxygen 1.8.13 -->

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

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

  35. </script>

  36. <script type="text/javascript" src="menudata.js"></script>

  37. <script type="text/javascript" src="menu.js"></script>

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

  39. $(function() {

  40.   initMenu('',true,false,'search.php','Search');

  41.   $(document).ready(function() { init_search(); });

  42. });

  43. </script>

  44. <div id="main-nav"></div>

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

  46. <div id="MSearchSelectWindow"

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

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

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

  50. </div>

  51. 

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

  53. <div id="MSearchResultsWindow">

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

  55.         name="MSearchResults" id="MSearchResults">

  56. </iframe>

  57. </div>

  58. 

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

  60.   <ul>

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

  62. </div>

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

  64. <div class="header">

  65.   <div class="summary">

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

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

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

  69.   <div class="headertitle">

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

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

  72. <div class="contents">

  73. 

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

  75. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  103. </table>

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

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

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

  107. <a id="abff8c9586a4e82694e7d6bac3e8da1ef"></a>

  108. <h2 class="memtitle"><span class="permalink"><a href="#abff8c9586a4e82694e7d6bac3e8da1ef">&#9670;&nbsp;</a></span>BarBeatTick()</h2>

  109. 

  110. <div class="memitem">

  111. <div class="memproto">

  112. <table class="mlabels">

  113.   <tr>

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

  115.       <table class="memname">

  116.         <tr>

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

  118.           <td>(</td>

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

  120.           <td></td>

  121.         </tr>

  122.       </table>

  123.   </td>

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

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

  126.   </tr>

  127. </table>

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

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

  130. 

  131. </div>

  132. </div>

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

  134. <a id="ae6ea776260b58800bff63f515351bd3a"></a>

  135. <h2 class="memtitle"><span class="permalink"><a href="#ae6ea776260b58800bff63f515351bd3a">&#9670;&nbsp;</a></span>clear()</h2>

  136. 

  137. <div class="memitem">

  138. <div class="memproto">

  139. <table class="mlabels">

  140.   <tr>

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

  142.       <table class="memname">

  143.         <tr>

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

  145.           <td>(</td>

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

  147.           <td></td>

  148.         </tr>

  149.       </table>

  150.   </td>

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

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

  153.   </tr>

  154. </table>

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

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

  157. 

  158. </div>

  159. </div>

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

  161. <a id="a45a05047e923285af0fbeacb371e3f4e"></a>

  162. <h2 class="memtitle"><span class="permalink"><a href="#a45a05047e923285af0fbeacb371e3f4e">&#9670;&nbsp;</a></span>valid</h2>

  163. 

  164. <div class="memitem">

  165. <div class="memproto">

  166.       <table class="memname">

  167.         <tr>

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

  169.         </tr>

  170.       </table>

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

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

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

  174. 

  175. </div>

  176. </div>

  177. <a id="ad104eba852516842d8c4776f9d495d21"></a>

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

  179. 

  180. <div class="memitem">

  181. <div class="memproto">

  182.       <table class="memname">

  183.         <tr>

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

  185.         </tr>

  186.       </table>

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

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

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

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

  191. 

  192. </div>

  193. </div>

  194. <a id="af4be3edce420539cbb21bc1b0278201c"></a>

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

  196. 

  197. <div class="memitem">

  198. <div class="memproto">

  199.       <table class="memname">

  200.         <tr>

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

  202.         </tr>

  203.       </table>

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

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

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

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

  208. 

  209. </div>

  210. </div>

  211. <a id="ad38d7364a5441f1f49c3538f5691a299"></a>

  212. <h2 class="memtitle"><span class="permalink"><a href="#ad38d7364a5441f1f49c3538f5691a299">&#9670;&nbsp;</a></span>tick</h2>

  213. 

  214. <div class="memitem">

  215. <div class="memproto">

  216.       <table class="memname">

  217.         <tr>

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

  219.         </tr>

  220.       </table>

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

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

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

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

  225. 

  226. </div>

  227. </div>

  228. <a id="a5205e95c8f8021006bde2eae774d5b62"></a>

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

  230. 

  231. <div class="memitem">

  232. <div class="memproto">

  233.       <table class="memname">

  234.         <tr>

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

  236.         </tr>

  237.       </table>

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

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

  240. 

  241. </div>

  242. </div>

  243. <a id="a4805c98ceeedca9fb886de068c50cb88"></a>

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

  245. 

  246. <div class="memitem">

  247. <div class="memproto">

  248.       <table class="memname">

  249.         <tr>

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

  251.         </tr>

  252.       </table>

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

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

  255. 

  256. </div>

  257. </div>

  258. <a id="a3d0f3681391ab7d3d37abcae24c72257"></a>

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

  260. 

  261. <div class="memitem">

  262. <div class="memproto">

  263.       <table class="memname">

  264.         <tr>

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

  266.         </tr>

  267.       </table>

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

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

  270. 

  271. </div>

  272. </div>

  273. <a id="ab8cfc3f2709a79e733e58556712da062"></a>

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

  275. 

  276. <div class="memitem">

  277. <div class="memproto">

  278.       <table class="memname">

  279.         <tr>

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

  281.         </tr>

  282.       </table>

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

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

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

  286. 

  287. </div>

  288. </div>

  289. <a id="af7cb9ae9b30da287828ebddee5caff2f"></a>

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

  291. 

  292. <div class="memitem">

  293. <div class="memproto">

  294.       <table class="memname">

  295.         <tr>

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

  297.         </tr>

  298.       </table>

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

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

  301. 

  302. </div>

  303. </div>

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

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

  306. </ul>

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

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

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

  310. Generated on Sun Apr 7 2019 05:47:58 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  312. </a> 1.8.13

  313. </small></address>

  314. </body>

  315. </html>