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

188 lines
15 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: sLayer 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('structsLayer.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">sLayer Struct Reference<div class="ingroups"><a class="el" href="group__LayersGroup.html">Overlay Layers</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Layer screen descriptor (on change update SLAYER_* in <a class="el" href="define_8h.html" title="VGA common definitions of C and ASM.">define.h</a>)
<a href="structsLayer.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="vga__layer_8h_source.html">vga_layer.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:a0a9fb9453c46f2cca3418f72eb255137"><td class="memItemLeft" align="right" valign="top"><a id="a0a9fb9453c46f2cca3418f72eb255137"></a>
const u8 *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsLayer.html#a0a9fb9453c46f2cca3418f72eb255137">img</a></td></tr>
<tr class="memdesc:a0a9fb9453c46f2cca3418f72eb255137"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to image in current layer format, or sprite list. <br /></td></tr>
<tr class="separator:a0a9fb9453c46f2cca3418f72eb255137"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a977fddc23e4e5ea1acc1e76b3288cc7d"><td class="memItemLeft" align="right" valign="top"><a id="a977fddc23e4e5ea1acc1e76b3288cc7d"></a>
const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsLayer.html#a977fddc23e4e5ea1acc1e76b3288cc7d">par</a></td></tr>
<tr class="memdesc:a977fddc23e4e5ea1acc1e76b3288cc7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Additional parameter (RLE index table, integer transformation matrix) <br /></td></tr>
<tr class="separator:a977fddc23e4e5ea1acc1e76b3288cc7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15444149d14ab00cd1a9db118ec25fc4"><td class="memItemLeft" align="right" valign="top"><a id="a15444149d14ab00cd1a9db118ec25fc4"></a>
u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsLayer.html#a15444149d14ab00cd1a9db118ec25fc4">init</a></td></tr>
<tr class="memdesc:a15444149d14ab00cd1a9db118ec25fc4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Init word sent on start of scanline (start X coordinate) <br /></td></tr>
<tr class="separator:a15444149d14ab00cd1a9db118ec25fc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac0d2680ab5a6103717a36f7db9187f3"><td class="memItemLeft" align="right" valign="top"><a id="aac0d2680ab5a6103717a36f7db9187f3"></a>
u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsLayer.html#aac0d2680ab5a6103717a36f7db9187f3">keycol</a></td></tr>
<tr class="memdesc:aac0d2680ab5a6103717a36f7db9187f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key color. <br /></td></tr>
<tr class="separator:aac0d2680ab5a6103717a36f7db9187f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ecbd38a6da5261823990fef4b78270c"><td class="memItemLeft" align="right" valign="top"><a id="a5ecbd38a6da5261823990fef4b78270c"></a>
u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsLayer.html#a5ecbd38a6da5261823990fef4b78270c">trans</a></td></tr>
<tr class="memdesc:a5ecbd38a6da5261823990fef4b78270c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Trans count. <br /></td></tr>
<tr class="separator:a5ecbd38a6da5261823990fef4b78270c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a29cd6a22a5e7a2743714cfb14dab7a"><td class="memItemLeft" align="right" valign="top"><a id="a7a29cd6a22a5e7a2743714cfb14dab7a"></a>
s16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsLayer.html#a7a29cd6a22a5e7a2743714cfb14dab7a">x</a></td></tr>
<tr class="memdesc:a7a29cd6a22a5e7a2743714cfb14dab7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start X coordinate. <br /></td></tr>
<tr class="separator:a7a29cd6a22a5e7a2743714cfb14dab7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c2a809dce2ae575f84aca07bcf25ecc"><td class="memItemLeft" align="right" valign="top"><a id="a1c2a809dce2ae575f84aca07bcf25ecc"></a>
s16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsLayer.html#a1c2a809dce2ae575f84aca07bcf25ecc">y</a></td></tr>
<tr class="memdesc:a1c2a809dce2ae575f84aca07bcf25ecc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start Y coordinate. <br /></td></tr>
<tr class="separator:a1c2a809dce2ae575f84aca07bcf25ecc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23de438bb18f13c25cda42f2b87af5b1"><td class="memItemLeft" align="right" valign="top"><a id="a23de438bb18f13c25cda42f2b87af5b1"></a>
u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsLayer.html#a23de438bb18f13c25cda42f2b87af5b1">w</a></td></tr>
<tr class="memdesc:a23de438bb18f13c25cda42f2b87af5b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Width in pixels. <br /></td></tr>
<tr class="separator:a23de438bb18f13c25cda42f2b87af5b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab09958f929bd6dc21a1bb65cc063a62a"><td class="memItemLeft" align="right" valign="top"><a id="ab09958f929bd6dc21a1bb65cc063a62a"></a>
u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsLayer.html#ab09958f929bd6dc21a1bb65cc063a62a">h</a></td></tr>
<tr class="memdesc:ab09958f929bd6dc21a1bb65cc063a62a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Height. <br /></td></tr>
<tr class="separator:ab09958f929bd6dc21a1bb65cc063a62a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae594a65d332b1612758adbe0ac9bfaa5"><td class="memItemLeft" align="right" valign="top"><a id="ae594a65d332b1612758adbe0ac9bfaa5"></a>
u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsLayer.html#ae594a65d332b1612758adbe0ac9bfaa5">wb</a></td></tr>
<tr class="memdesc:ae594a65d332b1612758adbe0ac9bfaa5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Image width in bytes (pitch of lines) <br /></td></tr>
<tr class="separator:ae594a65d332b1612758adbe0ac9bfaa5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac44e73d69c6b028dd4274556f1e24846"><td class="memItemLeft" align="right" valign="top"><a id="ac44e73d69c6b028dd4274556f1e24846"></a>
u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsLayer.html#ac44e73d69c6b028dd4274556f1e24846">mode</a></td></tr>
<tr class="memdesc:ac44e73d69c6b028dd4274556f1e24846"><td class="mdescLeft">&#160;</td><td class="mdescRight">Layer mode. <br /></td></tr>
<tr class="separator:ac44e73d69c6b028dd4274556f1e24846"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7faa17573c513e11a8b2db896faa39c1"><td class="memItemLeft" align="right" valign="top"><a id="a7faa17573c513e11a8b2db896faa39c1"></a>
s8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsLayer.html#a7faa17573c513e11a8b2db896faa39c1">horiz</a></td></tr>
<tr class="memdesc:a7faa17573c513e11a8b2db896faa39c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Horizon of perspective projection/4 (only with LAYERMODE_PERSP* modes, 0=no perspecitve, &lt;0 ceilling) <br /></td></tr>
<tr class="separator:a7faa17573c513e11a8b2db896faa39c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8cfe006acd74ac0a1266fea6640a01f1"><td class="memItemLeft" align="right" valign="top"><a id="a8cfe006acd74ac0a1266fea6640a01f1"></a>
u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsLayer.html#a8cfe006acd74ac0a1266fea6640a01f1">xbits</a></td></tr>
<tr class="memdesc:a8cfe006acd74ac0a1266fea6640a01f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of bits of width of source image (only with LAYERMODE_PERSP* modes) <br /></td></tr>
<tr class="separator:a8cfe006acd74ac0a1266fea6640a01f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21f3684b7133f5f894ff86b72ca8c685"><td class="memItemLeft" align="right" valign="top"><a id="a21f3684b7133f5f894ff86b72ca8c685"></a>
u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsLayer.html#a21f3684b7133f5f894ff86b72ca8c685">ybits</a></td></tr>
<tr class="memdesc:a21f3684b7133f5f894ff86b72ca8c685"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of bits of height of source image (only with LAYERMODE_PERSP* modes) <br /></td></tr>
<tr class="separator:a21f3684b7133f5f894ff86b72ca8c685"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0550111309acfab91e8e0a2169f78728"><td class="memItemLeft" align="right" valign="top"><a id="a0550111309acfab91e8e0a2169f78728"></a>
u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsLayer.html#a0550111309acfab91e8e0a2169f78728">spritenum</a></td></tr>
<tr class="memdesc:a0550111309acfab91e8e0a2169f78728"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of sprites. <br /></td></tr>
<tr class="separator:a0550111309acfab91e8e0a2169f78728"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad39692fa5c6712f35d83b33b16ff50ee"><td class="memItemLeft" align="right" valign="top"><a id="ad39692fa5c6712f35d83b33b16ff50ee"></a>
Bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsLayer.html#ad39692fa5c6712f35d83b33b16ff50ee">on</a></td></tr>
<tr class="memdesc:ad39692fa5c6712f35d83b33b16ff50ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Layer is ON. <br /></td></tr>
<tr class="separator:ad39692fa5c6712f35d83b33b16ff50ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26daff2ecab64e079ff060f3b97db230"><td class="memItemLeft" align="right" valign="top"><a id="a26daff2ecab64e079ff060f3b97db230"></a>
u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsLayer.html#a26daff2ecab64e079ff060f3b97db230">cpp</a></td></tr>
<tr class="memdesc:a26daff2ecab64e079ff060f3b97db230"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current clock pulses per pixel (used to calculate X coordinate) <br /></td></tr>
<tr class="separator:a26daff2ecab64e079ff060f3b97db230"><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>Layer screen descriptor (on change update SLAYER_* in <a class="el" href="define_8h.html" title="VGA common definitions of C and ASM.">define.h</a>) </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/<a class="el" href="vga__layer_8h_source.html">vga_layer.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="structsLayer.html">sLayer</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>