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/capssc_8h.html
WinterMute bf00061749 Deploying to gh-pages from @ 29f6f4fa7a 🚀
2025-05-08 06:59:12 +00:00

412 lines
24 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/capssc.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="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">capssc.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Screenshot control (caps:sc) 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="vi_8h_source.html">vi.h</a>&quot;</code><br />
</div>
<p><a href="capssc_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="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a3e12dbf2d395b79290902e6b06dc7611" id="r_a3e12dbf2d395b79290902e6b06dc7611"><td class="memItemLeft" align="right" valign="top"><a id="a3e12dbf2d395b79290902e6b06dc7611" name="a3e12dbf2d395b79290902e6b06dc7611"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CAPSSC_JPEG_BUFFER_SIZE</b>&#160;&#160;&#160;0x80000</td></tr>
<tr class="separator:a3e12dbf2d395b79290902e6b06dc7611"><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:acee9b4b13c7126b2d3bb1ddc0c43b75c" id="r_acee9b4b13c7126b2d3bb1ddc0c43b75c"><td class="memItemLeft" align="right" valign="top"><a id="acee9b4b13c7126b2d3bb1ddc0c43b75c" name="acee9b4b13c7126b2d3bb1ddc0c43b75c"></a>
<a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><b>capsscInitialize</b> (void)</td></tr>
<tr class="memdesc:acee9b4b13c7126b2d3bb1ddc0c43b75c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize caps:sc. Only available on [2.0.0+]. <br /></td></tr>
<tr class="separator:acee9b4b13c7126b2d3bb1ddc0c43b75c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abffad196bc1791b1c9b0a49eda5512ba" id="r_abffad196bc1791b1c9b0a49eda5512ba"><td class="memItemLeft" align="right" valign="top"><a id="abffad196bc1791b1c9b0a49eda5512ba" name="abffad196bc1791b1c9b0a49eda5512ba"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>capsscExit</b> (void)</td></tr>
<tr class="memdesc:abffad196bc1791b1c9b0a49eda5512ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exit caps:sc. <br /></td></tr>
<tr class="separator:abffad196bc1791b1c9b0a49eda5512ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a978ec8fd59e57769a13c70d9062c4e6b" id="r_a978ec8fd59e57769a13c70d9062c4e6b"><td class="memItemLeft" align="right" valign="top"><a id="a978ec8fd59e57769a13c70d9062c4e6b" name="a978ec8fd59e57769a13c70d9062c4e6b"></a>
<a class="el" href="structService.html">Service</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>capsscGetServiceSession</b> (void)</td></tr>
<tr class="memdesc:a978ec8fd59e57769a13c70d9062c4e6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the <a class="el" href="structService.html" title="Service object structure.">Service</a> for caps:sc. <br /></td></tr>
<tr class="separator:a978ec8fd59e57769a13c70d9062c4e6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7a5886a35dbd2278dd1cec4acaa7a60" id="r_aa7a5886a35dbd2278dd1cec4acaa7a60"><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="capssc_8h.html#aa7a5886a35dbd2278dd1cec4acaa7a60">capsscCaptureRawImageWithTimeout</a> (void *buf, size_t size, <a class="el" href="vi_8h.html#ad4375d33184b31fcb91ab0913d66ce45">ViLayerStack</a> layer_stack, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> width, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> height, <a class="el" href="types_8h.html#a350c6fc928e3bdc6c6486268ac8fb269">s64</a> buffer_count, <a class="el" href="types_8h.html#a350c6fc928e3bdc6c6486268ac8fb269">s64</a> buffer_index, <a class="el" href="types_8h.html#a350c6fc928e3bdc6c6486268ac8fb269">s64</a> timeout)</td></tr>
<tr class="memdesc:aa7a5886a35dbd2278dd1cec4acaa7a60"><td class="mdescLeft">&#160;</td><td class="mdescRight">This takes a screenshot, with the screenshot being written into the output buffer. <br /></td></tr>
<tr class="separator:aa7a5886a35dbd2278dd1cec4acaa7a60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00540bd8514db27fc12b624a1425fdad" id="r_a00540bd8514db27fc12b624a1425fdad"><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="capssc_8h.html#a00540bd8514db27fc12b624a1425fdad">capsscOpenRawScreenShotReadStream</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *out_size, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *out_width, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *out_height, <a class="el" href="vi_8h.html#ad4375d33184b31fcb91ab0913d66ce45">ViLayerStack</a> layer_stack, <a class="el" href="types_8h.html#a350c6fc928e3bdc6c6486268ac8fb269">s64</a> timeout)</td></tr>
<tr class="memdesc:a00540bd8514db27fc12b624a1425fdad"><td class="mdescLeft">&#160;</td><td class="mdescRight">This takes a raw screenshot, with the screenshot being held until <a class="el" href="capssc_8h.html#a20387ad9ec148dcb0cbbc644044f69b5">capsscCloseRawScreenShotReadStream</a> is called. <br /></td></tr>
<tr class="separator:a00540bd8514db27fc12b624a1425fdad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20387ad9ec148dcb0cbbc644044f69b5" id="r_a20387ad9ec148dcb0cbbc644044f69b5"><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="capssc_8h.html#a20387ad9ec148dcb0cbbc644044f69b5">capsscCloseRawScreenShotReadStream</a> (void)</td></tr>
<tr class="memdesc:a20387ad9ec148dcb0cbbc644044f69b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Discards a stream opened by <a class="el" href="capssc_8h.html#a00540bd8514db27fc12b624a1425fdad">capsscOpenRawScreenShotReadStream</a>. <br /></td></tr>
<tr class="separator:a20387ad9ec148dcb0cbbc644044f69b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d74ac92822bd304f6b616c879822872" id="r_a7d74ac92822bd304f6b616c879822872"><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="capssc_8h.html#a7d74ac92822bd304f6b616c879822872">capsscReadRawScreenShotReadStream</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *bytes_read, void *buf, size_t size, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> offset)</td></tr>
<tr class="memdesc:a7d74ac92822bd304f6b616c879822872"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads from a stream opened by <a class="el" href="capssc_8h.html#a00540bd8514db27fc12b624a1425fdad">capsscOpenRawScreenShotReadStream</a>. <br /></td></tr>
<tr class="separator:a7d74ac92822bd304f6b616c879822872"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7eb5ed84a867a5eb95fc8b4bbe394a2c" id="r_a7eb5ed84a867a5eb95fc8b4bbe394a2c"><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="capssc_8h.html#a7eb5ed84a867a5eb95fc8b4bbe394a2c">capsscCaptureJpegScreenShot</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *out_jpeg_size, void *jpeg_buf, size_t jpeg_buf_size, <a class="el" href="vi_8h.html#ad4375d33184b31fcb91ab0913d66ce45">ViLayerStack</a> layer_stack, <a class="el" href="types_8h.html#a350c6fc928e3bdc6c6486268ac8fb269">s64</a> timeout)</td></tr>
<tr class="memdesc:a7eb5ed84a867a5eb95fc8b4bbe394a2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This takes a screenshot, with the screenshot being written as jpeg into the output buffer. <br /></td></tr>
<tr class="separator:a7eb5ed84a867a5eb95fc8b4bbe394a2c"><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>Screenshot control (caps:sc) 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">Function Documentation</h2>
<a id="a7eb5ed84a867a5eb95fc8b4bbe394a2c" name="a7eb5ed84a867a5eb95fc8b4bbe394a2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7eb5ed84a867a5eb95fc8b4bbe394a2c">&#9670;&#160;</a></span>capsscCaptureJpegScreenShot()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> capsscCaptureJpegScreenShot </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *&#160;</td>
<td class="paramname"><em>out_jpeg_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>jpeg_buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>jpeg_buf_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="vi_8h.html#ad4375d33184b31fcb91ab0913d66ce45">ViLayerStack</a>&#160;</td>
<td class="paramname"><em>layer_stack</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a350c6fc928e3bdc6c6486268ac8fb269">s64</a>&#160;</td>
<td class="paramname"><em>timeout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This takes a screenshot, with the screenshot being written as jpeg into the output buffer. </p>
<dl class="section note"><dt>Note</dt><dd>Only available on [9.0.0+]. Requires debug mode before [10.0.0]. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">out_jpeg_size</td><td>Pointer to write the size of the captured jpeg to. </td></tr>
<tr><td class="paramname">jpeg_buf</td><td>Output buffer containing the JPEG image. </td></tr>
<tr><td class="paramname">jpeg_buf_size</td><td>Size of jpeg_buf, official software uses 0x80000. </td></tr>
<tr><td class="paramname">layer_stack</td><td><a class="el" href="vi_8h.html#ad4375d33184b31fcb91ab0913d66ce45">ViLayerStack</a> </td></tr>
<tr><td class="paramname">timeout</td><td>Timeout in nanoseconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa7a5886a35dbd2278dd1cec4acaa7a60" name="aa7a5886a35dbd2278dd1cec4acaa7a60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7a5886a35dbd2278dd1cec4acaa7a60">&#9670;&#160;</a></span>capsscCaptureRawImageWithTimeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> capsscCaptureRawImageWithTimeout </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="vi_8h.html#ad4375d33184b31fcb91ab0913d66ce45">ViLayerStack</a>&#160;</td>
<td class="paramname"><em>layer_stack</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td>
<td class="paramname"><em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a350c6fc928e3bdc6c6486268ac8fb269">s64</a>&#160;</td>
<td class="paramname"><em>buffer_count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a350c6fc928e3bdc6c6486268ac8fb269">s64</a>&#160;</td>
<td class="paramname"><em>buffer_index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a350c6fc928e3bdc6c6486268ac8fb269">s64</a>&#160;</td>
<td class="paramname"><em>timeout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This takes a screenshot, with the screenshot being written into the output buffer. </p>
<dl class="section note"><dt>Note</dt><dd>Not available with [5.0.0+] (stubbed). </dd>
<dd>
buffer_index and buffer_count correspond to buffers with size 0x384000(1280*720*4). These must not be negative. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>Output buffer containing the RGBA8 image. </td></tr>
<tr><td class="paramname">size</td><td>Size of buf, should be 0x384000(1280*720*4) * buffer_count. </td></tr>
<tr><td class="paramname">layer_stack</td><td><a class="el" href="vi_8h.html#ad4375d33184b31fcb91ab0913d66ce45">ViLayerStack</a> </td></tr>
<tr><td class="paramname">width</td><td>Image width, must be 1280. </td></tr>
<tr><td class="paramname">height</td><td>Image height, must be 720. </td></tr>
<tr><td class="paramname">buffer_count</td><td>Total number of output image buffers. </td></tr>
<tr><td class="paramname">buffer_index</td><td>Starting image buffer index. Must be &lt; buffer_count. </td></tr>
<tr><td class="paramname">timeout</td><td>Timeout in nanoseconds. A default value of 100000000 can be used. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a20387ad9ec148dcb0cbbc644044f69b5" name="a20387ad9ec148dcb0cbbc644044f69b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20387ad9ec148dcb0cbbc644044f69b5">&#9670;&#160;</a></span>capsscCloseRawScreenShotReadStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> capsscCloseRawScreenShotReadStream </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Discards a stream opened by <a class="el" href="capssc_8h.html#a00540bd8514db27fc12b624a1425fdad">capsscOpenRawScreenShotReadStream</a>. </p>
<dl class="section note"><dt>Note</dt><dd>Only available on [3.0.0+]. Requires debug mode. </dd></dl>
</div>
</div>
<a id="a00540bd8514db27fc12b624a1425fdad" name="a00540bd8514db27fc12b624a1425fdad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00540bd8514db27fc12b624a1425fdad">&#9670;&#160;</a></span>capsscOpenRawScreenShotReadStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> capsscOpenRawScreenShotReadStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *&#160;</td>
<td class="paramname"><em>out_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *&#160;</td>
<td class="paramname"><em>out_width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *&#160;</td>
<td class="paramname"><em>out_height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="vi_8h.html#ad4375d33184b31fcb91ab0913d66ce45">ViLayerStack</a>&#160;</td>
<td class="paramname"><em>layer_stack</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a350c6fc928e3bdc6c6486268ac8fb269">s64</a>&#160;</td>
<td class="paramname"><em>timeout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This takes a raw screenshot, with the screenshot being held until <a class="el" href="capssc_8h.html#a20387ad9ec148dcb0cbbc644044f69b5">capsscCloseRawScreenShotReadStream</a> is called. </p>
<dl class="section note"><dt>Note</dt><dd>Only available on [3.0.0+]. Requires debug mode. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">out_size</td><td>Pointer to write the size of the captured raw image to. Always 0x384000(1280*720*4). </td></tr>
<tr><td class="paramname">out_width</td><td>Pointer to write the width of the captured raw image to. Always 1280. </td></tr>
<tr><td class="paramname">out_height</td><td>Pointer to write the height of the captured raw image to. Always 720. </td></tr>
<tr><td class="paramname">layer_stack</td><td><a class="el" href="vi_8h.html#ad4375d33184b31fcb91ab0913d66ce45">ViLayerStack</a> </td></tr>
<tr><td class="paramname">timeout</td><td>Timeout in nanoseconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7d74ac92822bd304f6b616c879822872" name="a7d74ac92822bd304f6b616c879822872"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d74ac92822bd304f6b616c879822872">&#9670;&#160;</a></span>capsscReadRawScreenShotReadStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> capsscReadRawScreenShotReadStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *&#160;</td>
<td class="paramname"><em>bytes_read</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td>
<td class="paramname"><em>offset</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads from a stream opened by <a class="el" href="capssc_8h.html#a00540bd8514db27fc12b624a1425fdad">capsscOpenRawScreenShotReadStream</a>. </p>
<dl class="section note"><dt>Note</dt><dd>Only available on [3.0.0+]. Requires debug mode. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bytes_read</td><td>Pointer to write the amounts of bytes written to buffer. </td></tr>
<tr><td class="paramname">buf</td><td>Output buffer containing the RGBA8 image. </td></tr>
<tr><td class="paramname">size</td><td>Size of buf. </td></tr>
<tr><td class="paramname">offset</td><td>Offset in image where read should start. </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