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

318 lines
14 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: png_decoder.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> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">png_decoder.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>PNG Decoder 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:structpng__decoder__t" id="r_structpng__decoder__t"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#structpng__decoder__t">png_decoder_t</a></td></tr>
<tr class="memdesc:structpng__decoder__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">PNG File Information Structure. <a href="#structpng__decoder__t">More...</a><br /></td></tr>
<tr class="separator:structpng__decoder__t"><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:a91b64bacdbc4945af5e10bc2171e95ed" id="r_a91b64bacdbc4945af5e10bc2171e95ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="png__decoder_8h.html#ac5fcb9a8ef757c913a1529c94c7436d4">png_err_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a91b64bacdbc4945af5e10bc2171e95ed">png_decoder_start</a> (char *path, int max_width, int max_height, <a class="el" href="png__decoder_8h.html#a85923de55a2f9fb330741fee267bb57b">png_callback_t</a> *callback, void *callback_data)</td></tr>
<tr class="memdesc:a91b64bacdbc4945af5e10bc2171e95ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start decoding a PNG file. <br /></td></tr>
<tr class="separator:a91b64bacdbc4945af5e10bc2171e95ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac38ee3f3c0d1efba8b698e52d3ed203f" id="r_ac38ee3f3c0d1efba8b698e52d3ed203f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac38ee3f3c0d1efba8b698e52d3ed203f">png_decoder_abort</a> (void)</td></tr>
<tr class="memdesc:ac38ee3f3c0d1efba8b698e52d3ed203f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abort the PNG decoding process. <br /></td></tr>
<tr class="separator:ac38ee3f3c0d1efba8b698e52d3ed203f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b2ba820e7e2d9b49ba727b78beb6ac8" id="r_a6b2ba820e7e2d9b49ba727b78beb6ac8"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6b2ba820e7e2d9b49ba727b78beb6ac8">png_decoder_get_progress</a> (void)</td></tr>
<tr class="memdesc:a6b2ba820e7e2d9b49ba727b78beb6ac8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the progress of the PNG decoding process. <br /></td></tr>
<tr class="separator:a6b2ba820e7e2d9b49ba727b78beb6ac8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e7514f26e11a67484fe42009bf58ced" id="r_a7e7514f26e11a67484fe42009bf58ced"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7e7514f26e11a67484fe42009bf58ced">png_decoder_poll</a> (void)</td></tr>
<tr class="memdesc:a7e7514f26e11a67484fe42009bf58ced"><td class="mdescLeft">&#160;</td><td class="mdescRight">Poll the PNG decoder to process the next row. <br /></td></tr>
<tr class="separator:a7e7514f26e11a67484fe42009bf58ced"><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>PNG Decoder component implementation. </p>
</div><hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structpng__decoder__t" id="structpng__decoder__t"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structpng__decoder__t">&#9670;&#160;</a></span>png_decoder_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct png_decoder_t</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>PNG File Information Structure. </p>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a id="a872f22369ce1fdfcdc993906e00dccc5" name="a872f22369ce1fdfcdc993906e00dccc5"></a>FILE *</td>
<td class="fieldname">
f</td>
<td class="fielddoc">
<p>File pointer </p>
</td></tr>
<tr><td class="fieldtype">
<a id="a1ab1a67fa8337e5f7baf15ef040bcc7b" name="a1ab1a67fa8337e5f7baf15ef040bcc7b"></a>spng_ctx *</td>
<td class="fieldname">
ctx</td>
<td class="fielddoc">
<p>SPNG context </p>
</td></tr>
<tr><td class="fieldtype">
<a id="ab8a6f3d443d45aca0e0af78572515c3b" name="ab8a6f3d443d45aca0e0af78572515c3b"></a>struct spng_ihdr</td>
<td class="fieldname">
ihdr</td>
<td class="fielddoc">
<p>SPNG image header </p>
</td></tr>
<tr><td class="fieldtype">
<a id="a66359531305e1c5de0a1f67c645ae2b4" name="a66359531305e1c5de0a1f67c645ae2b4"></a>surface_t *</td>
<td class="fieldname">
image</td>
<td class="fielddoc">
<p>Image surface </p>
</td></tr>
<tr><td class="fieldtype">
<a id="a3f450cf1ccd58023addfa257ca12a669" name="a3f450cf1ccd58023addfa257ca12a669"></a>uint8_t *</td>
<td class="fieldname">
row_buffer</td>
<td class="fielddoc">
<p>Row buffer </p>
</td></tr>
<tr><td class="fieldtype">
<a id="ad5632e8a4278d2319750d27da763b31d" name="ad5632e8a4278d2319750d27da763b31d"></a>int</td>
<td class="fieldname">
decoded_rows</td>
<td class="fielddoc">
<p>Number of decoded rows </p>
</td></tr>
<tr><td class="fieldtype">
<a id="aaa1fdc66deaede879381c4eeece24338" name="aaa1fdc66deaede879381c4eeece24338"></a><a class="el" href="png__decoder_8h.html#a85923de55a2f9fb330741fee267bb57b">png_callback_t</a> *</td>
<td class="fieldname">
callback</td>
<td class="fielddoc">
<p>Callback function </p>
</td></tr>
<tr><td class="fieldtype">
<a id="a301ae108fb70bc59fcd246d91ce1b17c" name="a301ae108fb70bc59fcd246d91ce1b17c"></a>void *</td>
<td class="fieldname">
callback_data</td>
<td class="fielddoc">
<p>Callback data </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a91b64bacdbc4945af5e10bc2171e95ed" name="a91b64bacdbc4945af5e10bc2171e95ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91b64bacdbc4945af5e10bc2171e95ed">&#9670;&#160;</a></span>png_decoder_start()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="png__decoder_8h.html#ac5fcb9a8ef757c913a1529c94c7436d4">png_err_t</a> png_decoder_start </td>
<td>(</td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>max_width</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>max_height</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="png__decoder_8h.html#a85923de55a2f9fb330741fee267bb57b">png_callback_t</a> *</td> <td class="paramname"><span class="paramname"><em>callback</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>callback_data</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Start decoding a PNG file. </p>
<p>Start the PNG decoding process.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>Path to the PNG file. </td></tr>
<tr><td class="paramname">max_width</td><td>Maximum width of the image. </td></tr>
<tr><td class="paramname">max_height</td><td>Maximum height of the image. </td></tr>
<tr><td class="paramname">callback</td><td>Callback function to be called upon completion. </td></tr>
<tr><td class="paramname">callback_data</td><td>Data to be passed to the callback function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>png_err_t Error code. </dd></dl>
</div>
</div>
<a id="ac38ee3f3c0d1efba8b698e52d3ed203f" name="ac38ee3f3c0d1efba8b698e52d3ed203f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac38ee3f3c0d1efba8b698e52d3ed203f">&#9670;&#160;</a></span>png_decoder_abort()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void png_decoder_abort </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>Abort the PNG decoding process. </p>
<p>This function aborts the ongoing PNG decoding process. </p>
</div>
</div>
<a id="a6b2ba820e7e2d9b49ba727b78beb6ac8" name="a6b2ba820e7e2d9b49ba727b78beb6ac8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b2ba820e7e2d9b49ba727b78beb6ac8">&#9670;&#160;</a></span>png_decoder_get_progress()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float png_decoder_get_progress </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>Get the progress of the PNG decoding process. </p>
<dl class="section return"><dt>Returns</dt><dd>float Progress as a percentage. </dd></dl>
</div>
</div>
<a id="a7e7514f26e11a67484fe42009bf58ced" name="a7e7514f26e11a67484fe42009bf58ced"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e7514f26e11a67484fe42009bf58ced">&#9670;&#160;</a></span>png_decoder_poll()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void png_decoder_poll </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>Poll the PNG decoder to process the next row. </p>
<p>Poll the PNG decoder. </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>