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

182 lines
12 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: sSegm 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('structsSegm.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">sSegm Struct Reference<div class="ingroups"><a class="el" href="group__ScreenGroup.html">Screen Layout</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Video segment (on change update SSEGM_* in <a class="el" href="define_8h.html" title="VGA common definitions of C and ASM.">define.h</a>)
<a href="structsSegm.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="vga__screen_8h_source.html">vga_screen.h</a>&gt;</code></p>
<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:af02228a735b6f43e2c65228aa4150a93"><td class="memItemLeft" align="right" valign="top"><a id="af02228a735b6f43e2c65228aa4150a93"></a>
u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSegm.html#af02228a735b6f43e2c65228aa4150a93">width</a></td></tr>
<tr class="memdesc:af02228a735b6f43e2c65228aa4150a93"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSEGM_WIDTH width of this video segment in pixels (must be multiple of 4, 0=inactive segment) <br /></td></tr>
<tr class="separator:af02228a735b6f43e2c65228aa4150a93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d95ae3691b71551aa466c73e26b0e6d"><td class="memItemLeft" align="right" valign="top"><a id="a8d95ae3691b71551aa466c73e26b0e6d"></a>
u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSegm.html#a8d95ae3691b71551aa466c73e26b0e6d">wb</a></td></tr>
<tr class="memdesc:a8d95ae3691b71551aa466c73e26b0e6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSEGM_WB pitch - number of bytes between lines. <br /></td></tr>
<tr class="separator:a8d95ae3691b71551aa466c73e26b0e6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7672a1689524ed4b8f9e11c8674def71"><td class="memItemLeft" align="right" valign="top"><a id="a7672a1689524ed4b8f9e11c8674def71"></a>
s16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSegm.html#a7672a1689524ed4b8f9e11c8674def71">offx</a></td></tr>
<tr class="memdesc:a7672a1689524ed4b8f9e11c8674def71"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSEGM_OFFX display offset at X direction (must be multiple of 4) <br /></td></tr>
<tr class="separator:a7672a1689524ed4b8f9e11c8674def71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88452adfa558a8131a720df704fc4ef8"><td class="memItemLeft" align="right" valign="top"><a id="a88452adfa558a8131a720df704fc4ef8"></a>
s16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSegm.html#a88452adfa558a8131a720df704fc4ef8">offy</a></td></tr>
<tr class="memdesc:a88452adfa558a8131a720df704fc4ef8"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSEGM_OFFY display offset at Y direction. <br /></td></tr>
<tr class="separator:a88452adfa558a8131a720df704fc4ef8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4744cd49af426bdc710f9543e10e5f2"><td class="memItemLeft" align="right" valign="top">u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSegm.html#aa4744cd49af426bdc710f9543e10e5f2">wrapx</a></td></tr>
<tr class="separator:aa4744cd49af426bdc710f9543e10e5f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad11cdfd5dc96699f8381799762847a4d"><td class="memItemLeft" align="right" valign="top"><a id="ad11cdfd5dc96699f8381799762847a4d"></a>
u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSegm.html#ad11cdfd5dc96699f8381799762847a4d">wrapy</a></td></tr>
<tr class="memdesc:ad11cdfd5dc96699f8381799762847a4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSEGM_WRAPY wrap width in Y direction (number of lines, cannot be 0) <br /></td></tr>
<tr class="separator:ad11cdfd5dc96699f8381799762847a4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29fd56b2214e170d8e9a2f67c2ae778f"><td class="memItemLeft" align="right" valign="top"><a id="a29fd56b2214e170d8e9a2f67c2ae778f"></a>
const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSegm.html#a29fd56b2214e170d8e9a2f67c2ae778f">data</a></td></tr>
<tr class="memdesc:a29fd56b2214e170d8e9a2f67c2ae778f"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSEGM_DATA pointer to video buffer with image data. <br /></td></tr>
<tr class="separator:a29fd56b2214e170d8e9a2f67c2ae778f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3413062ba9ff0436952d7ff8176edad9"><td class="memItemLeft" align="right" valign="top"><a id="a3413062ba9ff0436952d7ff8176edad9"></a>
u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSegm.html#a3413062ba9ff0436952d7ff8176edad9">form</a></td></tr>
<tr class="memdesc:a3413062ba9ff0436952d7ff8176edad9"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSEGM_FORM graphics format GF_*. <br /></td></tr>
<tr class="separator:a3413062ba9ff0436952d7ff8176edad9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a359b60c1de8f3aaefd3163c17fc57c37"><td class="memItemLeft" align="right" valign="top"><a id="a359b60c1de8f3aaefd3163c17fc57c37"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSegm.html#a359b60c1de8f3aaefd3163c17fc57c37">dbly</a></td></tr>
<tr class="memdesc:a359b60c1de8f3aaefd3163c17fc57c37"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSEGM_DBLY double Y (2 scanlines per 1 image line) <br /></td></tr>
<tr class="separator:a359b60c1de8f3aaefd3163c17fc57c37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8eabc927a647f9aff75e85be4e0f8e79"><td class="memItemLeft" align="right" valign="top"><a id="a8eabc927a647f9aff75e85be4e0f8e79"></a>
u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSegm.html#a8eabc927a647f9aff75e85be4e0f8e79">par3</a></td></tr>
<tr class="memdesc:a8eabc927a647f9aff75e85be4e0f8e79"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSEGM_PAR3 parameter 3. <br /></td></tr>
<tr class="separator:a8eabc927a647f9aff75e85be4e0f8e79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ec9a4a62e748c3f11ebf2f56e4abcd1"><td class="memItemLeft" align="right" valign="top"><a id="a0ec9a4a62e748c3f11ebf2f56e4abcd1"></a>
u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSegm.html#a0ec9a4a62e748c3f11ebf2f56e4abcd1">par</a></td></tr>
<tr class="memdesc:a0ec9a4a62e748c3f11ebf2f56e4abcd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSEGM_PAR parameter 1. <br /></td></tr>
<tr class="separator:a0ec9a4a62e748c3f11ebf2f56e4abcd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d9275957e0b8c011c78fc707a252c9b"><td class="memItemLeft" align="right" valign="top"><a id="a6d9275957e0b8c011c78fc707a252c9b"></a>
u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSegm.html#a6d9275957e0b8c011c78fc707a252c9b">par2</a></td></tr>
<tr class="memdesc:a6d9275957e0b8c011c78fc707a252c9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSEGM_PAR2 parameter 2. <br /></td></tr>
<tr class="separator:a6d9275957e0b8c011c78fc707a252c9b"><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>Video segment (on change update SSEGM_* in <a class="el" href="define_8h.html" title="VGA common definitions of C and ASM.">define.h</a>) </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="aa4744cd49af426bdc710f9543e10e5f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4744cd49af426bdc710f9543e10e5f2">&#9670;&nbsp;</a></span>wrapx</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u16 sSegm::wrapx</td>
</tr>
</table>
</div><div class="memdoc">
<p>SSEGM_WRAPX wrap width in X direction (number of pixels, must be multiply of 4 and &gt; 0) text modes: wrapx must be multiply of 8 </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/<a class="el" href="vga__screen_8h_source.html">vga_screen.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="structsSegm.html">sSegm</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>