Files
picovga-cmake/docs/structsVgaCfg.html
2025-08-26 20:47:11 -07:00

178 lines
11 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PicoVGA: sVgaCfg Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<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.2-cmake</span>
</div>
<div id="projectbrief">VGA/TV display on Raspberry Pico</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- 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','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structsVgaCfg.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">sVgaCfg Struct Reference<div class="ingroups"><a class="el" href="group__VideoModeGroup.html">Configurating Video Mode</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Required configuration to initialize VGA output.
<a href="structsVgaCfg.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="vga__vmode_8h_source.html">vga_vmode.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for sVgaCfg:</div>
<div class="dyncontent">
<div class="center"><img src="structsVgaCfg__coll__graph.png" border="0" usemap="#asVgaCfg_coll__map" alt="Collaboration graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ae3a5a625a197b1d1274f8bdbcf3f5d79"><td class="memItemLeft" align="right" valign="top"><a id="ae3a5a625a197b1d1274f8bdbcf3f5d79"></a>
u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsVgaCfg.html#ae3a5a625a197b1d1274f8bdbcf3f5d79">width</a></td></tr>
<tr class="memdesc:ae3a5a625a197b1d1274f8bdbcf3f5d79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Width in pixels. <br /></td></tr>
<tr class="separator:ae3a5a625a197b1d1274f8bdbcf3f5d79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c10f3a92b1e6114bb0bded8b1d9bb19"><td class="memItemLeft" align="right" valign="top"><a id="a8c10f3a92b1e6114bb0bded8b1d9bb19"></a>
u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsVgaCfg.html#a8c10f3a92b1e6114bb0bded8b1d9bb19">height</a></td></tr>
<tr class="memdesc:a8c10f3a92b1e6114bb0bded8b1d9bb19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Height in lines. <br /></td></tr>
<tr class="separator:a8c10f3a92b1e6114bb0bded8b1d9bb19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc4ce1f0849b1e4d62275ecbd022abf6"><td class="memItemLeft" align="right" valign="top"><a id="afc4ce1f0849b1e4d62275ecbd022abf6"></a>
u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsVgaCfg.html#afc4ce1f0849b1e4d62275ecbd022abf6">wfull</a></td></tr>
<tr class="memdesc:afc4ce1f0849b1e4d62275ecbd022abf6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Width of full screen, corresponding to 'hfull' time (0=use 'width' parameter) <br /></td></tr>
<tr class="separator:afc4ce1f0849b1e4d62275ecbd022abf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a751fec0afe8c770d1b5723fd141c5193"><td class="memItemLeft" align="right" valign="top"><a id="a751fec0afe8c770d1b5723fd141c5193"></a>
const <a class="el" href="structsVideo.html">sVideo</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsVgaCfg.html#a751fec0afe8c770d1b5723fd141c5193">video</a></td></tr>
<tr class="memdesc:a751fec0afe8c770d1b5723fd141c5193"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used video timings. <br /></td></tr>
<tr class="separator:a751fec0afe8c770d1b5723fd141c5193"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade221fd512bc5ba2225c224b0fc41c44"><td class="memItemLeft" align="right" valign="top"><a id="ade221fd512bc5ba2225c224b0fc41c44"></a>
u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsVgaCfg.html#ade221fd512bc5ba2225c224b0fc41c44">freq</a></td></tr>
<tr class="memdesc:ade221fd512bc5ba2225c224b0fc41c44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Required minimal system frequency in kHz (real frequency can be higher) <br /></td></tr>
<tr class="separator:ade221fd512bc5ba2225c224b0fc41c44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab46d8256efd25688c789fd10827ce549"><td class="memItemLeft" align="right" valign="top"><a id="ab46d8256efd25688c789fd10827ce549"></a>
u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsVgaCfg.html#ab46d8256efd25688c789fd10827ce549">fmax</a></td></tr>
<tr class="memdesc:ab46d8256efd25688c789fd10827ce549"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximal system frequency in kHz (limit resolution if needed) <br /></td></tr>
<tr class="separator:ab46d8256efd25688c789fd10827ce549"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59bd4bc34f9e5fc1dae4aae2ca3b81d9"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsVgaCfg.html#a59bd4bc34f9e5fc1dae4aae2ca3b81d9">mode</a> [LAYERS_MAX]</td></tr>
<tr class="separator:a59bd4bc34f9e5fc1dae4aae2ca3b81d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21a20dab4d94ff69bd3777bc19d41e7a"><td class="memItemLeft" align="right" valign="top"><a id="a21a20dab4d94ff69bd3777bc19d41e7a"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsVgaCfg.html#a21a20dab4d94ff69bd3777bc19d41e7a">dbly</a></td></tr>
<tr class="memdesc:a21a20dab4d94ff69bd3777bc19d41e7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">double in Y direction <br /></td></tr>
<tr class="separator:a21a20dab4d94ff69bd3777bc19d41e7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc1179439d4dcae3ddfc9cb446f91fbd"><td class="memItemLeft" align="right" valign="top"><a id="acc1179439d4dcae3ddfc9cb446f91fbd"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsVgaCfg.html#acc1179439d4dcae3ddfc9cb446f91fbd">lockfreq</a></td></tr>
<tr class="memdesc:acc1179439d4dcae3ddfc9cb446f91fbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lock required frequency, do not change it. <br /></td></tr>
<tr class="separator:acc1179439d4dcae3ddfc9cb446f91fbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Required configuration to initialize VGA output. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a59bd4bc34f9e5fc1dae4aae2ca3b81d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59bd4bc34f9e5fc1dae4aae2ca3b81d9">&#9670;&nbsp;</a></span>mode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u8 sVgaCfg::mode[LAYERS_MAX]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Modes of overlapped layers 0..3 LAYERMODE_* (LAYERMODE_BASE = layer is off)</p><ul>
<li>mode of layer 0 is ignored (always use LAYERMODE_BASE)</li>
<li>all overlapped layers must use same layer program </li>
</ul>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/<a class="el" href="vga__vmode_8h_source.html">vga_vmode.h</a></li>
</ul>
</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="structsVgaCfg.html">sVgaCfg</a></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>
</html>