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

160 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: sSprite 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('structsSprite.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">sSprite Struct Reference<div class="ingroups"><a class="el" href="group__LayersGroup.html">Overlay Layers</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Sprite (on change update SSPRITE_* in <a class="el" href="define_8h.html" title="VGA common definitions of C and ASM.">define.h</a>)
<a href="structsSprite.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:a395f270243a525a82e1372f4fe3a7730"><td class="memItemLeft" align="right" valign="top"><a id="a395f270243a525a82e1372f4fe3a7730"></a>
u8 *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSprite.html#a395f270243a525a82e1372f4fe3a7730">img</a></td></tr>
<tr class="memdesc:a395f270243a525a82e1372f4fe3a7730"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSPRITE_IMG pointer to image data. <br /></td></tr>
<tr class="separator:a395f270243a525a82e1372f4fe3a7730"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82ad70c7175425113103c68a2d0b034d"><td class="memItemLeft" align="right" valign="top"><a id="a82ad70c7175425113103c68a2d0b034d"></a>
u8 *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSprite.html#a82ad70c7175425113103c68a2d0b034d">x0</a></td></tr>
<tr class="memdesc:a82ad70c7175425113103c68a2d0b034d"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSPRITE_X0 pointer to array of start of lines, or fast sprite start of lines/4. <br /></td></tr>
<tr class="separator:a82ad70c7175425113103c68a2d0b034d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9dcc67b1adcad4346623b9c130b4044a"><td class="memItemLeft" align="right" valign="top"><a id="a9dcc67b1adcad4346623b9c130b4044a"></a>
u8 *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSprite.html#a9dcc67b1adcad4346623b9c130b4044a">w0</a></td></tr>
<tr class="memdesc:a9dcc67b1adcad4346623b9c130b4044a"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSPRITE_W0 pointer to array of length of lines, or fast sprite length of lines/4. <br /></td></tr>
<tr class="separator:a9dcc67b1adcad4346623b9c130b4044a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92cd06c0972d641d43939a045b33f745"><td class="memItemLeft" align="right" valign="top"><a id="a92cd06c0972d641d43939a045b33f745"></a>
u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSprite.html#a92cd06c0972d641d43939a045b33f745">keycol</a></td></tr>
<tr class="memdesc:a92cd06c0972d641d43939a045b33f745"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSPRITE_KEYCOL key color. <br /></td></tr>
<tr class="separator:a92cd06c0972d641d43939a045b33f745"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5044957a620c165c22e28ad98fdf534"><td class="memItemLeft" align="right" valign="top"><a id="ad5044957a620c165c22e28ad98fdf534"></a>
s16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSprite.html#ad5044957a620c165c22e28ad98fdf534">x</a></td></tr>
<tr class="memdesc:ad5044957a620c165c22e28ad98fdf534"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSPRITE_X sprite X-coordinate on the screen. <br /></td></tr>
<tr class="separator:ad5044957a620c165c22e28ad98fdf534"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a479fcf77a3c4c5af868eeb3c04dba712"><td class="memItemLeft" align="right" valign="top"><a id="a479fcf77a3c4c5af868eeb3c04dba712"></a>
s16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSprite.html#a479fcf77a3c4c5af868eeb3c04dba712">y</a></td></tr>
<tr class="memdesc:a479fcf77a3c4c5af868eeb3c04dba712"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSPRITE_Y sprite Y-coordinate on the screen. <br /></td></tr>
<tr class="separator:a479fcf77a3c4c5af868eeb3c04dba712"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f6d6284ef10949275ac7f2aa9509911"><td class="memItemLeft" align="right" valign="top"><a id="a4f6d6284ef10949275ac7f2aa9509911"></a>
u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSprite.html#a4f6d6284ef10949275ac7f2aa9509911">w</a></td></tr>
<tr class="memdesc:a4f6d6284ef10949275ac7f2aa9509911"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSPRITE_W sprite width (slow sprite: max. width 255) <br /></td></tr>
<tr class="separator:a4f6d6284ef10949275ac7f2aa9509911"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09b6b2fa088bfedf8ac3fd8581f2c1b5"><td class="memItemLeft" align="right" valign="top"><a id="a09b6b2fa088bfedf8ac3fd8581f2c1b5"></a>
u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSprite.html#a09b6b2fa088bfedf8ac3fd8581f2c1b5">h</a></td></tr>
<tr class="memdesc:a09b6b2fa088bfedf8ac3fd8581f2c1b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSPRITE_H sprite height. <br /></td></tr>
<tr class="separator:a09b6b2fa088bfedf8ac3fd8581f2c1b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74377291c0719b19b1db0038cf257f03"><td class="memItemLeft" align="right" valign="top"><a id="a74377291c0719b19b1db0038cf257f03"></a>
u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSprite.html#a74377291c0719b19b1db0038cf257f03">wb</a></td></tr>
<tr class="memdesc:a74377291c0719b19b1db0038cf257f03"><td class="mdescLeft">&#160;</td><td class="mdescRight">SSPRITE_WB sprite pitch (number of bytes between lines) <br /></td></tr>
<tr class="separator:a74377291c0719b19b1db0038cf257f03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a902fc00d68119698ac834ceafcb4f1e2"><td class="memItemLeft" align="right" valign="top"><a id="a902fc00d68119698ac834ceafcb4f1e2"></a>
u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsSprite.html#a902fc00d68119698ac834ceafcb4f1e2">res</a></td></tr>
<tr class="memdesc:a902fc00d68119698ac834ceafcb4f1e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reserved, structure align. <br /></td></tr>
<tr class="separator:a902fc00d68119698ac834ceafcb4f1e2"><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>Sprite (on change update SSPRITE_* 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="structsSprite.html">sSprite</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>