<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qrendercapture.cpp --> <title>QRenderCaptureReply Class | Qt 3D 5.9</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.9</td><td ><a href="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-cpp.html">C++ Classes</a></td><td >QRenderCaptureReply</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</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="#properties">Properties</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="#details">Detailed Description</a></li> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">QRenderCaptureReply Class</h1> <span class="small-subtitle">(<a href="qt3drender-qrendercapturereply.html">Qt3DRender::QRenderCaptureReply</a>)<br/></span> <!-- $$$QRenderCaptureReply-brief --> <p>Receives the result of render capture request. <a href="#details">More...</a></p> <!-- @@@QRenderCaptureReply --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <Qt3DRender/QRenderCaptureReply></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += 3drender</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.8</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-render-rendercapturereply.html">RenderCaptureReply</a></td></tr></table></div><ul> <li><a href="qt3drender-qrendercapturereply-members.html">List of all members, including inherited members</a></li> </ul> <a name="properties"></a> <h2 id="properties">Properties</h2> <ul> <li class="fn"><b><a href="qt3drender-qrendercapturereply.html#captureId-prop">captureId</a></b> : const int</li> <li class="fn"><b><a href="qt3drender-qrendercapturereply.html#complete-prop">complete</a></b> : const bool</li> <li class="fn"><b><a href="qt3drender-qrendercapturereply.html#image-prop">image</a></b> : const QImage</li> </ul> <a name="public-functions"></a> <h2 id="public-functions">Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrendercapturereply.html#captureId-prop">captureId</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QImage </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrendercapturereply.html#image-prop">image</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrendercapturereply.html#complete-prop">isComplete</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrendercapturereply.html#saveImage">saveImage</a></b>(const QString &<i>fileName</i>) 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="qt3drender-qrendercapturereply.html#complete-prop">completed</a></b>()</td></tr> </table></div> <a name="details"></a> <!-- $$$QRenderCaptureReply-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>Receives the result of render capture request.</p> <p>An object, which receives the image from <a href="qt3drender-qrendercapture.html#requestCapture">QRenderCapture::requestCapture</a>.</p> </div> <!-- @@@QRenderCaptureReply --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$captureId-prop$$$captureId --> <h3 class="fn" id="captureId-prop"><a name="captureId-prop"></a><span class="name">captureId</span> : const <span class="type">int</span></h3> <p>Holds the captureId, which was passed to the renderCapture.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>captureId</b></span>() const</td></tr> </table></div> <!-- @@@captureId --> <!-- $$$complete-prop$$$isComplete$$$completed --> <h3 class="fn" id="complete-prop"><a name="complete-prop"></a><span class="name">complete</span> : const <span class="type">bool</span></h3> <p>Holds the complete state of the render capture.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isComplete</b></span>() const</td></tr> </table></div> <p><b>Notifier signal:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>completed</b></span>()</td></tr> </table></div> <!-- @@@complete --> <!-- $$$image-prop$$$image --> <h3 class="fn" id="image-prop"><a name="image-prop"></a><span class="name">image</span> : const <span class="type">QImage</span></h3> <p>Holds the image, which was produced as a result of render capture.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QImage </td><td class="memItemRight bottomAlign"><span class="name"><b>image</b></span>() const</td></tr> </table></div> <!-- @@@image --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$saveImage[overload1]$$$saveImageconstQString& --> <h3 class="fn" id="saveImage"><a name="saveImage"></a><span class="type">bool</span> QRenderCaptureReply::<span class="name">saveImage</span>(const <span class="type">QString</span> &<i>fileName</i>) const</h3> <p>Saves the render capture result as an image to <i>fileName</i>.</p> <p>Returns true if the image was successfully saved; otherwise returns false.</p> <p>This function was introduced in Qt 5.9.</p> <!-- @@@saveImage --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2017 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>