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

52
docs/group__LayersGroup.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: Overlay Layers</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>
@@ -132,45 +132,45 @@ $(document).ready(function(){initNavTree('group__LayersGroup.html',''); initResi
<h3>Shared overlay modes</h3>
<p>Layer modes can only be combined together if they use the same program. CPP is the minimum required number of SMx clock cycles per pixel. </p><table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone"></th><th class="markdownTableHeadCenter">PROG_BASE </th><th class="markdownTableHeadCenter">PROG_KEY </th><th class="markdownTableHeadCenter">PROG_BLACK </th><th class="markdownTableHeadCenter">PROG_WHITE </th><th class="markdownTableHeadCenter">PROG_MONO </th><th class="markdownTableHeadCenter">PROG_RLE </th><th class="markdownTableHeadCenter">CPP </th></tr>
<th class="markdownTableHeadNone"></th><th class="markdownTableHeadCenter">PROG_BASE </th><th class="markdownTableHeadCenter">PROG_KEY </th><th class="markdownTableHeadCenter">PROG_BLACK </th><th class="markdownTableHeadCenter">PROG_WHITE </th><th class="markdownTableHeadCenter">PROG_MONO </th><th class="markdownTableHeadCenter">PROG_RLE </th><th class="markdownTableHeadCenter">CPP </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">LAYERMODE_BASE </td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">2 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_BASE </td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">2 </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">LAYERMODE_KEY </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">6 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_KEY </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">6 </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">LAYERMODE_BLACK </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_BLACK </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">LAYERMODE_WHITE </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_WHITE </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">LAYERMODE_MONO </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_MONO </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">LAYERMODE_COLOR </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">2 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_COLOR </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">2 </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">LAYERMODE_RLE </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter">3 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_RLE </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter">3 </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">LAYERMODE_SPRITEKEY </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">6 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_SPRITEKEY </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">6 </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">LAYERMODE_SPRITEBLACK </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_SPRITEBLACK </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">LAYERMODE_SPRITEWHITE </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_SPRITEWHITE </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">LAYERMODE_FASTSPRITEKEY </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">6 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_FASTSPRITEKEY </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">6 </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">LAYERMODE_FASTSPRITEBLACK </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_FASTSPRITEBLACK </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">LAYERMODE_FASTSPRITEWHITE </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_FASTSPRITEWHITE </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">LAYERMODE_PERSPKEY </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">6 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_PERSPKEY </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">6 </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">LAYERMODE_PERSPBLACK </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_PERSPBLACK </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">LAYERMODE_PERSPWHITE </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_PERSPWHITE </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">LAYERMODE_PERSP2KEY </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">6 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_PERSP2KEY </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">6 </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">LAYERMODE_PERSP2BLACK </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_PERSP2BLACK </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">LAYERMODE_PERSP2WHITE </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
<td class="markdownTableBodyNone">LAYERMODE_PERSP2WHITE </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">X </td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter"></td><td class="markdownTableBodyCenter">4 </td></tr>
</table>
<h3>Selection of write planes</h3>
<p>By default, the image is output from the layers to all output pins. This can be changed by redefining the LayerFirstPin and LayerNumPin fields (in vga_layer.cpp). It is possible to specify for each layer separately which output pins will be written to. This can create a kind of pseudo-transparency. For example, one layer will render curves in red, another layer in green, and the colors will blend independently. When redefining the pins, however, you must take into account that the offset of the pin mapping will shift. The output will always start from the lowest bits of the pixel.</p>
@@ -720,9 +720,7 @@ u8&#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>