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: Configurating Video Mode</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>
@@ -121,49 +121,49 @@ Macros</h2></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gadf764cbdea00d65edcd07bb9953ad2b7"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <a class="el" href="group__VideoModeGroup.html#ggadf764cbdea00d65edcd07bb9953ad2b7a08d8d7aff466c770efaf041ad980b53d">DEV_PAL</a> = 0,
<a class="el" href="group__VideoModeGroup.html#ggadf764cbdea00d65edcd07bb9953ad2b7afbc7eef2e6768fa471d531d40acb4d7f">DEV_NTSC</a>,
<a class="el" href="group__VideoModeGroup.html#ggadf764cbdea00d65edcd07bb9953ad2b7a4fdffdf8c8f5e50508fbd327b6443eac">DEV_VGA</a>,
<b>DEV_MAX</b>
<tr class="memitem:gadf764cbdea00d65edcd07bb9953ad2b7"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <a class="el" href="group__VideoModeGroup.html#ggadf764cbdea00d65edcd07bb9953ad2b7a08d8d7aff466c770efaf041ad980b53d">DEV_PAL</a> = 0
, <a class="el" href="group__VideoModeGroup.html#ggadf764cbdea00d65edcd07bb9953ad2b7afbc7eef2e6768fa471d531d40acb4d7f">DEV_NTSC</a>
, <a class="el" href="group__VideoModeGroup.html#ggadf764cbdea00d65edcd07bb9953ad2b7a4fdffdf8c8f5e50508fbd327b6443eac">DEV_VGA</a>
, <b>DEV_MAX</b>
}</td></tr>
<tr class="memdesc:gadf764cbdea00d65edcd07bb9953ad2b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output device. <a href="group__VideoModeGroup.html#gadf764cbdea00d65edcd07bb9953ad2b7">More...</a><br /></td></tr>
<tr class="separator:gadf764cbdea00d65edcd07bb9953ad2b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga99fb83031ce9923c84392b4e92f956b5"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <br />
&#160;&#160;<a class="el" href="group__VideoModeGroup.html#gga99fb83031ce9923c84392b4e92f956b5a842b10900d0788304f0df0f1958bf994">RES_ZX</a> = 0,
<a class="el" href="group__VideoModeGroup.html#gga99fb83031ce9923c84392b4e92f956b5a3ac2b2f53a10630b3bb1ed4330849bf6">RES_CGA</a>,
<a class="el" href="group__VideoModeGroup.html#gga99fb83031ce9923c84392b4e92f956b5a72c695083948080b364156dcccb1496d">RES_QVGA</a>,
<a class="el" href="group__VideoModeGroup.html#gga99fb83031ce9923c84392b4e92f956b5addfd80f5555a10229f9d6a5d4a60c297">RES_EGA</a>,
<br />
&#160;&#160;<a class="el" href="group__VideoModeGroup.html#gga99fb83031ce9923c84392b4e92f956b5a45e742ff1aa9511cc9c88aee89d66686">RES_VGA</a>,
<a class="el" href="group__VideoModeGroup.html#gga99fb83031ce9923c84392b4e92f956b5ab8b5ecc8fe866ef7d7919d3abb274ef5">RES_SVGA</a>,
<a class="el" href="group__VideoModeGroup.html#gga99fb83031ce9923c84392b4e92f956b5aa5d88b434b03a1da50c1f407f27ba759">RES_XGA</a>,
<a class="el" href="group__VideoModeGroup.html#gga99fb83031ce9923c84392b4e92f956b5a12e47b6dfb21b1ba0ecdba27e2f68a07">RES_HD</a>,
<br />
&#160;&#160;<a class="el" href="group__VideoModeGroup.html#gga99fb83031ce9923c84392b4e92f956b5a842b10900d0788304f0df0f1958bf994">RES_ZX</a> = 0
, <a class="el" href="group__VideoModeGroup.html#gga99fb83031ce9923c84392b4e92f956b5a3ac2b2f53a10630b3bb1ed4330849bf6">RES_CGA</a>
, <a class="el" href="group__VideoModeGroup.html#gga99fb83031ce9923c84392b4e92f956b5a72c695083948080b364156dcccb1496d">RES_QVGA</a>
, <a class="el" href="group__VideoModeGroup.html#gga99fb83031ce9923c84392b4e92f956b5addfd80f5555a10229f9d6a5d4a60c297">RES_EGA</a>
, <br />
&#160;&#160;<a class="el" href="group__VideoModeGroup.html#gga99fb83031ce9923c84392b4e92f956b5a45e742ff1aa9511cc9c88aee89d66686">RES_VGA</a>
, <a class="el" href="group__VideoModeGroup.html#gga99fb83031ce9923c84392b4e92f956b5ab8b5ecc8fe866ef7d7919d3abb274ef5">RES_SVGA</a>
, <a class="el" href="group__VideoModeGroup.html#gga99fb83031ce9923c84392b4e92f956b5aa5d88b434b03a1da50c1f407f27ba759">RES_XGA</a>
, <a class="el" href="group__VideoModeGroup.html#gga99fb83031ce9923c84392b4e92f956b5a12e47b6dfb21b1ba0ecdba27e2f68a07">RES_HD</a>
, <br />
&#160;&#160;<b>RES_MAX</b>
<br />
}</td></tr>
<tr class="memdesc:ga99fb83031ce9923c84392b4e92f956b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Preset videomode resolution. <a href="group__VideoModeGroup.html#ga99fb83031ce9923c84392b4e92f956b5">More...</a><br /></td></tr>
<tr class="separator:ga99fb83031ce9923c84392b4e92f956b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabc6126af1d45847bc59afa0aa3216b04"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <br />
&#160;&#160;<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04aac1656a7f6ae52edd2fbbbf756f9dca8">FORM_8BIT</a> = 0,
<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04aa30b23e4535c97545299fab5a4f7ed44">FORM_4BIT</a>,
<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04a1af2316944fba6de9768f868d7ad6f17">FORM_MONO</a>,
<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04ada2e5863ccd082d408f207537c535e3f">FORM_TILE8</a>,
<br />
&#160;&#160;<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04a69fa8b94c33d414ab0b89173e18c35b0">FORM_TILE12</a>,
<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04adb6d3a7573390d3ff0ceb7b82a93d34a">FORM_TILE16</a>,
<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04a759c4d53c444373da1f49fd5dd557323">FORM_TILE24</a>,
<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04a79d20d178441da2e0e2c93fd997381a8">FORM_TILE32</a>,
<br />
&#160;&#160;<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04a0febd2c6f3770d088fd18a2e19d94286">FORM_TILE48</a>,
<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04a9f2f7b8de221297c24fdc490e4efbc63">FORM_TILE64</a>,
<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04adad61d519c2099ce1fd3790894db84d1">FORM_MTEXT8</a>,
<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04a86b5a451d1e664ae6119d2d1022415e8">FORM_MTEXT16</a>,
<br />
&#160;&#160;<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04ac50576a8728c44e5cbbd55d4303f7e10">FORM_TEXT8</a>,
<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04ab8ff3d166a357d7a522bd1b125dd5eb9">FORM_TEXT16</a>,
<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04a9a4ad9cc81f78f276885b8b7b21ee66f">FORM_RLE</a>,
<b>FORM_MAX</b>
&#160;&#160;<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04aac1656a7f6ae52edd2fbbbf756f9dca8">FORM_8BIT</a> = 0
, <a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04aa30b23e4535c97545299fab5a4f7ed44">FORM_4BIT</a>
, <a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04a1af2316944fba6de9768f868d7ad6f17">FORM_MONO</a>
, <a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04ada2e5863ccd082d408f207537c535e3f">FORM_TILE8</a>
, <br />
&#160;&#160;<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04a69fa8b94c33d414ab0b89173e18c35b0">FORM_TILE12</a>
, <a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04adb6d3a7573390d3ff0ceb7b82a93d34a">FORM_TILE16</a>
, <a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04a759c4d53c444373da1f49fd5dd557323">FORM_TILE24</a>
, <a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04a79d20d178441da2e0e2c93fd997381a8">FORM_TILE32</a>
, <br />
&#160;&#160;<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04a0febd2c6f3770d088fd18a2e19d94286">FORM_TILE48</a>
, <a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04a9f2f7b8de221297c24fdc490e4efbc63">FORM_TILE64</a>
, <a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04adad61d519c2099ce1fd3790894db84d1">FORM_MTEXT8</a>
, <a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04a86b5a451d1e664ae6119d2d1022415e8">FORM_MTEXT16</a>
, <br />
&#160;&#160;<a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04ac50576a8728c44e5cbbd55d4303f7e10">FORM_TEXT8</a>
, <a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04ab8ff3d166a357d7a522bd1b125dd5eb9">FORM_TEXT16</a>
, <a class="el" href="group__VideoModeGroup.html#ggabc6126af1d45847bc59afa0aa3216b04a9a4ad9cc81f78f276885b8b7b21ee66f">FORM_RLE</a>
, <b>FORM_MAX</b>
<br />
}</td></tr>
<tr class="memdesc:gabc6126af1d45847bc59afa0aa3216b04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Graphics formats. <a href="group__VideoModeGroup.html#gabc6126af1d45847bc59afa0aa3216b04">More...</a><br /></td></tr>
@@ -443,9 +443,7 @@ u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>