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.
386 Commits
7 Branches
57MB
Tree: 16812ef750
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '16812ef750'
${ noResults }
DPF/structTimePosition_1_1BarBe...

292 lines
13KB
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.11"/>

  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/searchdata.js"></script>

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

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

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

  16. </script>

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

  18. </head>

  19. <body>

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

  21. <div id="titlearea">

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

  23.  <tbody>

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

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

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

  27.    </div>

  28.   </td>

  29.  </tr>

  30.  </tbody>

  31. </table>

  32. </div>

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

  34. <!-- Generated by Doxygen 1.8.11 -->

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

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

  37. </script>

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

  39.     <ul class="tablist">

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

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

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

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

  44.       <li>

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

  46.         <span class="left">

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

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

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

  50.                alt=""/>

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

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

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

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

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

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

  57.           </span>

  58.         </div>

  59.       </li>

  60.     </ul>

  61.   </div>

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

  63.     <ul class="tablist">

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

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

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

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

  68.     </ul>

  69.   </div>

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

  71. <div id="MSearchSelectWindow"

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

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

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

  75. </div>

  76. 

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

  78. <div id="MSearchResultsWindow">

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

  80.         name="MSearchResults" id="MSearchResults">

  81. </iframe>

  82. </div>

  83. 

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

  85.   <ul>

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

  87. </div>

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

  89. <div class="header">

  90.   <div class="summary">

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

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

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

  94.   <div class="headertitle">

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

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

  97. <div class="contents">

  98. 

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

  100. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  126. </table>

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

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

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

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

  131. <div class="memitem">

  132. <div class="memproto">

  133. <table class="mlabels">

  134.   <tr>

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

  136.       <table class="memname">

  137.         <tr>

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

  139.           <td>(</td>

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

  141.           <td></td>

  142.         </tr>

  143.       </table>

  144.   </td>

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

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

  147.   </tr>

  148. </table>

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

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

  151. 

  152. </div>

  153. </div>

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

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

  156. <div class="memitem">

  157. <div class="memproto">

  158.       <table class="memname">

  159.         <tr>

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

  161.         </tr>

  162.       </table>

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

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

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

  166. 

  167. </div>

  168. </div>

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

  170. <div class="memitem">

  171. <div class="memproto">

  172.       <table class="memname">

  173.         <tr>

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

  175.         </tr>

  176.       </table>

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

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

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

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

  181. 

  182. </div>

  183. </div>

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

  185. <div class="memitem">

  186. <div class="memproto">

  187.       <table class="memname">

  188.         <tr>

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

  190.         </tr>

  191.       </table>

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

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

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

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

  196. 

  197. </div>

  198. </div>

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

  200. <div class="memitem">

  201. <div class="memproto">

  202.       <table class="memname">

  203.         <tr>

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

  205.         </tr>

  206.       </table>

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

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

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

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

  211. 

  212. </div>

  213. </div>

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

  215. <div class="memitem">

  216. <div class="memproto">

  217.       <table class="memname">

  218.         <tr>

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

  220.         </tr>

  221.       </table>

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

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

  224. 

  225. </div>

  226. </div>

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

  228. <div class="memitem">

  229. <div class="memproto">

  230.       <table class="memname">

  231.         <tr>

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

  233.         </tr>

  234.       </table>

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

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

  237. 

  238. </div>

  239. </div>

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

  241. <div class="memitem">

  242. <div class="memproto">

  243.       <table class="memname">

  244.         <tr>

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

  246.         </tr>

  247.       </table>

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

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

  250. 

  251. </div>

  252. </div>

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

  254. <div class="memitem">

  255. <div class="memproto">

  256.       <table class="memname">

  257.         <tr>

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

  259.         </tr>

  260.       </table>

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

  262. <p>Number of ticks within a bar.<br />

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

  264. 

  265. </div>

  266. </div>

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

  268. <div class="memitem">

  269. <div class="memproto">

  270.       <table class="memname">

  271.         <tr>

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

  273.         </tr>

  274.       </table>

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

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

  277. 

  278. </div>

  279. </div>

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

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

  282. </ul>

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

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

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

  286. Generated on Tue Jun 7 2016 14:04:30 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  288. </a> 1.8.11

  289. </small></address>

  290. </body>

  291. </html>