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

165 lines
20 KiB
HTML
Raw 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/capsdc.h Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @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_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="headertitle"><div class="title">capsdc.h</div></div>
</div><!--header-->
<div class="contents">
<a href="capsdc_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/**</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * @file capsdc.h</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief Jpeg Decoder (caps:dc) service IPC wrapper. Only available on [4.0.0+].</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * @note Only holds one session that is occupied by capsrv.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * @author Behemoth</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * @copyright libnx Authors</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> */</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;../types.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &quot;../sf/service.h&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &quot;../services/caps.h&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"></span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">/// Initialize caps:dc</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="capsdc_8h.html#a0f97021d49904957b54b306c38497083"> 14</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="capsdc_8h.html#a0f97021d49904957b54b306c38497083">capsdcInitialize</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"></span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">/// Exit caps:dc.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="capsdc_8h.html#a9350a23c830b43f07882d2fa194e8154"> 17</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="capsdc_8h.html#a9350a23c830b43f07882d2fa194e8154">capsdcExit</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"></span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">/// Gets the Service for caps:dc.</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="capsdc_8h.html#a48a3eb960456850f8ec4435c78d17654"> 20</a></span><span class="comment"></span><a class="code hl_struct" href="structService.html">Service</a>* <a class="code hl_function" href="capsdc_8h.html#a48a3eb960456850f8ec4435c78d17654">capsdcGetServiceSession</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment"></span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment">/**</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> * @brief Decodes a jpeg buffer into RGBX.</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment"> * @param[in] width Image width.</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> * @param[in] height Image height.</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment"> * @param[in] opts \ref CapsScreenShotDecodeOption.</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment"> * @param[in] jpeg Jpeg image input buffer.</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment"> * @param[in] jpeg_size Input image buffer size.</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"> * @param[out] out_image RGBA8 image output buffer.</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment"> * @param[in] out_image_size Output image buffer size, should be at least large enough for RGBA8 width x height.</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"> */</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="capsdc_8h.html#a68b95b8dbbdd845cbe78faf55f65155c"> 32</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="capsdc_8h.html#a68b95b8dbbdd845cbe78faf55f65155c">capsdcDecodeJpeg</a>(<a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> width, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> height, <span class="keyword">const</span> <a class="code hl_struct" href="structCapsScreenShotDecodeOption.html">CapsScreenShotDecodeOption</a> *opts, <span class="keyword">const</span> <span class="keywordtype">void</span>* jpeg, <span class="keywordtype">size_t</span> jpeg_size, <span class="keywordtype">void</span>* out_image, <span class="keywordtype">size_t</span> out_image_size);</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"></span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment">/**</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment"> * @brief Shrinks a jpeg&#39;s dimensions by 2.</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment"> * @note Tries to compress with jpeg quality in this order: 98, 95, 90, 80, 70, 60, 50, 40, 30, 20, 10, 0.</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment"> * @note Only available on [17.0.0+].</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment"> * @param[in] width Input image width.</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> * @param[in] height Input image width.</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment"> * @param[in] opts \ref CapsScreenShotDecodeOption.</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"> * @param[in] jpeg Jpeg image input buffer.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"> * @param[in] jpeg_size Input image buffer size.</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment"> * @param[out] out_jpeg Jpeg image output buffer</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment"> * @param[in] out_jpeg_size Output image buffer size.</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment"> * @param[out] out_result_size size of the resulting JPEG.</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment"> */</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="capsdc_8h.html#ab854192490a8ad0b77387010f7af7249"> 47</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="capsdc_8h.html#ab854192490a8ad0b77387010f7af7249">capsdcShrinkJpeg</a>(<a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> width, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> height, <span class="keyword">const</span> <a class="code hl_struct" href="structCapsScreenShotDecodeOption.html">CapsScreenShotDecodeOption</a> *opts, <span class="keyword">const</span> <span class="keywordtype">void</span>* jpeg, <span class="keywordtype">size_t</span> jpeg_size, <span class="keywordtype">void</span>* out_jpeg, <span class="keywordtype">size_t</span> out_jpeg_size, <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *out_result_size);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"></span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment">/**</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment"> * @brief Shrinks a jpeg.</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment"> * @note Fails if the scaled size is larger than the original or the output buffer isn&#39;t large enough.</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment"> * @note Only available on [19.0.0+].</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment"> * @param[in] scaled_width Wanted image width.</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment"> * @param[in] scaled_height Wanted image width.</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment"> * @param[in] jpeg_quality has to be in range 0-100.</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment"> * @param[in] opts \ref CapsScreenShotDecodeOption.</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="comment"> * @param[in] jpeg Jpeg image input buffer.</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment"> * @param[in] jpeg_size Input image buffer size.</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="comment"> * @param[out] out_jpeg Jpeg image output buffer</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment"> * @param[in] out_jpeg_size Output image buffer size.</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment"> * @param[out] out_result_size size of the resulting jpeg.</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment"> */</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="capsdc_8h.html#a853e5077e850192d33091ca26721c5de"> 63</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="capsdc_8h.html#a853e5077e850192d33091ca26721c5de">capsdcShrinkJpegEx</a>(<a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> scaled_width, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> scaled_height, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> jpeg_quality, <span class="keyword">const</span> <a class="code hl_struct" href="structCapsScreenShotDecodeOption.html">CapsScreenShotDecodeOption</a> *opts, <span class="keyword">const</span> <span class="keywordtype">void</span>* jpeg, <span class="keywordtype">size_t</span> jpeg_size, <span class="keywordtype">void</span>* out_jpeg, <span class="keywordtype">size_t</span> out_jpeg_size, <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *out_result_size);</div>
<div class="ttc" id="acapsdc_8h_html_a0f97021d49904957b54b306c38497083"><div class="ttname"><a href="capsdc_8h.html#a0f97021d49904957b54b306c38497083">capsdcInitialize</a></div><div class="ttdeci">Result capsdcInitialize(void)</div><div class="ttdoc">Initialize caps:dc.</div></div>
<div class="ttc" id="acapsdc_8h_html_a48a3eb960456850f8ec4435c78d17654"><div class="ttname"><a href="capsdc_8h.html#a48a3eb960456850f8ec4435c78d17654">capsdcGetServiceSession</a></div><div class="ttdeci">Service * capsdcGetServiceSession(void)</div><div class="ttdoc">Gets the Service for caps:dc.</div></div>
<div class="ttc" id="acapsdc_8h_html_a68b95b8dbbdd845cbe78faf55f65155c"><div class="ttname"><a href="capsdc_8h.html#a68b95b8dbbdd845cbe78faf55f65155c">capsdcDecodeJpeg</a></div><div class="ttdeci">Result capsdcDecodeJpeg(u32 width, u32 height, const CapsScreenShotDecodeOption *opts, const void *jpeg, size_t jpeg_size, void *out_image, size_t out_image_size)</div><div class="ttdoc">Decodes a jpeg buffer into RGBX.</div></div>
<div class="ttc" id="acapsdc_8h_html_a853e5077e850192d33091ca26721c5de"><div class="ttname"><a href="capsdc_8h.html#a853e5077e850192d33091ca26721c5de">capsdcShrinkJpegEx</a></div><div class="ttdeci">Result capsdcShrinkJpegEx(u32 scaled_width, u32 scaled_height, u32 jpeg_quality, const CapsScreenShotDecodeOption *opts, const void *jpeg, size_t jpeg_size, void *out_jpeg, size_t out_jpeg_size, u64 *out_result_size)</div><div class="ttdoc">Shrinks a jpeg.</div></div>
<div class="ttc" id="acapsdc_8h_html_a9350a23c830b43f07882d2fa194e8154"><div class="ttname"><a href="capsdc_8h.html#a9350a23c830b43f07882d2fa194e8154">capsdcExit</a></div><div class="ttdeci">void capsdcExit(void)</div><div class="ttdoc">Exit caps:dc.</div></div>
<div class="ttc" id="acapsdc_8h_html_ab854192490a8ad0b77387010f7af7249"><div class="ttname"><a href="capsdc_8h.html#ab854192490a8ad0b77387010f7af7249">capsdcShrinkJpeg</a></div><div class="ttdeci">Result capsdcShrinkJpeg(u32 width, u32 height, const CapsScreenShotDecodeOption *opts, const void *jpeg, size_t jpeg_size, void *out_jpeg, size_t out_jpeg_size, u64 *out_result_size)</div><div class="ttdoc">Shrinks a jpeg's dimensions by 2.</div></div>
<div class="ttc" id="astructCapsScreenShotDecodeOption_html"><div class="ttname"><a href="structCapsScreenShotDecodeOption.html">CapsScreenShotDecodeOption</a></div><div class="ttdoc">ScreenShotDecodeOption.</div><div class="ttdef"><b>Definition</b> caps.h:74</div></div>
<div class="ttc" id="astructService_html"><div class="ttname"><a href="structService.html">Service</a></div><div class="ttdoc">Service object structure.</div><div class="ttdef"><b>Definition</b> service.h:14</div></div>
<div class="ttc" id="atypes_8h_html_a3f7e2bcbb0b4c338f3c4f6c937cd4234"><div class="ttname"><a href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a></div><div class="ttdeci">uint64_t u64</div><div class="ttdoc">64-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:22</div></div>
<div class="ttc" id="atypes_8h_html_ad1be2721625a17f1be47fac918032afe"><div class="ttname"><a href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a></div><div class="ttdeci">u32 Result</div><div class="ttdoc">Function error code result type.</div><div class="ttdef"><b>Definition</b> types.h:44</div></div>
<div class="ttc" id="atypes_8h_html_afaa62991928fb9fb18ff0db62a040aba"><div class="ttname"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a></div><div class="ttdeci">uint32_t u32</div><div class="ttdoc">32-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:21</div></div>
</div><!-- fragment --></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