mika/libnx
1
0
Fork 0
mirror of https://github.com/switchbrew/libnx.git synced 2025-06-21 12:32:40 +02:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
libnx/miiimg_8h.html
WinterMute bf00061749 Deploying to gh-pages from @ 29f6f4fa7a 🚀
2025-05-08 06:59:12 +00:00

306 lines
18 KiB
HTML
Raw Permalink Blame History

<!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>libnx: include/switch/services/miiimg.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">libnx<span id="projectnumber">&#160;v4.9.0</span>
</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_04a7e0b94d44ce4fc7ca3462163fd33c.html">services</a></li> </ul>
</div>
</div><!-- top -->
<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">miiimg.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Mii image (miiimg) service IPC wrapper.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="types_8h_source.html">../types.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="service_8h_source.html">../sf/service.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="mii_8h_source.html">../services/mii.h</a>&quot;</code><br />
</div>
<p><a href="miiimg_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="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMiiimgImageId.html">MiiimgImageId</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Image ID. <a href="structMiiimgImageId.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMiiimgImageAttribute.html">MiiimgImageAttribute</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Image attribute. <a href="structMiiimgImageAttribute.html#details">More...</a><br /></td></tr>
<tr class="separator:"><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:a4a975c05bbc3f995e5873fc64363fc83" id="r_a4a975c05bbc3f995e5873fc64363fc83"><td class="memItemLeft" align="right" valign="top"><a id="a4a975c05bbc3f995e5873fc64363fc83" name="a4a975c05bbc3f995e5873fc64363fc83"></a>
<a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><b>miiimgInitialize</b> (void)</td></tr>
<tr class="memdesc:a4a975c05bbc3f995e5873fc64363fc83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize miiimg. <br /></td></tr>
<tr class="separator:a4a975c05bbc3f995e5873fc64363fc83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5aceb3d4956a1c77f1e3ea0d888d9c08" id="r_a5aceb3d4956a1c77f1e3ea0d888d9c08"><td class="memItemLeft" align="right" valign="top"><a id="a5aceb3d4956a1c77f1e3ea0d888d9c08" name="a5aceb3d4956a1c77f1e3ea0d888d9c08"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>miiimgExit</b> (void)</td></tr>
<tr class="memdesc:a5aceb3d4956a1c77f1e3ea0d888d9c08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exit miiimg. <br /></td></tr>
<tr class="separator:a5aceb3d4956a1c77f1e3ea0d888d9c08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b743090cf6853cdc7dc500e89e74e02" id="r_a2b743090cf6853cdc7dc500e89e74e02"><td class="memItemLeft" align="right" valign="top"><a id="a2b743090cf6853cdc7dc500e89e74e02" name="a2b743090cf6853cdc7dc500e89e74e02"></a>
<a class="el" href="structService.html">Service</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>miiimgGetServiceSession</b> (void)</td></tr>
<tr class="memdesc:a2b743090cf6853cdc7dc500e89e74e02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the <a class="el" href="structService.html" title="Service object structure.">Service</a> object for the actual miiimg service session. <br /></td></tr>
<tr class="separator:a2b743090cf6853cdc7dc500e89e74e02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24935f2117feefd06ce1ae77db9da2dc" id="r_a24935f2117feefd06ce1ae77db9da2dc"><td class="memItemLeft" align="right" valign="top"><a id="a24935f2117feefd06ce1ae77db9da2dc" name="a24935f2117feefd06ce1ae77db9da2dc"></a>
<a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><b>miiimgReload</b> (void)</td></tr>
<tr class="memdesc:a24935f2117feefd06ce1ae77db9da2dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reloads the image database. <br /></td></tr>
<tr class="separator:a24935f2117feefd06ce1ae77db9da2dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9750aaa16f2eb1925afb1f263097deb" id="r_ad9750aaa16f2eb1925afb1f263097deb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="miiimg_8h.html#ad9750aaa16f2eb1925afb1f263097deb">miiimgGetCount</a> (<a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> *out_count)</td></tr>
<tr class="memdesc:ad9750aaa16f2eb1925afb1f263097deb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the number of mii images in the database. <br /></td></tr>
<tr class="separator:ad9750aaa16f2eb1925afb1f263097deb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a818b1a9fbfac7060ac0499dd06ba377f" id="r_a818b1a9fbfac7060ac0499dd06ba377f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="miiimg_8h.html#a818b1a9fbfac7060ac0499dd06ba377f">miiimgIsEmpty</a> (bool *out_empty)</td></tr>
<tr class="memdesc:a818b1a9fbfac7060ac0499dd06ba377f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets whether the image database is empty. <br /></td></tr>
<tr class="separator:a818b1a9fbfac7060ac0499dd06ba377f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a380fbd5ef8249016fddaa57c6402b3f0" id="r_a380fbd5ef8249016fddaa57c6402b3f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="miiimg_8h.html#a380fbd5ef8249016fddaa57c6402b3f0">miiimgIsFull</a> (bool *out_full)</td></tr>
<tr class="memdesc:a380fbd5ef8249016fddaa57c6402b3f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets whether the image database is full. <br /></td></tr>
<tr class="separator:a380fbd5ef8249016fddaa57c6402b3f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90e9f2f5b8f17d0676b10c8b9fd07080" id="r_a90e9f2f5b8f17d0676b10c8b9fd07080"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="miiimg_8h.html#a90e9f2f5b8f17d0676b10c8b9fd07080">miiimgGetAttribute</a> (<a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> index, <a class="el" href="structMiiimgImageAttribute.html">MiiimgImageAttribute</a> *out_attr)</td></tr>
<tr class="memdesc:a90e9f2f5b8f17d0676b10c8b9fd07080"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the image attribute for the specified image index. <br /></td></tr>
<tr class="separator:a90e9f2f5b8f17d0676b10c8b9fd07080"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a603b8a4907f1164d404f6313feced7e7" id="r_a603b8a4907f1164d404f6313feced7e7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="miiimg_8h.html#a603b8a4907f1164d404f6313feced7e7">miiimgLoadImage</a> (<a class="el" href="structMiiimgImageId.html">MiiimgImageId</a> id, void *out_image, size_t out_image_size)</td></tr>
<tr class="memdesc:a603b8a4907f1164d404f6313feced7e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads the image data (raw RGBA8) for the specified image ID. <br /></td></tr>
<tr class="separator:a603b8a4907f1164d404f6313feced7e7"><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>Mii image (miiimg) service IPC wrapper. </p>
<dl class="section author"><dt>Author</dt><dd>XorTroll </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>libnx Authors </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a90e9f2f5b8f17d0676b10c8b9fd07080" name="a90e9f2f5b8f17d0676b10c8b9fd07080"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90e9f2f5b8f17d0676b10c8b9fd07080">&#9670;&#160;</a></span>miiimgGetAttribute()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> miiimgGetAttribute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a>&#160;</td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structMiiimgImageAttribute.html">MiiimgImageAttribute</a> *&#160;</td>
<td class="paramname"><em>out_attr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the image attribute for the specified image index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Image index. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out_attr</td><td>Out image attribute. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad9750aaa16f2eb1925afb1f263097deb" name="ad9750aaa16f2eb1925afb1f263097deb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9750aaa16f2eb1925afb1f263097deb">&#9670;&#160;</a></span>miiimgGetCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> miiimgGetCount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> *&#160;</td>
<td class="paramname"><em>out_count</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the number of mii images in the database. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">out_count</td><td>Mii image count. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a818b1a9fbfac7060ac0499dd06ba377f" name="a818b1a9fbfac7060ac0499dd06ba377f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a818b1a9fbfac7060ac0499dd06ba377f">&#9670;&#160;</a></span>miiimgIsEmpty()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> miiimgIsEmpty </td>
<td>(</td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>out_empty</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets whether the image database is empty. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">out_empty</td><td>Whether the database is empty. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a380fbd5ef8249016fddaa57c6402b3f0" name="a380fbd5ef8249016fddaa57c6402b3f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a380fbd5ef8249016fddaa57c6402b3f0">&#9670;&#160;</a></span>miiimgIsFull()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> miiimgIsFull </td>
<td>(</td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>out_full</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets whether the image database is full. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">out_empty</td><td>Whether the database is full. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a603b8a4907f1164d404f6313feced7e7" name="a603b8a4907f1164d404f6313feced7e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a603b8a4907f1164d404f6313feced7e7">&#9670;&#160;</a></span>miiimgLoadImage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> miiimgLoadImage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structMiiimgImageId.html">MiiimgImageId</a>&#160;</td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>out_image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>out_image_size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads the image data (raw RGBA8) for the specified image ID. </p>
<dl class="section note"><dt>Note</dt><dd>Server doesn't seem to check the image buffer size, but 0x40000 is the optimal size. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>Input image ID. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out_image</td><td>Out iamge buffer. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">out_image_size</td><td>Out image buffer size. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated 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>
Reference in New Issue View Git Blame Copy Permalink