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/print_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/print.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>
@@ -114,8 +114,8 @@ $(document).ready(function(){initNavTree('print_8h_source.html',''); initResizab
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment">// compose PC color</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#define PC_COLOR(bg,fg) (((bg)&lt;&lt;4)|(fg))</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#define PC_FGCOLOR(color) ((color) &amp; 0b1111) // Added by WV</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#define PC_BGCOLOR(color) ((color) &gt;&gt; 4) // Added by WV</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#define PC_FGCOLOR(color) ((color) &amp; 0b1111) </span><span class="comment">// Added by WV</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#define PC_BGCOLOR(color) ((color) &gt;&gt; 4) </span><span class="comment">// Added by WV</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment">// ASCII characters</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#define CHAR_CR &#39;\r&#39;</span></div>
@@ -126,12 +126,12 @@ $(document).ready(function(){initNavTree('print_8h_source.html',''); initResizab
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="group__TextGroup.html#gae28be7bd375dc3e8216ca51661144e15"> 47</a></span>&#160;<span class="preprocessor">#define FRAME_U B1 </span></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="group__TextGroup.html#gad1928b0e991c50af34ed239e9bcec9fe"> 48</a></span>&#160;<span class="preprocessor">#define FRAME_R B2 </span></div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="group__TextGroup.html#ga042c91227df698468400046f9f3a43c4"> 49</a></span>&#160;<span class="preprocessor">#define FRAME_D B3 </span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor"></span> </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="group__TextGroup.html#ga6f1b1fcf3220fb950d30acc1b41fa9ee"> 51</a></span>&#160;<span class="preprocessor">#define CHAR_FRAME_FIRST 17 </span></div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="group__TextGroup.html#ga9736253678da381b7d0e76feb155ef4b"> 52</a></span>&#160;<span class="preprocessor">#define CHAR_FRAME_LAST 31 </span></div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="group__TextGroup.html#ga1526153f29404eae222b6f97b4836ae6"> 53</a></span>&#160;<span class="preprocessor">#define CHAR_VLINE (CHAR_FRAME|FRAME_U|FRAME_D) </span></div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="group__TextGroup.html#ga8328f65449a77cc11ae0302f709a33b5"> 54</a></span>&#160;<span class="preprocessor">#define CHAR_HLINE (CHAR_FRAME|FRAME_L|FRAME_R) </span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="preprocessor"></span> </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment">// Current print buffer</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="keyword">extern</span> u8* PrintBuf;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
@@ -177,32 +177,30 @@ $(document).ready(function(){initNavTree('print_8h_source.html',''); initResizab
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__TextGroup.html#ga2323e69f1ff2adaadf317eb220bd10db">PrintFrame</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y, <span class="keywordtype">int</span> w, <span class="keywordtype">int</span> h);</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; </div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; </div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160;<span class="preprocessor">#endif // _PRINT_H</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="agroup__TextGroup_html_ga351c19309ced4dc9310112ad2b8bae2c"><div class="ttname"><a href="group__TextGroup.html#ga351c19309ced4dc9310112ad2b8bae2c">PrintText</a></div><div class="ttdeci">void PrintText(const char *text)</div><div class="ttdoc">Print a string.</div><div class="ttdef"><b>Definition:</b> print.cpp:156</div></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// _PRINT_H</span></div>
<div class="ttc" id="agroup__TextGroup_html_ga0275c150a5a12613afaef51f4bec2c89"><div class="ttname"><a href="group__TextGroup.html#ga0275c150a5a12613afaef51f4bec2c89">PrintSetup</a></div><div class="ttdeci">void PrintSetup(u8 *buf, int bufw, int bufh, int bufwb)</div><div class="ttdoc">Setup print service.</div><div class="ttdef"><b>Definition:</b> print.cpp:26</div></div>
<div class="ttc" id="agroup__TextGroup_html_gac11665c9779895b57d0a9f853beff7b2"><div class="ttname"><a href="group__TextGroup.html#gac11665c9779895b57d0a9f853beff7b2">PrintVLine</a></div><div class="ttdeci">void PrintVLine(int x, int y, int h)</div><div class="ttdoc">Print vertical line into screen, using current color.</div><div class="ttdef"><b>Definition:</b> print.cpp:198</div></div>
<div class="ttc" id="agroup__TextGroup_html_gad43a32dad63df05f21d3b2254c96f36d"><div class="ttname"><a href="group__TextGroup.html#gad43a32dad63df05f21d3b2254c96f36d">PrintChar</a></div><div class="ttdeci">void PrintChar(char ch)</div><div class="ttdoc">Print character, using control characters CR, LF, TAB.</div><div class="ttdef"><b>Definition:</b> print.cpp:105</div></div>
<div class="ttc" id="agroup__TextGroup_html_gaf269b76cd7c06b18218aa5274ee3f990"><div class="ttname"><a href="group__TextGroup.html#gaf269b76cd7c06b18218aa5274ee3f990">PrintSpc</a></div><div class="ttdeci">void PrintSpc()</div><div class="ttdoc">Print space character.</div><div class="ttdef"><b>Definition:</b> print.cpp:132</div></div>
<div class="ttc" id="agroup__TextGroup_html_ga16e185e12dd782e3b69117386fe64dc9"><div class="ttname"><a href="group__TextGroup.html#ga16e185e12dd782e3b69117386fe64dc9">PrintHLine</a></div><div class="ttdeci">void PrintHLine(int x, int y, int w)</div><div class="ttdoc">Print horizontal line into screen, using current color.</div><div class="ttdef"><b>Definition:</b> print.cpp:166</div></div>
<div class="ttc" id="agroup__TextGroup_html_ga6862b40c6d8ef741e52e0e9ed1488647"><div class="ttname"><a href="group__TextGroup.html#ga6862b40c6d8ef741e52e0e9ed1488647">PrintSpcRep</a></div><div class="ttdeci">void PrintSpcRep(int num)</div><div class="ttdoc">Print repeated space.</div><div class="ttdef"><b>Definition:</b> print.cpp:150</div></div>
<div class="ttc" id="agroup__TextGroup_html_gaba693e4bd43c731c3c97ca303938a903"><div class="ttname"><a href="group__TextGroup.html#gaba693e4bd43c731c3c97ca303938a903">PrintAddPos</a></div><div class="ttdeci">void PrintAddPos(int x, int y)</div><div class="ttdoc">Shift relative print position.</div><div class="ttdef"><b>Definition:</b> print.cpp:72</div></div>
<div class="ttc" id="agroup__TextGroup_html_gab9231ede9d6a979f1b812b7667c34d29"><div class="ttname"><a href="group__TextGroup.html#gab9231ede9d6a979f1b812b7667c34d29">PrintCharRep</a></div><div class="ttdeci">void PrintCharRep(char ch, int num)</div><div class="ttdoc">Print repeated character.</div><div class="ttdef"><b>Definition:</b> print.cpp:144</div></div>
<div class="ttc" id="agroup__TextGroup_html_ga2323e69f1ff2adaadf317eb220bd10db"><div class="ttname"><a href="group__TextGroup.html#ga2323e69f1ff2adaadf317eb220bd10db">PrintFrame</a></div><div class="ttdeci">void PrintFrame(int x, int y, int w, int h)</div><div class="ttdoc">Print frame, using current color.</div><div class="ttdef"><b>Definition:</b> print.cpp:233</div></div>
<div class="ttc" id="agroup__TextGroup_html_ga351c19309ced4dc9310112ad2b8bae2c"><div class="ttname"><a href="group__TextGroup.html#ga351c19309ced4dc9310112ad2b8bae2c">PrintText</a></div><div class="ttdeci">void PrintText(const char *text)</div><div class="ttdoc">Print a string.</div><div class="ttdef"><b>Definition:</b> print.cpp:156</div></div>
<div class="ttc" id="agroup__TextGroup_html_ga3c5c271811227b03d974171af2a243c4"><div class="ttname"><a href="group__TextGroup.html#ga3c5c271811227b03d974171af2a243c4">PrintChar0</a></div><div class="ttdeci">void PrintChar0(char ch)</div><div class="ttdoc">Print character, not using control characters.</div><div class="ttdef"><b>Definition:</b> print.cpp:85</div></div>
<div class="ttc" id="agroup__TextGroup_html_ga569987e642b3fa23427c126e649774ba"><div class="ttname"><a href="group__TextGroup.html#ga569987e642b3fa23427c126e649774ba">PrintHome</a></div><div class="ttdeci">void PrintHome()</div><div class="ttdoc">Move the pointer to the beginning of the first line.</div><div class="ttdef"><b>Definition:</b> print.cpp:58</div></div>
<div class="ttc" id="agroup__TextGroup_html_ga6862b40c6d8ef741e52e0e9ed1488647"><div class="ttname"><a href="group__TextGroup.html#ga6862b40c6d8ef741e52e0e9ed1488647">PrintSpcRep</a></div><div class="ttdeci">void PrintSpcRep(int num)</div><div class="ttdoc">Print repeated space.</div><div class="ttdef"><b>Definition:</b> print.cpp:150</div></div>
<div class="ttc" id="agroup__TextGroup_html_ga7ca8b785cd293ee0e1d20869dedf52a0"><div class="ttname"><a href="group__TextGroup.html#ga7ca8b785cd293ee0e1d20869dedf52a0">PrintSetCol</a></div><div class="ttdeci">void PrintSetCol(u8 col)</div><div class="ttdoc">Set print color (2x4 bits of colors)</div><div class="ttdef"><b>Definition:</b> print.cpp:79</div></div>
<div class="ttc" id="agroup__TextGroup_html_ga9794804d1b01d51df73144d3edc0150d"><div class="ttname"><a href="group__TextGroup.html#ga9794804d1b01d51df73144d3edc0150d">PrintSpcTo</a></div><div class="ttdeci">void PrintSpcTo(int pos)</div><div class="ttdoc">Printing spaces up to the specified position.</div><div class="ttdef"><b>Definition:</b> print.cpp:138</div></div>
<div class="ttc" id="agroup__TextGroup_html_gab9231ede9d6a979f1b812b7667c34d29"><div class="ttname"><a href="group__TextGroup.html#gab9231ede9d6a979f1b812b7667c34d29">PrintCharRep</a></div><div class="ttdeci">void PrintCharRep(char ch, int num)</div><div class="ttdoc">Print repeated character.</div><div class="ttdef"><b>Definition:</b> print.cpp:144</div></div>
<div class="ttc" id="agroup__TextGroup_html_gaba693e4bd43c731c3c97ca303938a903"><div class="ttname"><a href="group__TextGroup.html#gaba693e4bd43c731c3c97ca303938a903">PrintAddPos</a></div><div class="ttdeci">void PrintAddPos(int x, int y)</div><div class="ttdoc">Shift relative print position.</div><div class="ttdef"><b>Definition:</b> print.cpp:72</div></div>
<div class="ttc" id="agroup__TextGroup_html_gac11665c9779895b57d0a9f853beff7b2"><div class="ttname"><a href="group__TextGroup.html#gac11665c9779895b57d0a9f853beff7b2">PrintVLine</a></div><div class="ttdeci">void PrintVLine(int x, int y, int h)</div><div class="ttdoc">Print vertical line into screen, using current color.</div><div class="ttdef"><b>Definition:</b> print.cpp:198</div></div>
<div class="ttc" id="agroup__TextGroup_html_gacdf79045593025b8b51f841dd696094d"><div class="ttname"><a href="group__TextGroup.html#gacdf79045593025b8b51f841dd696094d">PrintSetPos</a></div><div class="ttdeci">void PrintSetPos(int x, int y)</div><div class="ttdoc">Set print position.</div><div class="ttdef"><b>Definition:</b> print.cpp:65</div></div>
<div class="ttc" id="agroup__TextGroup_html_ga3c5c271811227b03d974171af2a243c4"><div class="ttname"><a href="group__TextGroup.html#ga3c5c271811227b03d974171af2a243c4">PrintChar0</a></div><div class="ttdeci">void PrintChar0(char ch)</div><div class="ttdoc">Print character, not using control characters.</div><div class="ttdef"><b>Definition:</b> print.cpp:85</div></div>
<div class="ttc" id="agroup__TextGroup_html_gad43a32dad63df05f21d3b2254c96f36d"><div class="ttname"><a href="group__TextGroup.html#gad43a32dad63df05f21d3b2254c96f36d">PrintChar</a></div><div class="ttdeci">void PrintChar(char ch)</div><div class="ttdoc">Print character, using control characters CR, LF, TAB.</div><div class="ttdef"><b>Definition:</b> print.cpp:105</div></div>
<div class="ttc" id="agroup__TextGroup_html_gad7b697700b999077439e537a2fef28f3"><div class="ttname"><a href="group__TextGroup.html#gad7b697700b999077439e537a2fef28f3">PrintClear</a></div><div class="ttdeci">void PrintClear()</div><div class="ttdoc">Clear the text buffer with the currently selected color.</div><div class="ttdef"><b>Definition:</b> print.cpp:39</div></div>
<div class="ttc" id="agroup__TextGroup_html_gaf269b76cd7c06b18218aa5274ee3f990"><div class="ttname"><a href="group__TextGroup.html#gaf269b76cd7c06b18218aa5274ee3f990">PrintSpc</a></div><div class="ttdeci">void PrintSpc()</div><div class="ttdoc">Print space character.</div><div class="ttdef"><b>Definition:</b> print.cpp:132</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- 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="print_8h.html">print.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>