Sophie

Sophie

distrib > Mageia > 7 > i586 > media > core-updates > by-pkgid > f171b9b27b527f95603e88add5c7e1b6 > files > 174

qtwayland5-doc-5.12.6-1.mga7.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qwaylandsurfacegrabber.cpp -->
  <title>QWaylandSurfaceGrabber Class | Qt Wayland Compositor 5.12.6</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td >Qt 5.12</td><td ><a href="qtwaylandcompositor-index.html">Qt Wayland Compositor</a></td><td ><a href="qtwaylandcompositor-module.html">C++ Classes</a></td><td >QWaylandSurfaceGrabber</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtwaylandcompositor-index.html">Qt 5.12.6 Reference Documentation</a></td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QWaylandSurfaceGrabber Class</h1>
<!-- $$$QWaylandSurfaceGrabber-brief -->
<p>The <a href="qwaylandsurfacegrabber.html">QWaylandSurfaceGrabber</a> class allows to read the content of a <a href="qwaylandsurface.html">QWaylandSurface</a>. <a href="#details">More...</a></p>
<!-- @@@QWaylandSurfaceGrabber -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QWaylandSurfaceGrabber&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += waylandcompositor</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  Qt 5.8</td></tr></table></div><ul>
<li><a href="qwaylandsurfacegrabber-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurfacegrabber.html#Error-enum">Error</a></b> { InvalidSurface, NoBufferAttached, UnknownBufferType, RendererNotReady }</td></tr>
</table></div>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurfacegrabber.html#QWaylandSurfaceGrabber">QWaylandSurfaceGrabber</a></b>(QWaylandSurface *<i>surface</i>, QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurfacegrabber.html#grab">grab</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandSurface *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurfacegrabber.html#surface">surface</a></b>() const</td></tr>
</table></div>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurfacegrabber.html#failed">failed</a></b>(QWaylandSurfaceGrabber::Error <i>error</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurfacegrabber.html#success">success</a></b>(const QImage &amp;<i>image</i>)</td></tr>
</table></div>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qwaylandsurfacegrabber.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QWaylandSurfaceGrabber-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qwaylandsurfacegrabber.html">QWaylandSurfaceGrabber</a> class allows to read the content of a <a href="qwaylandsurface.html">QWaylandSurface</a>.</p>
<p>Sometimes it is needed to get the contents of a surface, for example to provide a screenshot to the user. The <a href="qwaylandsurfacegrabber.html">QWaylandSurfaceGrabber</a> class provides a simple method to do so, without having to care what type of buffer backs the surface, be it shared memory, OpenGL or something else.</p>
</div>
<!-- @@@QWaylandSurfaceGrabber -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Error$$$InvalidSurface$$$NoBufferAttached$$$UnknownBufferType$$$RendererNotReady -->
<h3 class="fn" id="Error-enum"><a name="Error-enum"></a>enum QWaylandSurfaceGrabber::<span class="name">Error</span></h3>
<p>The Error enum describes the reason for a grab failure.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QWaylandSurfaceGrabber::InvalidSurface</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The surface is null or otherwise not valid.</td></tr>
<tr><td class="topAlign"><code>QWaylandSurfaceGrabber::NoBufferAttached</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The client has not attached a buffer on the surface yet.</td></tr>
<tr><td class="topAlign"><code>QWaylandSurfaceGrabber::UnknownBufferType</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">The buffer attached on the surface is of an unknown type.</td></tr>
<tr><td class="topAlign"><code>QWaylandSurfaceGrabber::RendererNotReady</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">The compositor renderer is not ready to grab the surface content.</td></tr>
</table></div>
<!-- @@@Error -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QWaylandSurfaceGrabber[overload1]$$$QWaylandSurfaceGrabberQWaylandSurface*QObject* -->
<h3 class="fn" id="QWaylandSurfaceGrabber"><a name="QWaylandSurfaceGrabber"></a>QWaylandSurfaceGrabber::<span class="name">QWaylandSurfaceGrabber</span>(<span class="type"><a href="qwaylandsurface.html">QWaylandSurface</a></span> *<i>surface</i>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Create a <a href="qwaylandsurfacegrabber.html">QWaylandSurfaceGrabber</a> object with the given <i>surface</i> and <i>parent</i></p>
<!-- @@@QWaylandSurfaceGrabber -->
<!-- $$$failed[overload1]$$$failedQWaylandSurfaceGrabber::Error -->
<h3 class="fn" id="failed"><a name="failed"></a><code>[signal] </code><span class="type">void</span> QWaylandSurfaceGrabber::<span class="name">failed</span>(<span class="type"><a href="qwaylandsurfacegrabber.html#Error-enum">QWaylandSurfaceGrabber::Error</a></span> <i>error</i>)</h3>
<!-- @@@failed -->
<!-- $$$grab[overload1]$$$grab -->
<h3 class="fn" id="grab"><a name="grab"></a><span class="type">void</span> QWaylandSurfaceGrabber::<span class="name">grab</span>()</h3>
<p>Grab the content of the surface set on this object. It may not be possible to do that immediately so the success and failed signals should be used to be notified of when the grab is completed.</p>
<!-- @@@grab -->
<!-- $$$success[overload1]$$$successconstQImage& -->
<h3 class="fn" id="success"><a name="success"></a><code>[signal] </code><span class="type">void</span> QWaylandSurfaceGrabber::<span class="name">success</span>(const <span class="type">QImage</span> &amp;<i>image</i>)</h3>
<!-- @@@success -->
<!-- $$$surface[overload1]$$$surface -->
<h3 class="fn" id="surface"><a name="surface"></a><span class="type"><a href="qwaylandsurface.html">QWaylandSurface</a></span> *QWaylandSurfaceGrabber::<span class="name">surface</span>() const</h3>
<p>Returns the surface set on this object</p>
<!-- @@@surface -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2019 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional