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.

237 lines
9.6KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>DISTRHO Plugin Framework: Miscellaneous functions</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.9.1 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. </div><!-- top -->
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#func-members">Functions</a> </div>
  64. <div class="headertitle">
  65. <div class="title">Miscellaneous functions</div> </div>
  66. </div><!--header-->
  67. <div class="contents">
  68. <table class="memberdecls">
  69. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  70. Functions</h2></td></tr>
  71. <tr class="memitem:ga6827e90feb9bdcb6f76175a245fbf12c"><td class="memItemLeft" align="right" valign="top">static constexpr int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MiscellaneousFunctions.html#ga6827e90feb9bdcb6f76175a245fbf12c">d_cconst</a> (const uint8_t a, const uint8_t b, const uint8_t c, const uint8_t d) noexcept</td></tr>
  72. <tr class="separator:ga6827e90feb9bdcb6f76175a245fbf12c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:gaa6e4fa8bdcebd0d15f4ead3bb923e3f3"><td class="memItemLeft" align="right" valign="top">static constexpr uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MiscellaneousFunctions.html#gaa6e4fa8bdcebd0d15f4ead3bb923e3f3">d_cconst</a> (const char str[4])</td></tr>
  74. <tr class="separator:gaa6e4fa8bdcebd0d15f4ead3bb923e3f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:ga95d67ff74d46b2c80f15c7790a523154"><td class="memItemLeft" align="right" valign="top">static constexpr uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MiscellaneousFunctions.html#ga95d67ff74d46b2c80f15c7790a523154">d_version</a> (const uint8_t major, const uint8_t minor, const uint8_t micro) noexcept</td></tr>
  76. <tr class="separator:ga95d67ff74d46b2c80f15c7790a523154"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:ga208c5bc138b7d4d4e318b6174c9dbf6d"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MiscellaneousFunctions.html#ga208c5bc138b7d4d4e318b6174c9dbf6d">d_pass</a> () noexcept</td></tr>
  78. <tr class="separator:ga208c5bc138b7d4d4e318b6174c9dbf6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. </table>
  80. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  81. <h2 class="groupheader">Function Documentation</h2>
  82. <a id="ga6827e90feb9bdcb6f76175a245fbf12c"></a>
  83. <h2 class="memtitle"><span class="permalink"><a href="#ga6827e90feb9bdcb6f76175a245fbf12c">&#9670;&nbsp;</a></span>d_cconst() <span class="overload">[1/2]</span></h2>
  84. <div class="memitem">
  85. <div class="memproto">
  86. <table class="mlabels">
  87. <tr>
  88. <td class="mlabels-left">
  89. <table class="memname">
  90. <tr>
  91. <td class="memname">static constexpr int64_t d_cconst </td>
  92. <td>(</td>
  93. <td class="paramtype">const uint8_t&#160;</td>
  94. <td class="paramname"><em>a</em>, </td>
  95. </tr>
  96. <tr>
  97. <td class="paramkey"></td>
  98. <td></td>
  99. <td class="paramtype">const uint8_t&#160;</td>
  100. <td class="paramname"><em>b</em>, </td>
  101. </tr>
  102. <tr>
  103. <td class="paramkey"></td>
  104. <td></td>
  105. <td class="paramtype">const uint8_t&#160;</td>
  106. <td class="paramname"><em>c</em>, </td>
  107. </tr>
  108. <tr>
  109. <td class="paramkey"></td>
  110. <td></td>
  111. <td class="paramtype">const uint8_t&#160;</td>
  112. <td class="paramname"><em>d</em>&#160;</td>
  113. </tr>
  114. <tr>
  115. <td></td>
  116. <td>)</td>
  117. <td></td><td></td>
  118. </tr>
  119. </table>
  120. </td>
  121. <td class="mlabels-right">
  122. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
  123. </tr>
  124. </table>
  125. </div><div class="memdoc">
  126. <p>Return a 32-bit number from 4 8-bit numbers.<br />
  127. The return type is a int64_t for better compatibility with plugin formats that use such numbers. </p>
  128. </div>
  129. </div>
  130. <a id="gaa6e4fa8bdcebd0d15f4ead3bb923e3f3"></a>
  131. <h2 class="memtitle"><span class="permalink"><a href="#gaa6e4fa8bdcebd0d15f4ead3bb923e3f3">&#9670;&nbsp;</a></span>d_cconst() <span class="overload">[2/2]</span></h2>
  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">static constexpr uint32_t d_cconst </td>
  140. <td>(</td>
  141. <td class="paramtype">const char&#160;</td>
  142. <td class="paramname"><em>str</em>[4]</td><td>)</td>
  143. <td></td>
  144. </tr>
  145. </table>
  146. </td>
  147. <td class="mlabels-right">
  148. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
  149. </tr>
  150. </table>
  151. </div><div class="memdoc">
  152. <p>Return a 32-bit number from 4 ASCII characters. </p>
  153. </div>
  154. </div>
  155. <a id="ga95d67ff74d46b2c80f15c7790a523154"></a>
  156. <h2 class="memtitle"><span class="permalink"><a href="#ga95d67ff74d46b2c80f15c7790a523154">&#9670;&nbsp;</a></span>d_version()</h2>
  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">static constexpr uint32_t d_version </td>
  165. <td>(</td>
  166. <td class="paramtype">const uint8_t&#160;</td>
  167. <td class="paramname"><em>major</em>, </td>
  168. </tr>
  169. <tr>
  170. <td class="paramkey"></td>
  171. <td></td>
  172. <td class="paramtype">const uint8_t&#160;</td>
  173. <td class="paramname"><em>minor</em>, </td>
  174. </tr>
  175. <tr>
  176. <td class="paramkey"></td>
  177. <td></td>
  178. <td class="paramtype">const uint8_t&#160;</td>
  179. <td class="paramname"><em>micro</em>&#160;</td>
  180. </tr>
  181. <tr>
  182. <td></td>
  183. <td>)</td>
  184. <td></td><td></td>
  185. </tr>
  186. </table>
  187. </td>
  188. <td class="mlabels-right">
  189. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. <p>Return an hexadecimal representation of a MAJ.MIN.MICRO version number. </p>
  194. </div>
  195. </div>
  196. <a id="ga208c5bc138b7d4d4e318b6174c9dbf6d"></a>
  197. <h2 class="memtitle"><span class="permalink"><a href="#ga208c5bc138b7d4d4e318b6174c9dbf6d">&#9670;&nbsp;</a></span>d_pass()</h2>
  198. <div class="memitem">
  199. <div class="memproto">
  200. <table class="mlabels">
  201. <tr>
  202. <td class="mlabels-left">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname">static void d_pass </td>
  206. <td>(</td>
  207. <td class="paramname"></td><td>)</td>
  208. <td></td>
  209. </tr>
  210. </table>
  211. </td>
  212. <td class="mlabels-right">
  213. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
  214. </tr>
  215. </table>
  216. </div><div class="memdoc">
  217. <p>Dummy, no-op function. </p>
  218. </div>
  219. </div>
  220. </div><!-- contents -->
  221. <!-- start footer part -->
  222. <hr class="footer"/><address class="footer"><small>
  223. 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
  224. </small></address>
  225. </body>
  226. </html>