N64FlashcartMenu/png__decoder_8h.html
2025-01-25 00:07:05 +00:00

317 lines
17 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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>N64FlashcartMenu: png_decoder.h 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>
<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.9.8 -->
<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" 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');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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 class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">png_decoder.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>PNG decoder.
<a href="#details">More...</a></p>
<p><a href="png__decoder_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a85923de55a2f9fb330741fee267bb57b" id="r_a85923de55a2f9fb330741fee267bb57b"><td class="memItemLeft" align="right" valign="top">typedef void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="png__decoder_8h.html#a85923de55a2f9fb330741fee267bb57b">png_callback_t</a>(<a class="el" href="png__decoder_8h.html#ac5fcb9a8ef757c913a1529c94c7436d4">png_err_t</a> err, surface_t *decoded_image, void *callback_data)</td></tr>
<tr class="memdesc:a85923de55a2f9fb330741fee267bb57b"><td class="mdescLeft">&#160;</td><td class="mdescRight">PNG decoder callback type. <br /></td></tr>
<tr class="separator:a85923de55a2f9fb330741fee267bb57b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ac5fcb9a8ef757c913a1529c94c7436d4" id="r_ac5fcb9a8ef757c913a1529c94c7436d4"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="png__decoder_8h.html#ac5fcb9a8ef757c913a1529c94c7436d4">png_err_t</a> { <br />
&#160;&#160;<a class="el" href="png__decoder_8h.html#ac5fcb9a8ef757c913a1529c94c7436d4a4dd699113fbe010c8db17e53d985ee36">PNG_OK</a>
, <a class="el" href="png__decoder_8h.html#ac5fcb9a8ef757c913a1529c94c7436d4ab7dfe97b20a5d315ec4e50b34213b708">PNG_ERR_INT</a>
, <a class="el" href="png__decoder_8h.html#ac5fcb9a8ef757c913a1529c94c7436d4a78dfb25c1a327500e83544d2b60d80ff">PNG_ERR_BUSY</a>
, <a class="el" href="png__decoder_8h.html#ac5fcb9a8ef757c913a1529c94c7436d4ad5fedd800328fc1e25145b1f3a08b4a9">PNG_ERR_OUT_OF_MEM</a>
, <br />
&#160;&#160;<a class="el" href="png__decoder_8h.html#ac5fcb9a8ef757c913a1529c94c7436d4aa42dd20b6f2645d36a992e02f791f2d6">PNG_ERR_NO_FILE</a>
, <a class="el" href="png__decoder_8h.html#ac5fcb9a8ef757c913a1529c94c7436d4a096ebce23ce7b7e81e5bae7d218c36b1">PNG_ERR_BAD_FILE</a>
<br />
}</td></tr>
<tr class="memdesc:ac5fcb9a8ef757c913a1529c94c7436d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">PNG decoder errors. <a href="png__decoder_8h.html#ac5fcb9a8ef757c913a1529c94c7436d4">More...</a><br /></td></tr>
<tr class="separator:ac5fcb9a8ef757c913a1529c94c7436d4"><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="png__decoder_8h.html#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 the PNG decoding process. <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="png__decoder_8h.html#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="png__decoder_8h.html#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="png__decoder_8h.html#a7e7514f26e11a67484fe42009bf58ced">png_decoder_poll</a> (void)</td></tr>
<tr class="memdesc:a7e7514f26e11a67484fe42009bf58ced"><td class="mdescLeft">&#160;</td><td class="mdescRight">Poll the PNG decoder. <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. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a85923de55a2f9fb330741fee267bb57b" name="a85923de55a2f9fb330741fee267bb57b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85923de55a2f9fb330741fee267bb57b">&#9670;&#160;</a></span>png_callback_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void png_callback_t(<a class="el" href="png__decoder_8h.html#ac5fcb9a8ef757c913a1529c94c7436d4">png_err_t</a> err, surface_t *decoded_image, void *callback_data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>PNG decoder callback type. </p>
<p>This typedef defines the callback function type used by the PNG decoder.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">err</td><td>Error code indicating the result of the decoding process. </td></tr>
<tr><td class="paramname">decoded_image</td><td>Pointer to the decoded image surface. </td></tr>
<tr><td class="paramname">callback_data</td><td>User-defined data passed to the callback function. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ac5fcb9a8ef757c913a1529c94c7436d4" name="ac5fcb9a8ef757c913a1529c94c7436d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5fcb9a8ef757c913a1529c94c7436d4">&#9670;&#160;</a></span>png_err_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="png__decoder_8h.html#ac5fcb9a8ef757c913a1529c94c7436d4">png_err_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>PNG decoder errors. </p>
<p>Enumeration for different types of errors that can occur in the PNG decoder. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac5fcb9a8ef757c913a1529c94c7436d4a4dd699113fbe010c8db17e53d985ee36" name="ac5fcb9a8ef757c913a1529c94c7436d4a4dd699113fbe010c8db17e53d985ee36"></a>PNG_OK&#160;</td><td class="fielddoc"><p>No error </p>
</td></tr>
<tr><td class="fieldname"><a id="ac5fcb9a8ef757c913a1529c94c7436d4ab7dfe97b20a5d315ec4e50b34213b708" name="ac5fcb9a8ef757c913a1529c94c7436d4ab7dfe97b20a5d315ec4e50b34213b708"></a>PNG_ERR_INT&#160;</td><td class="fielddoc"><p>Internal error </p>
</td></tr>
<tr><td class="fieldname"><a id="ac5fcb9a8ef757c913a1529c94c7436d4a78dfb25c1a327500e83544d2b60d80ff" name="ac5fcb9a8ef757c913a1529c94c7436d4a78dfb25c1a327500e83544d2b60d80ff"></a>PNG_ERR_BUSY&#160;</td><td class="fielddoc"><p>Decoder is busy </p>
</td></tr>
<tr><td class="fieldname"><a id="ac5fcb9a8ef757c913a1529c94c7436d4ad5fedd800328fc1e25145b1f3a08b4a9" name="ac5fcb9a8ef757c913a1529c94c7436d4ad5fedd800328fc1e25145b1f3a08b4a9"></a>PNG_ERR_OUT_OF_MEM&#160;</td><td class="fielddoc"><p>Out of memory error </p>
</td></tr>
<tr><td class="fieldname"><a id="ac5fcb9a8ef757c913a1529c94c7436d4aa42dd20b6f2645d36a992e02f791f2d6" name="ac5fcb9a8ef757c913a1529c94c7436d4aa42dd20b6f2645d36a992e02f791f2d6"></a>PNG_ERR_NO_FILE&#160;</td><td class="fielddoc"><p>No file found error </p>
</td></tr>
<tr><td class="fieldname"><a id="ac5fcb9a8ef757c913a1529c94c7436d4a096ebce23ce7b7e81e5bae7d218c36b1" name="ac5fcb9a8ef757c913a1529c94c7436d4a096ebce23ce7b7e81e5bae7d218c36b1"></a>PNG_ERR_BAD_FILE&#160;</td><td class="fielddoc"><p>Bad file error </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 *&#160;</td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>max_width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>max_height</em>, </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> *&#160;</td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>callback_data</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start the PNG decoding process. </p>
<p>This function starts the PNG decoding process for the specified file.</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 decoded image. </td></tr>
<tr><td class="paramname">max_height</td><td>Maximum height of the decoded image. </td></tr>
<tr><td class="paramname">callback</td><td>Callback function to be called when decoding is complete. </td></tr>
<tr><td class="paramname">callback_data</td><td>User-defined 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 indicating the result of the start operation. </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&#160;</td>
<td class="paramname"></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&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the progress of the PNG decoding process. </p>
<p>This function returns the current progress of the PNG decoding process as a percentage.</p>
<dl class="section return"><dt>Returns</dt><dd>float Current progress of the decoding process (0.0 to 100.0). </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&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Poll the PNG decoder. </p>
<p>This function polls the PNG decoder to handle any ongoing decoding tasks. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 25 2025 00:07:04 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.9.8
</small></address>
</body>
</html>