N64FlashcartMenu/background_8c.html
2025-03-31 15:28:34 +00:00

319 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>N64FlashcartMenu: background.c File 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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" />
</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 id="projectrow">
<td id="projectalign">
<div id="projectname">N64FlashcartMenu
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_1a56cc8cdc1689899910be5fa4716ee4.html">menu</a></li><li class="navelem"><a class="el" href="dir_91ef91b561d039ab546b53c185f0f23a.html">ui_components</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">background.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Background component implementation.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:structcomponent__background__t" id="r_structcomponent__background__t"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#structcomponent__background__t">component_background_t</a></td></tr>
<tr class="memdesc:structcomponent__background__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">Background component structure. <a href="#structcomponent__background__t">More...</a><br /></td></tr>
<tr class="separator:structcomponent__background__t"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:structcache__metadata__t" id="r_structcache__metadata__t"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#structcache__metadata__t">cache_metadata_t</a></td></tr>
<tr class="memdesc:structcache__metadata__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cache metadata structure. <a href="#structcache__metadata__t">More...</a><br /></td></tr>
<tr class="separator:structcache__metadata__t"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ac13b75d58b2f1d5986ef7f4fd0af76a5" id="r_ac13b75d58b2f1d5986ef7f4fd0af76a5"><td class="memItemLeft" align="right" valign="top"><a id="ac13b75d58b2f1d5986ef7f4fd0af76a5" name="ac13b75d58b2f1d5986ef7f4fd0af76a5"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CACHE_METADATA_MAGIC</b>&#160;&#160;&#160;(0x424B4731)</td></tr>
<tr class="separator:ac13b75d58b2f1d5986ef7f4fd0af76a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9e46cb883ffa851e48a4d40beeb1a107" id="r_a9e46cb883ffa851e48a4d40beeb1a107"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9e46cb883ffa851e48a4d40beeb1a107">ui_components_background_init</a> (char *cache_location)</td></tr>
<tr class="memdesc:a9e46cb883ffa851e48a4d40beeb1a107"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the background component. <br /></td></tr>
<tr class="separator:a9e46cb883ffa851e48a4d40beeb1a107"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff8c7238e004733ed189888e0e639948" id="r_aff8c7238e004733ed189888e0e639948"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aff8c7238e004733ed189888e0e639948">ui_components_background_free</a> (void)</td></tr>
<tr class="memdesc:aff8c7238e004733ed189888e0e639948"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free the background component. <br /></td></tr>
<tr class="separator:aff8c7238e004733ed189888e0e639948"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b997df3be1af71aae30da3b3db0f467" id="r_a3b997df3be1af71aae30da3b3db0f467"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3b997df3be1af71aae30da3b3db0f467">ui_components_background_replace_image</a> (surface_t *image)</td></tr>
<tr class="memdesc:a3b997df3be1af71aae30da3b3db0f467"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replace the background image. <br /></td></tr>
<tr class="separator:a3b997df3be1af71aae30da3b3db0f467"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a430e0e508cd3f8afa45d92c829ef4641" id="r_a430e0e508cd3f8afa45d92c829ef4641"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a430e0e508cd3f8afa45d92c829ef4641">ui_components_background_draw</a> (void)</td></tr>
<tr class="memdesc:a430e0e508cd3f8afa45d92c829ef4641"><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw the background. <br /></td></tr>
<tr class="separator:a430e0e508cd3f8afa45d92c829ef4641"><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>Background component implementation. </p>
</div><hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structcomponent__background__t" id="structcomponent__background__t"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structcomponent__background__t">&#9670;&#160;</a></span>component_background_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct component_background_t</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Background component structure. </p>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a id="a82f6116c3cf986b83eacffd84f790ed7" name="a82f6116c3cf986b83eacffd84f790ed7"></a>char *</td>
<td class="fieldname">
cache_location</td>
<td class="fielddoc">
<p>Cache location </p>
</td></tr>
<tr><td class="fieldtype">
<a id="af065caf7258daa8fb571eb1056691830" name="af065caf7258daa8fb571eb1056691830"></a>surface_t *</td>
<td class="fieldname">
image</td>
<td class="fielddoc">
<p>Image surface </p>
</td></tr>
<tr><td class="fieldtype">
<a id="a6b4c36cf75ed19acef1e5dd7330be200" name="a6b4c36cf75ed19acef1e5dd7330be200"></a>rspq_block_t *</td>
<td class="fieldname">
image_display_list</td>
<td class="fielddoc">
<p>Image display list </p>
</td></tr>
</table>
</div>
</div>
<a name="structcache__metadata__t" id="structcache__metadata__t"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structcache__metadata__t">&#9670;&#160;</a></span>cache_metadata_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct cache_metadata_t</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Cache metadata structure. </p>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a id="aa6565922aed75e902ef3d8ec507a0d05" name="aa6565922aed75e902ef3d8ec507a0d05"></a>uint32_t</td>
<td class="fieldname">
magic</td>
<td class="fielddoc">
<p>Magic number </p>
</td></tr>
<tr><td class="fieldtype">
<a id="a629d147e85b276d84c7b6f5a7c7e2777" name="a629d147e85b276d84c7b6f5a7c7e2777"></a>uint32_t</td>
<td class="fieldname">
width</td>
<td class="fielddoc">
<p>Image width </p>
</td></tr>
<tr><td class="fieldtype">
<a id="a91a944d389d76792077ff64bf966e467" name="a91a944d389d76792077ff64bf966e467"></a>uint32_t</td>
<td class="fieldname">
height</td>
<td class="fielddoc">
<p>Image height </p>
</td></tr>
<tr><td class="fieldtype">
<a id="a760f7345951a200ae13590002331882d" name="a760f7345951a200ae13590002331882d"></a>uint32_t</td>
<td class="fieldname">
size</td>
<td class="fielddoc">
<p>Image size </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a9e46cb883ffa851e48a4d40beeb1a107" name="a9e46cb883ffa851e48a4d40beeb1a107"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e46cb883ffa851e48a4d40beeb1a107">&#9670;&#160;</a></span>ui_components_background_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ui_components_background_init </td>
<td>(</td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>cache_location</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the background component. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cache_location</td><td>The cache location. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aff8c7238e004733ed189888e0e639948" name="aff8c7238e004733ed189888e0e639948"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff8c7238e004733ed189888e0e639948">&#9670;&#160;</a></span>ui_components_background_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ui_components_background_free </td>
<td>(</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free the background component. </p>
<p>Free the background component resources. </p>
</div>
</div>
<a id="a3b997df3be1af71aae30da3b3db0f467" name="a3b997df3be1af71aae30da3b3db0f467"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b997df3be1af71aae30da3b3db0f467">&#9670;&#160;</a></span>ui_components_background_replace_image()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ui_components_background_replace_image </td>
<td>(</td>
<td class="paramtype">surface_t *</td> <td class="paramname"><span class="paramname"><em>image</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Replace the background image. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>The new background image. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a430e0e508cd3f8afa45d92c829ef4641" name="a430e0e508cd3f8afa45d92c829ef4641"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a430e0e508cd3f8afa45d92c829ef4641">&#9670;&#160;</a></span>ui_components_background_draw()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ui_components_background_draw </td>
<td>(</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Draw the background. </p>
<p>Draw the background component. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Mar 31 2025 15:28:33 for N64FlashcartMenu by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>