yair/picovga-RGsB
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Documentation improvements

Browse Source
This commit is contained in:
Wayne Venables
2025-08-26 20:47:11 -07:00
parent 4753b270f6
commit faef620629
517 changed files with 8124 additions and 4888 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
docs/pwmsnd_8h_source.html
View File

@@ -3,7 +3,7 @@
<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.8.17"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PicoVGA: src/util/pwmsnd.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -29,7 +29,7 @@
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">PicoVGA
&#160;<span id="projectnumber">1.0-cmake</span>
&#160;<span id="projectnumber">1.2-cmake</span>
</div>
<div id="projectbrief">VGA/TV display on Raspberry Pico</div>
</td>
@@ -38,10 +38,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<!-- 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');
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
@@ -94,16 +94,16 @@ $(document).ready(function(){initNavTree('pwmsnd_8h_source.html',''); initResiza
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#ifndef _PWMSND_H</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#define _PWMSND_H</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#define PWMSND_GPIO 19 // PWM output GPIO pin (0..29)</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#define PWMSND_SLICE ((PWMSND_GPIO&gt;&gt;1)&amp;7) // PWM slice index (=1)</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#define PWMSND_CHAN (PWMSND_GPIO&amp;1) // PWM channel index (=1)</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#define PWMSND_GPIO 19 </span><span class="comment">// PWM output GPIO pin (0..29)</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#define PWMSND_SLICE ((PWMSND_GPIO&gt;&gt;1)&amp;7) </span><span class="comment">// PWM slice index (=1)</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#define PWMSND_CHAN (PWMSND_GPIO&amp;1) </span><span class="comment">// PWM channel index (=1)</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#define SOUNDRATE 22050 // sound rate [Hz]</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define PWMSND_TOP 255 // PRM top (period = PWMSND_TOP + 1 = 256)</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#define PWMSND_CLOCK (SOUNDRATE*(PWMSND_TOP+1)) // PWM clock (= 22050*256 = 5644800)</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#define SOUNDRATE 22050 </span><span class="comment">// sound rate [Hz]</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define PWMSND_TOP 255 </span><span class="comment">// PRM top (period = PWMSND_TOP + 1 = 256)</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#define PWMSND_CLOCK (SOUNDRATE*(PWMSND_TOP+1)) </span><span class="comment">// PWM clock (= 22050*256 = 5644800)</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#define SNDFRAC 10 // number of fraction bits</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define SNDINT (1&lt;&lt;SNDFRAC) // integer part of sound fraction</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#define SNDFRAC 10 </span><span class="comment">// number of fraction bits</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define SNDINT (1&lt;&lt;SNDFRAC) </span><span class="comment">// integer part of sound fraction</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment">// current sound</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">extern</span> <span class="keyword">const</span> u8* CurSound; <span class="comment">// current playing sound</span></div>
@@ -127,22 +127,20 @@ $(document).ready(function(){initNavTree('pwmsnd_8h_source.html',''); initResiza
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__PWMGroup.html#gaf9f5fbc637ae75e22d2f628cbfd9b665">SetNextSound</a>(<span class="keyword">const</span> u8* snd, <span class="keywordtype">int</span> len);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="preprocessor">#endif // _PWMSND_H</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// _PWMSND_H</span></div>
<div class="ttc" id="agroup__PWMGroup_html_ga125653aeeb2dc605e83d0927a635983c"><div class="ttname"><a href="group__PWMGroup.html#ga125653aeeb2dc605e83d0927a635983c">PWMSndInit</a></div><div class="ttdeci">void PWMSndInit()</div><div class="ttdoc">Initialize PWM sound output.</div><div class="ttdef"><b>Definition:</b> pwmsnd.cpp:65</div></div>
<div class="ttc" id="agroup__PWMGroup_html_ga7d7587ed33cbb0e94588c96735b5e6d5"><div class="ttname"><a href="group__PWMGroup.html#ga7d7587ed33cbb0e94588c96735b5e6d5">PlaySound</a></div><div class="ttdeci">void PlaySound(const u8 *snd, int len, Bool rep=False, float speed=1.0f)</div><div class="ttdoc">Output PWM sound.</div><div class="ttdef"><b>Definition:</b> pwmsnd.cpp:97</div></div>
<div class="ttc" id="agroup__PWMGroup_html_gaa69a3c0ca6e5f20455ef1e60c2ea7b31"><div class="ttname"><a href="group__PWMGroup.html#gaa69a3c0ca6e5f20455ef1e60c2ea7b31">SpeedSound</a></div><div class="ttdeci">void SpeedSound(float speed)</div><div class="ttdoc">Update sound speed.</div><div class="ttdef"><b>Definition:</b> pwmsnd.cpp:132</div></div>
<div class="ttc" id="agroup__PWMGroup_html_gac5cdc29178dd50bc69a6925a6af5c84a"><div class="ttname"><a href="group__PWMGroup.html#gac5cdc29178dd50bc69a6925a6af5c84a">PlayingSound</a></div><div class="ttdeci">Bool PlayingSound()</div><div class="ttdoc">Check if playing sound.</div><div class="ttdef"><b>Definition:</b> pwmsnd.cpp:138</div></div>
<div class="ttc" id="agroup__PWMGroup_html_gace7ff7d9e5fec2fa9c349305e72f1503"><div class="ttname"><a href="group__PWMGroup.html#gace7ff7d9e5fec2fa9c349305e72f1503">StopSound</a></div><div class="ttdeci">void StopSound()</div><div class="ttdoc">stop playing sound</div><div class="ttdef"><b>Definition:</b> pwmsnd.cpp:124</div></div>
<div class="ttc" id="agroup__PWMGroup_html_gaf9f5fbc637ae75e22d2f628cbfd9b665"><div class="ttname"><a href="group__PWMGroup.html#gaf9f5fbc637ae75e22d2f628cbfd9b665">SetNextSound</a></div><div class="ttdeci">void SetNextSound(const u8 *snd, int len)</div><div class="ttdoc">Set the next sound to play.</div><div class="ttdef"><b>Definition:</b> pwmsnd.cpp:144</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="agroup__PWMGroup_html_gac5cdc29178dd50bc69a6925a6af5c84a"><div class="ttname"><a href="group__PWMGroup.html#gac5cdc29178dd50bc69a6925a6af5c84a">PlayingSound</a></div><div class="ttdeci">Bool PlayingSound()</div><div class="ttdoc">Check if playing sound.</div><div class="ttdef"><b>Definition:</b> pwmsnd.cpp:138</div></div>
<div class="ttc" id="agroup__PWMGroup_html_gaf9f5fbc637ae75e22d2f628cbfd9b665"><div class="ttname"><a href="group__PWMGroup.html#gaf9f5fbc637ae75e22d2f628cbfd9b665">SetNextSound</a></div><div class="ttdeci">void SetNextSound(const u8 *snd, int len)</div><div class="ttdoc">Set the next sound to play.</div><div class="ttdef"><b>Definition:</b> pwmsnd.cpp:144</div></div>
<div class="ttc" id="agroup__PWMGroup_html_gaa69a3c0ca6e5f20455ef1e60c2ea7b31"><div class="ttname"><a href="group__PWMGroup.html#gaa69a3c0ca6e5f20455ef1e60c2ea7b31">SpeedSound</a></div><div class="ttdeci">void SpeedSound(float speed)</div><div class="ttdoc">Update sound speed.</div><div class="ttdef"><b>Definition:</b> pwmsnd.cpp:132</div></div>
<div class="ttc" id="agroup__PWMGroup_html_ga7d7587ed33cbb0e94588c96735b5e6d5"><div class="ttname"><a href="group__PWMGroup.html#ga7d7587ed33cbb0e94588c96735b5e6d5">PlaySound</a></div><div class="ttdeci">void PlaySound(const u8 *snd, int len, Bool rep=False, float speed=1.0f)</div><div class="ttdoc">Output PWM sound.</div><div class="ttdef"><b>Definition:</b> pwmsnd.cpp:97</div></div>
<div class="ttc" id="agroup__PWMGroup_html_gace7ff7d9e5fec2fa9c349305e72f1503"><div class="ttname"><a href="group__PWMGroup.html#gace7ff7d9e5fec2fa9c349305e72f1503">StopSound</a></div><div class="ttdeci">void StopSound()</div><div class="ttdoc">stop playing sound</div><div class="ttdef"><b>Definition:</b> pwmsnd.cpp:124</div></div>
<div class="ttc" id="agroup__PWMGroup_html_ga125653aeeb2dc605e83d0927a635983c"><div class="ttname"><a href="group__PWMGroup.html#ga125653aeeb2dc605e83d0927a635983c">PWMSndInit</a></div><div class="ttdeci">void PWMSndInit()</div><div class="ttdoc">Initialize PWM sound output.</div><div class="ttdef"><b>Definition:</b> pwmsnd.cpp:65</div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b7878ad5ecbf2506f4125b9d34c97e45.html">util</a></li><li class="navelem"><a class="el" href="pwmsnd_8h.html">pwmsnd.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>