libnx/pl_8h.html
2025-05-08 06:59:12 +00:00

236 lines
16 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>libnx: include/switch/services/pl.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="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">pl.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>pl:u 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 />
</div>
<p><a href="pl_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="structPlFontData.html">PlFontData</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">FontData. <a href="structPlFontData.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="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a723f1be7c4ef6b95e6d0de8d10228cbc" id="r_a723f1be7c4ef6b95e6d0de8d10228cbc"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pl_8h.html#a723f1be7c4ef6b95e6d0de8d10228cbc">PlServiceType</a> { <br />
&#160;&#160;<a class="el" href="pl_8h.html#a723f1be7c4ef6b95e6d0de8d10228cbca8e482073100bd0320adfcdf1b15d1e05">PlServiceType_User</a> = 0
, <br />
&#160;&#160;<a class="el" href="pl_8h.html#a723f1be7c4ef6b95e6d0de8d10228cbcaf7f37ac41d0d2e99155f7aec09f7f48f">PlServiceType_System</a> = 1
<br />
}</td></tr>
<tr class="separator:a723f1be7c4ef6b95e6d0de8d10228cbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affc844358c0fe823ec5e33aa9d7be0fc" id="r_affc844358c0fe823ec5e33aa9d7be0fc"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pl_8h.html#affc844358c0fe823ec5e33aa9d7be0fc">PlSharedFontType</a> { <br />
&#160;&#160;<a class="el" href="pl_8h.html#affc844358c0fe823ec5e33aa9d7be0fcad43299015f2321d19124d857ccef0cac">PlSharedFontType_Standard</a> = 0
, <br />
&#160;&#160;<a class="el" href="pl_8h.html#affc844358c0fe823ec5e33aa9d7be0fca6b00d4a62e54606f79f472122ae6c188">PlSharedFontType_ChineseSimplified</a> = 1
, <br />
&#160;&#160;<a class="el" href="pl_8h.html#affc844358c0fe823ec5e33aa9d7be0fca5ec54c8e681d6661edfdebc37ddb44e3">PlSharedFontType_ExtChineseSimplified</a> = 2
, <br />
&#160;&#160;<a class="el" href="pl_8h.html#affc844358c0fe823ec5e33aa9d7be0fca992b41fce0cb786418df101ef1776cec">PlSharedFontType_ChineseTraditional</a> = 3
, <br />
&#160;&#160;<a class="el" href="pl_8h.html#affc844358c0fe823ec5e33aa9d7be0fcaa47e2427f06ef603c4ec0d44a9f37942">PlSharedFontType_KO</a> = 4
, <br />
&#160;&#160;<a class="el" href="pl_8h.html#affc844358c0fe823ec5e33aa9d7be0fca685b499652ae49284eddbfb84a52b0a6">PlSharedFontType_NintendoExt</a> = 5
, <br />
&#160;&#160;<a class="el" href="pl_8h.html#affc844358c0fe823ec5e33aa9d7be0fca0dd46492b85e31b2441953509c5b2966">PlSharedFontType_Total</a>
<br />
}</td></tr>
<tr class="memdesc:affc844358c0fe823ec5e33aa9d7be0fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">SharedFontType. <a href="pl_8h.html#affc844358c0fe823ec5e33aa9d7be0fc">More...</a><br /></td></tr>
<tr class="separator:affc844358c0fe823ec5e33aa9d7be0fc"><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:ac2e26bb6e2d5b63a8adf9ebd71a3b000" id="r_ac2e26bb6e2d5b63a8adf9ebd71a3b000"><td class="memItemLeft" align="right" valign="top"><a id="ac2e26bb6e2d5b63a8adf9ebd71a3b000" name="ac2e26bb6e2d5b63a8adf9ebd71a3b000"></a>
<a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><b>plInitialize</b> (<a class="el" href="pl_8h.html#a723f1be7c4ef6b95e6d0de8d10228cbc">PlServiceType</a> service_type)</td></tr>
<tr class="memdesc:ac2e26bb6e2d5b63a8adf9ebd71a3b000"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize pl. <br /></td></tr>
<tr class="separator:ac2e26bb6e2d5b63a8adf9ebd71a3b000"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2498b7ba67bcfca9bb3255ed246a11d4" id="r_a2498b7ba67bcfca9bb3255ed246a11d4"><td class="memItemLeft" align="right" valign="top"><a id="a2498b7ba67bcfca9bb3255ed246a11d4" name="a2498b7ba67bcfca9bb3255ed246a11d4"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>plExit</b> (void)</td></tr>
<tr class="memdesc:a2498b7ba67bcfca9bb3255ed246a11d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exit pl. <br /></td></tr>
<tr class="separator:a2498b7ba67bcfca9bb3255ed246a11d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7516beeb231c9c8e90cfbd6d386cfb6" id="r_aa7516beeb231c9c8e90cfbd6d386cfb6"><td class="memItemLeft" align="right" valign="top"><a id="aa7516beeb231c9c8e90cfbd6d386cfb6" name="aa7516beeb231c9c8e90cfbd6d386cfb6"></a>
<a class="el" href="structService.html">Service</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>plGetServiceSession</b> (void)</td></tr>
<tr class="memdesc:aa7516beeb231c9c8e90cfbd6d386cfb6"><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 pl service session. <br /></td></tr>
<tr class="separator:aa7516beeb231c9c8e90cfbd6d386cfb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a068790719c06956e342dab74a92ca163" id="r_a068790719c06956e342dab74a92ca163"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pl_8h.html#a068790719c06956e342dab74a92ca163">plGetSharedmemAddr</a> (void)</td></tr>
<tr class="memdesc:a068790719c06956e342dab74a92ca163"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the address of the <a class="el" href="structSharedMemory.html" title="Shared memory information structure.">SharedMemory</a>. <br /></td></tr>
<tr class="separator:a068790719c06956e342dab74a92ca163"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d6a8b1c51ec3e010be83713a02c9330" id="r_a4d6a8b1c51ec3e010be83713a02c9330"><td class="memItemLeft" align="right" valign="top"><a id="a4d6a8b1c51ec3e010be83713a02c9330" name="a4d6a8b1c51ec3e010be83713a02c9330"></a>
<a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><b>plGetSharedFontByType</b> (<a class="el" href="structPlFontData.html">PlFontData</a> *font, <a class="el" href="pl_8h.html#affc844358c0fe823ec5e33aa9d7be0fc">PlSharedFontType</a> SharedFontType)</td></tr>
<tr class="memdesc:a4d6a8b1c51ec3e010be83713a02c9330"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets shared font(s). <br /></td></tr>
<tr class="separator:a4d6a8b1c51ec3e010be83713a02c9330"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad21b1ef78b73c7e426f4512711525d0c" id="r_ad21b1ef78b73c7e426f4512711525d0c"><td class="memItemLeft" align="right" valign="top"><a id="ad21b1ef78b73c7e426f4512711525d0c" name="ad21b1ef78b73c7e426f4512711525d0c"></a>
<a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><b>plGetSharedFont</b> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> LanguageCode, <a class="el" href="structPlFontData.html">PlFontData</a> *fonts, <a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> max_fonts, <a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> *total_fonts)</td></tr>
<tr class="separator:ad21b1ef78b73c7e426f4512711525d0c"><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>pl:u service IPC wrapper. </p>
<dl class="section author"><dt>Author</dt><dd>yellows8 </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>libnx Authors </dd></dl>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a723f1be7c4ef6b95e6d0de8d10228cbc" name="a723f1be7c4ef6b95e6d0de8d10228cbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a723f1be7c4ef6b95e6d0de8d10228cbc">&#9670;&#160;</a></span>PlServiceType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="pl_8h.html#a723f1be7c4ef6b95e6d0de8d10228cbc">PlServiceType</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a723f1be7c4ef6b95e6d0de8d10228cbca8e482073100bd0320adfcdf1b15d1e05" name="a723f1be7c4ef6b95e6d0de8d10228cbca8e482073100bd0320adfcdf1b15d1e05"></a>PlServiceType_User&#160;</td><td class="fielddoc"><p>Initializes pl:u. </p>
</td></tr>
<tr><td class="fieldname"><a id="a723f1be7c4ef6b95e6d0de8d10228cbcaf7f37ac41d0d2e99155f7aec09f7f48f" name="a723f1be7c4ef6b95e6d0de8d10228cbcaf7f37ac41d0d2e99155f7aec09f7f48f"></a>PlServiceType_System&#160;</td><td class="fielddoc"><p>Initializes pl:s. With [16.0.0+] SharedFont is no longer available with this, pl:u must be used for that. </p>
</td></tr>
</table>
</div>
</div>
<a id="affc844358c0fe823ec5e33aa9d7be0fc" name="affc844358c0fe823ec5e33aa9d7be0fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affc844358c0fe823ec5e33aa9d7be0fc">&#9670;&#160;</a></span>PlSharedFontType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="pl_8h.html#affc844358c0fe823ec5e33aa9d7be0fc">PlSharedFontType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>SharedFontType. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="affc844358c0fe823ec5e33aa9d7be0fcad43299015f2321d19124d857ccef0cac" name="affc844358c0fe823ec5e33aa9d7be0fcad43299015f2321d19124d857ccef0cac"></a>PlSharedFontType_Standard&#160;</td><td class="fielddoc"><p>Japan, US and Europe. </p>
</td></tr>
<tr><td class="fieldname"><a id="affc844358c0fe823ec5e33aa9d7be0fca6b00d4a62e54606f79f472122ae6c188" name="affc844358c0fe823ec5e33aa9d7be0fca6b00d4a62e54606f79f472122ae6c188"></a>PlSharedFontType_ChineseSimplified&#160;</td><td class="fielddoc"><p>Chinese Simplified. </p>
</td></tr>
<tr><td class="fieldname"><a id="affc844358c0fe823ec5e33aa9d7be0fca5ec54c8e681d6661edfdebc37ddb44e3" name="affc844358c0fe823ec5e33aa9d7be0fca5ec54c8e681d6661edfdebc37ddb44e3"></a>PlSharedFontType_ExtChineseSimplified&#160;</td><td class="fielddoc"><p>Extended Chinese Simplified. </p>
</td></tr>
<tr><td class="fieldname"><a id="affc844358c0fe823ec5e33aa9d7be0fca992b41fce0cb786418df101ef1776cec" name="affc844358c0fe823ec5e33aa9d7be0fca992b41fce0cb786418df101ef1776cec"></a>PlSharedFontType_ChineseTraditional&#160;</td><td class="fielddoc"><p>Chinese Traditional. </p>
</td></tr>
<tr><td class="fieldname"><a id="affc844358c0fe823ec5e33aa9d7be0fcaa47e2427f06ef603c4ec0d44a9f37942" name="affc844358c0fe823ec5e33aa9d7be0fcaa47e2427f06ef603c4ec0d44a9f37942"></a>PlSharedFontType_KO&#160;</td><td class="fielddoc"><p>Korean (Hangul) </p>
</td></tr>
<tr><td class="fieldname"><a id="affc844358c0fe823ec5e33aa9d7be0fca685b499652ae49284eddbfb84a52b0a6" name="affc844358c0fe823ec5e33aa9d7be0fca685b499652ae49284eddbfb84a52b0a6"></a>PlSharedFontType_NintendoExt&#160;</td><td class="fielddoc"><p>Nintendo Extended. This font only has the special Nintendo-specific characters, which aren't available with the other fonts. </p>
</td></tr>
<tr><td class="fieldname"><a id="affc844358c0fe823ec5e33aa9d7be0fca0dd46492b85e31b2441953509c5b2966" name="affc844358c0fe823ec5e33aa9d7be0fca0dd46492b85e31b2441953509c5b2966"></a>PlSharedFontType_Total&#160;</td><td class="fielddoc"><p>Total fonts supported by this enum. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a068790719c06956e342dab74a92ca163" name="a068790719c06956e342dab74a92ca163"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a068790719c06956e342dab74a92ca163">&#9670;&#160;</a></span>plGetSharedmemAddr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * plGetSharedmemAddr </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the address of the <a class="el" href="structSharedMemory.html" title="Shared memory information structure.">SharedMemory</a>. </p>
<p>Gets a specific shared-font via <a class="el" href="pl_8h.html#affc844358c0fe823ec5e33aa9d7be0fc">PlSharedFontType</a>. </p>
</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>