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/vga_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/vga.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>
@@ -95,17 +95,17 @@ $(document).ready(function(){initNavTree('vga_8h_source.html',''); initResizable
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#define _VGA_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="comment">// scanline type</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#define LINE_VSYNC 0 // long vertical sync</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#define LINE_VVSYNC 1 // short vertical + vertical sync</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#define LINE_VHSYNC 2 // short vertical + horizontal sync</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#define LINE_HHSYNC 3 // short horizontal + horizontal sync</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define LINE_HVSYNC 4 // short horizontal + vertical sync</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#define LINE_DARK 5 // dark line</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define LINE_IMG 6 // progressive image 0, 1, 2,...</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#define LINE_IMGEVEN1 7 // interlaced image even 0, 2, 4,..., 1st subframe</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define LINE_IMGEVEN2 8 // interlaced image even 0, 2, 4,..., 2nd subframe</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define LINE_IMGODD1 9 // interlaced image odd 1, 3, 5,..., 1st subframe</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#define LINE_IMGODD2 10 // interlaced image odd 1, 3, 5,..., 2nd subframe</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#define LINE_VSYNC 0 </span><span class="comment">// long vertical sync</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#define LINE_VVSYNC 1 </span><span class="comment">// short vertical + vertical sync</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#define LINE_VHSYNC 2 </span><span class="comment">// short vertical + horizontal sync</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#define LINE_HHSYNC 3 </span><span class="comment">// short horizontal + horizontal sync</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define LINE_HVSYNC 4 </span><span class="comment">// short horizontal + vertical sync</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#define LINE_DARK 5 </span><span class="comment">// dark line</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define LINE_IMG 6 </span><span class="comment">// progressive image 0, 1, 2,...</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#define LINE_IMGEVEN1 7 </span><span class="comment">// interlaced image even 0, 2, 4,..., 1st subframe</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define LINE_IMGEVEN2 8 </span><span class="comment">// interlaced image even 0, 2, 4,..., 2nd subframe</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define LINE_IMGODD1 9 </span><span class="comment">// interlaced image odd 1, 3, 5,..., 1st subframe</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#define LINE_IMGODD2 10 </span><span class="comment">// interlaced image odd 1, 3, 5,..., 2nd subframe</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">extern</span> u8 ScanlineType[MAXLINE];</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
@@ -214,24 +214,22 @@ $(document).ready(function(){initNavTree('vga_8h_source.html',''); initResizable
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; </div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;<span class="keywordtype">void</span> <a class="code" href="vga_8h.html#a906eb503fb409d6c3e9fa4489a8694aa">WaitVSync</a>();</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; </div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;<span class="preprocessor">#endif // _VGA_H</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// _VGA_H</span></div>
<div class="ttc" id="agroup__Core1Group_html_ga180966e085ce28347b335bde3d3d09ca"><div class="ttname"><a href="group__Core1Group.html#ga180966e085ce28347b335bde3d3d09ca">Core1Wait</a></div><div class="ttdeci">void Core1Wait()</div><div class="ttdoc">Wait for core 1 finish executing remote function.</div><div class="ttdef"><b>Definition:</b> vga.cpp:1148</div></div>
<div class="ttc" id="agroup__Core1Group_html_ga8304edb5a4c5f234724d4e6deeead917"><div class="ttname"><a href="group__Core1Group.html#ga8304edb5a4c5f234724d4e6deeead917">Core1Busy</a></div><div class="ttdeci">Bool Core1Busy()</div><div class="ttdoc">Check if core 1 is busy executing remote function.</div><div class="ttdef"><b>Definition:</b> vga.cpp:1141</div></div>
<div class="ttc" id="agroup__Core1Group_html_gafe1c81149967385aa5284a90153c98b7"><div class="ttname"><a href="group__Core1Group.html#gafe1c81149967385aa5284a90153c98b7">Core1Exec</a></div><div class="ttdeci">void Core1Exec(void(*fnc)())</div><div class="ttdoc">Execute remote function on second core.</div><div class="ttdef"><b>Definition:</b> vga.cpp:1133</div></div>
<div class="ttc" id="agroup__VideoInitGroup_html_ga0e413f66204b739fdcc8c675b9226d5b"><div class="ttname"><a href="group__VideoInitGroup.html#ga0e413f66204b739fdcc8c675b9226d5b">VgaInitReq</a></div><div class="ttdeci">void VgaInitReq(const sVmode *vmode)</div><div class="ttdoc">Request to initialize VGA videomode.</div><div class="ttdef"><b>Definition:</b> vga.cpp:1124</div></div>
<div class="ttc" id="agroup__VideoInitGroup_html_ga635c059231b4b8c8bbf4162a9044fcd6"><div class="ttname"><a href="group__VideoInitGroup.html#ga635c059231b4b8c8bbf4162a9044fcd6">StartVgaCore</a></div><div class="ttdeci">void StartVgaCore()</div><div class="ttdoc">Start the VGA processing on core1.</div><div class="ttdef"><b>Definition:</b> vga.cpp:1115</div></div>
<div class="ttc" id="astructsLayer_html"><div class="ttname"><a href="structsLayer.html">sLayer</a></div><div class="ttdoc">Layer screen descriptor (on change update SLAYER_* in define.h)</div><div class="ttdef"><b>Definition:</b> vga_layer.h:195</div></div>
<div class="ttc" id="astructsVmode_html"><div class="ttname"><a href="structsVmode.html">sVmode</a></div><div class="ttdoc">Videomode table - used to setup video driver.</div><div class="ttdef"><b>Definition:</b> vga_vmode.h:119</div></div>
<div class="ttc" id="avga_8h_html_a906eb503fb409d6c3e9fa4489a8694aa"><div class="ttname"><a href="vga_8h.html#a906eb503fb409d6c3e9fa4489a8694aa">WaitVSync</a></div><div class="ttdeci">void WaitVSync()</div><div class="ttdoc">Wait for VSync scanline.</div><div class="ttdef"><b>Definition:</b> vga.cpp:1154</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="avga_8h_html_a906eb503fb409d6c3e9fa4489a8694aa"><div class="ttname"><a href="vga_8h.html#a906eb503fb409d6c3e9fa4489a8694aa">WaitVSync</a></div><div class="ttdeci">void WaitVSync()</div><div class="ttdoc">Wait for VSync scanline.</div><div class="ttdef"><b>Definition:</b> vga.cpp:1101</div></div>
<div class="ttc" id="agroup__Core1Group_html_ga8304edb5a4c5f234724d4e6deeead917"><div class="ttname"><a href="group__Core1Group.html#ga8304edb5a4c5f234724d4e6deeead917">Core1Busy</a></div><div class="ttdeci">Bool Core1Busy()</div><div class="ttdoc">Check if core 1 is busy executing remote function.</div><div class="ttdef"><b>Definition:</b> vga.cpp:1088</div></div>
<div class="ttc" id="agroup__VideoInitGroup_html_ga635c059231b4b8c8bbf4162a9044fcd6"><div class="ttname"><a href="group__VideoInitGroup.html#ga635c059231b4b8c8bbf4162a9044fcd6">StartVgaCore</a></div><div class="ttdeci">void StartVgaCore()</div><div class="ttdoc">Start the VGA processing on core1.</div><div class="ttdef"><b>Definition:</b> vga.cpp:1062</div></div>
<div class="ttc" id="agroup__Core1Group_html_ga180966e085ce28347b335bde3d3d09ca"><div class="ttname"><a href="group__Core1Group.html#ga180966e085ce28347b335bde3d3d09ca">Core1Wait</a></div><div class="ttdeci">void Core1Wait()</div><div class="ttdoc">Wait for core 1 finish executing remote function.</div><div class="ttdef"><b>Definition:</b> vga.cpp:1095</div></div>
<div class="ttc" id="astructsLayer_html"><div class="ttname"><a href="structsLayer.html">sLayer</a></div><div class="ttdoc">Layer screen descriptor (on change update SLAYER_* in define.h)</div><div class="ttdef"><b>Definition:</b> vga_layer.h:195</div></div>
<div class="ttc" id="agroup__Core1Group_html_gafe1c81149967385aa5284a90153c98b7"><div class="ttname"><a href="group__Core1Group.html#gafe1c81149967385aa5284a90153c98b7">Core1Exec</a></div><div class="ttdeci">void Core1Exec(void(*fnc)())</div><div class="ttdoc">Execute remote function on second core.</div><div class="ttdef"><b>Definition:</b> vga.cpp:1080</div></div>
<div class="ttc" id="agroup__VideoInitGroup_html_ga0e413f66204b739fdcc8c675b9226d5b"><div class="ttname"><a href="group__VideoInitGroup.html#ga0e413f66204b739fdcc8c675b9226d5b">VgaInitReq</a></div><div class="ttdeci">void VgaInitReq(const sVmode *vmode)</div><div class="ttdoc">Request to initialize VGA videomode.</div><div class="ttdef"><b>Definition:</b> vga.cpp:1071</div></div>
<div class="ttc" id="astructsVmode_html"><div class="ttname"><a href="structsVmode.html">sVmode</a></div><div class="ttdoc">Videomode table - used to setup video driver.</div><div class="ttdef"><b>Definition:</b> vga_vmode.h:119</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_8h.html">vga.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>