Documentation improvements

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

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/vga_util.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>
@@ -107,22 +107,20 @@ $(document).ready(function(){initNavTree('vga__util_8h_source.html',''); initRes
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__UtilsGroup.html#ga49a4978da9e0f15dcdc9ebfc9d6c520e">CopyWhiteImg</a>(u8* dst, <span class="keyword">const</span> u8* src, <span class="keywordtype">int</span> num);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="preprocessor">#endif // _VGA_UTIL_H</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// _VGA_UTIL_H</span></div>
<div class="ttc" id="agroup__UtilsGroup_html_ga268e6976f0e415330c26c1f3d4d73cc9"><div class="ttname"><a href="group__UtilsGroup.html#ga268e6976f0e415330c26c1f3d4d73cc9">ImgInvert</a></div><div class="ttdeci">void ImgInvert(u8 *dst, int num)</div><div class="ttdoc">Invert image.</div><div class="ttdef"><b>Definition:</b> vga_util.cpp:144</div></div>
<div class="ttc" id="agroup__UtilsGroup_html_ga31e41cec17ed79dc0bd026b6d45237a0"><div class="ttname"><a href="group__UtilsGroup.html#ga31e41cec17ed79dc0bd026b6d45237a0">DecNum</a></div><div class="ttdeci">int DecNum(char *buf, s32 num)</div><div class="ttdoc">Decode signed number into ASCIIZ text buffer.</div><div class="ttdef"><b>Definition:</b> vga_util.cpp:179</div></div>
<div class="ttc" id="agroup__UtilsGroup_html_ga49a4978da9e0f15dcdc9ebfc9d6c520e"><div class="ttname"><a href="group__UtilsGroup.html#ga49a4978da9e0f15dcdc9ebfc9d6c520e">CopyWhiteImg</a></div><div class="ttdeci">void CopyWhiteImg(u8 *dst, const u8 *src, int num)</div><div class="ttdoc">Prepare image with white key transparency (copy and increment pixels)</div><div class="ttdef"><b>Definition:</b> vga_util.cpp:189</div></div>
<div class="ttc" id="agroup__UtilsGroup_html_ga6d2664ea6a63954346a80ca93cfb3b74"><div class="ttname"><a href="group__UtilsGroup.html#ga6d2664ea6a63954346a80ca93cfb3b74">DecUNum</a></div><div class="ttdeci">int DecUNum(char *buf, u32 num)</div><div class="ttdoc">Decode unsigned number into ASCIIZ text buffer.</div><div class="ttdef"><b>Definition:</b> vga_util.cpp:154</div></div>
<div class="ttc" id="agroup__UtilsGroup_html_ga9d2f98a08bf609f9969298eb2e9d7761"><div class="ttname"><a href="group__UtilsGroup.html#ga9d2f98a08bf609f9969298eb2e9d7761">Plane2Conv</a></div><div class="ttdeci">void Plane2Conv(u8 *plane0, u8 *plane1, const u8 *src, int w, int h)</div><div class="ttdoc">Convert image from 4-color to 2-plane format (width must be multiply of 8)</div><div class="ttdef"><b>Definition:</b> vga_util.cpp:128</div></div>
<div class="ttc" id="agroup__UtilsGroup_html_gab8207741ed267ed4fbaa28c4d5a7bad9"><div class="ttname"><a href="group__UtilsGroup.html#gab8207741ed267ed4fbaa28c4d5a7bad9">Attr8Conv</a></div><div class="ttdeci">void Attr8Conv(u8 *dst, u8 *attr, const u8 *src, int w, int h, const u8 *pal)</div><div class="ttdoc">Convert image from 16-color to 8x8 attribute format.</div><div class="ttdef"><b>Definition:</b> vga_util.cpp:14</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="agroup__UtilsGroup_html_ga268e6976f0e415330c26c1f3d4d73cc9"><div class="ttname"><a href="group__UtilsGroup.html#ga268e6976f0e415330c26c1f3d4d73cc9">ImgInvert</a></div><div class="ttdeci">void ImgInvert(u8 *dst, int num)</div><div class="ttdoc">Invert image.</div><div class="ttdef"><b>Definition:</b> vga_util.cpp:144</div></div>
<div class="ttc" id="agroup__UtilsGroup_html_gab8207741ed267ed4fbaa28c4d5a7bad9"><div class="ttname"><a href="group__UtilsGroup.html#gab8207741ed267ed4fbaa28c4d5a7bad9">Attr8Conv</a></div><div class="ttdeci">void Attr8Conv(u8 *dst, u8 *attr, const u8 *src, int w, int h, const u8 *pal)</div><div class="ttdoc">Convert image from 16-color to 8x8 attribute format.</div><div class="ttdef"><b>Definition:</b> vga_util.cpp:14</div></div>
<div class="ttc" id="agroup__UtilsGroup_html_ga31e41cec17ed79dc0bd026b6d45237a0"><div class="ttname"><a href="group__UtilsGroup.html#ga31e41cec17ed79dc0bd026b6d45237a0">DecNum</a></div><div class="ttdeci">int DecNum(char *buf, s32 num)</div><div class="ttdoc">Decode signed number into ASCIIZ text buffer.</div><div class="ttdef"><b>Definition:</b> vga_util.cpp:179</div></div>
<div class="ttc" id="agroup__UtilsGroup_html_ga6d2664ea6a63954346a80ca93cfb3b74"><div class="ttname"><a href="group__UtilsGroup.html#ga6d2664ea6a63954346a80ca93cfb3b74">DecUNum</a></div><div class="ttdeci">int DecUNum(char *buf, u32 num)</div><div class="ttdoc">Decode unsigned number into ASCIIZ text buffer.</div><div class="ttdef"><b>Definition:</b> vga_util.cpp:154</div></div>
<div class="ttc" id="agroup__UtilsGroup_html_ga49a4978da9e0f15dcdc9ebfc9d6c520e"><div class="ttname"><a href="group__UtilsGroup.html#ga49a4978da9e0f15dcdc9ebfc9d6c520e">CopyWhiteImg</a></div><div class="ttdeci">void CopyWhiteImg(u8 *dst, const u8 *src, int num)</div><div class="ttdoc">Prepare image with white key transparency (copy and increment pixels)</div><div class="ttdef"><b>Definition:</b> vga_util.cpp:189</div></div>
<div class="ttc" id="agroup__UtilsGroup_html_ga9d2f98a08bf609f9969298eb2e9d7761"><div class="ttname"><a href="group__UtilsGroup.html#ga9d2f98a08bf609f9969298eb2e9d7761">Plane2Conv</a></div><div class="ttdeci">void Plane2Conv(u8 *plane0, u8 *plane1, const u8 *src, int w, int h)</div><div class="ttdoc">Convert image from 4-color to 2-plane format (width must be multiply of 8)</div><div class="ttdef"><b>Definition:</b> vga_util.cpp:128</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="vga__util_8h.html">vga_util.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>