<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qrendersurfaceselector.cpp -->
<title>QRenderSurfaceSelector Class | Qt 3D 5.12.2</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="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-cpp.html">C++ Classes</a></td><td >QRenderSurfaceSelector</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qt3d-index.html">Qt 5.12.2 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="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</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">QRenderSurfaceSelector Class</h1>
<span class="small-subtitle">(<a href="qt3drender-qrendersurfaceselector.html">Qt3DRender::QRenderSurfaceSelector</a>)<br/></span>
<!-- $$$QRenderSurfaceSelector-brief -->
<p>Provides a way of specifying the render surface. <a href="#details">More...</a></p>
<!-- @@@QRenderSurfaceSelector -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QRenderSurfaceSelector></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.7</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-render-rendersurfaceselector.html">RenderSurfaceSelector</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3drender-qframegraphnode.html">Qt3DRender::QFrameGraphNode</a></td></tr></table></div><ul>
<li><a href="qt3drender-qrendersurfaceselector-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-qrendersurfaceselector.html#externalRenderTargetSize-prop">externalRenderTargetSize</a></b> : QSize</li>
<li class="fn"><b><a href="qt3drender-qrendersurfaceselector.html#surface-prop">surface</a></b> : QObject*</li>
<li class="fn"><b><a href="qt3drender-qrendersurfaceselector.html#surfacePixelRatio-prop">surfacePixelRatio</a></b> : float</li>
</ul>
<ul>
<li class="fn">3 properties inherited from <a href="qt3dcore-qnode.html#properties">Qt3DCore::QNode</a></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"> </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrendersurfaceselector.html#QRenderSurfaceSelector">QRenderSurfaceSelector</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSize </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrendersurfaceselector.html#externalRenderTargetSize-prop">externalRenderTargetSize</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QObject *</td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrendersurfaceselector.html#surface-prop">surface</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrendersurfaceselector.html#surfacePixelRatio-prop">surfacePixelRatio</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">1 public function inherited from <a href="qt3drender-qframegraphnode.html#public-functions">Qt3DRender::QFrameGraphNode</a></li>
<li class="fn">13 public functions inherited from <a href="qt3dcore-qnode.html#public-functions">Qt3DCore::QNode</a></li>
</ul>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrendersurfaceselector.html#setExternalRenderTargetSize">setExternalRenderTargetSize</a></b>(const QSize &<i>size</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrendersurfaceselector.html#setSurface">setSurface</a></b>(QObject *<i>surfaceObject</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrendersurfaceselector.html#surfacePixelRatio-prop">setSurfacePixelRatio</a></b>(float <i>ratio</i>)</td></tr>
</table></div>
<ul>
<li class="fn">3 public slots inherited from <a href="qt3dcore-qnode.html#public-slots">Qt3DCore::QNode</a></li>
</ul>
<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-qrendersurfaceselector.html#externalRenderTargetSize-prop">externalRenderTargetSizeChanged</a></b>(const QSize &<i>size</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrendersurfaceselector.html#surface-prop">surfaceChanged</a></b>(QObject *<i>surface</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrendersurfaceselector.html#surfacePixelRatio-prop">surfacePixelRatioChanged</a></b>(float <i>ratio</i>)</td></tr>
</table></div>
<ul>
<li class="fn">4 signals inherited from <a href="qt3dcore-qnode.html#signals">Qt3DCore::QNode</a></li>
</ul>
<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="qt3drender-qrendersurfaceselector.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 protected function inherited from <a href="qt3drender-qframegraphnode.html#protected-functions">Qt3DRender::QFrameGraphNode</a></li>
<li class="fn">2 protected functions inherited from <a href="qt3dcore-qnode.html#protected-functions">Qt3DCore::QNode</a></li>
</ul>
<a name="details"></a>
<!-- $$$QRenderSurfaceSelector-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>Provides a way of specifying the render surface.</p>
<p>The <a href="qt3drender-qrendersurfaceselector.html">Qt3DRender::QRenderSurfaceSelector</a> can be used to select the surface, where Qt3D renders the content. The surface can either be window surface or offscreen surface. The <a href="qt3drender-qrendersurfaceselector.html#externalRenderTargetSize-prop">externalRenderTargetSize</a> is used to specify the actual size of the surface when offscreen surface is used.</p>
<p>When DPI scaling is used by the system, the logical surface size, which is used by mouse events, and the actual 'physical' size of the surface can differ. The <a href="qt3drender-qrendersurfaceselector.html#surfacePixelRatio-prop">surfacePixelRatio</a> is the factor to convert the logical size to the physical size.</p>
</div>
<p><b>See also </b>QWindow, QOffscreenSurface, and QSurface.</p>
<!-- @@@QRenderSurfaceSelector -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$externalRenderTargetSize-prop$$$externalRenderTargetSize$$$setExternalRenderTargetSizeconstQSize&$$$externalRenderTargetSizeChangedconstQSize& -->
<h3 class="fn" id="externalRenderTargetSize-prop"><a name="externalRenderTargetSize-prop"></a><span class="name">externalRenderTargetSize</span> : <span class="type">QSize</span></h3>
<p>Holds the size of the external render target.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QSize </td><td class="memItemRight bottomAlign"><span class="name"><b>externalRenderTargetSize</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3drender-qrendersurfaceselector.html#setExternalRenderTargetSize">setExternalRenderTargetSize</a></b></span>(const QSize &<i>size</i>)</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>externalRenderTargetSizeChanged</b></span>(const QSize &<i>size</i>)</td></tr>
</table></div>
<!-- @@@externalRenderTargetSize -->
<!-- $$$surface-prop$$$surface$$$setSurfaceQObject*$$$surfaceChangedQObject* -->
<h3 class="fn" id="surface-prop"><a name="surface-prop"></a><span class="name">surface</span> : <span class="type">QObject</span>*</h3>
<p>Holds the surface</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QObject *</td><td class="memItemRight bottomAlign"><span class="name"><b>surface</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3drender-qrendersurfaceselector.html#setSurface">setSurface</a></b></span>(QObject *<i>surfaceObject</i>)</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>surfaceChanged</b></span>(QObject *<i>surface</i>)</td></tr>
</table></div>
<!-- @@@surface -->
<!-- $$$surfacePixelRatio-prop$$$surfacePixelRatio$$$setSurfacePixelRatiofloat$$$surfacePixelRatioChangedfloat -->
<h3 class="fn" id="surfacePixelRatio-prop"><a name="surfacePixelRatio-prop"></a><span class="name">surfacePixelRatio</span> : <span class="type">float</span></h3>
<p>Holds the surfacePixelRatio of the surface.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> float </td><td class="memItemRight bottomAlign"><span class="name"><b>surfacePixelRatio</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSurfacePixelRatio</b></span>(float <i>ratio</i>)</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>surfacePixelRatioChanged</b></span>(float <i>ratio</i>)</td></tr>
</table></div>
<!-- @@@surfacePixelRatio -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QRenderSurfaceSelector[overload1]$$$QRenderSurfaceSelectorQt3DCore::QNode* -->
<h3 class="fn" id="QRenderSurfaceSelector"><a name="QRenderSurfaceSelector"></a>QRenderSurfaceSelector::<span class="name">QRenderSurfaceSelector</span>(<span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3>
<p>Constructs <a href="qt3drender-qrendersurfaceselector.html">QRenderSurfaceSelector</a> with given <i>parent</i>.</p>
<!-- @@@QRenderSurfaceSelector -->
<!-- $$$setExternalRenderTargetSize -->
<h3 class="fn" id="setExternalRenderTargetSize"><a name="setExternalRenderTargetSize"></a><code>[slot] </code><span class="type">void</span> QRenderSurfaceSelector::<span class="name">setExternalRenderTargetSize</span>(const <span class="type">QSize</span> &<i>size</i>)</h3>
<p>Sets render target <i>size</i> if different than underlying surface size. Tells picking the correct size.</p>
<p><b>Note:</b> Setter function for property <a href="qt3drender-qrendersurfaceselector.html#externalRenderTargetSize-prop">externalRenderTargetSize</a>. </p><p><b>See also </b><a href="qt3drender-qrendersurfaceselector.html#externalRenderTargetSize-prop">externalRenderTargetSize</a>().</p>
<!-- @@@setExternalRenderTargetSize -->
<!-- $$$setSurface -->
<h3 class="fn" id="setSurface"><a name="setSurface"></a><code>[slot] </code><span class="type">void</span> QRenderSurfaceSelector::<span class="name">setSurface</span>(<span class="type">QObject</span> *<i>surfaceObject</i>)</h3>
<p>Sets <i>surfaceObject</i>.</p>
<p><b>Note:</b> Setter function for property <a href="qt3drender-qrendersurfaceselector.html#surface-prop">surface</a>. </p><p><b>See also </b><a href="qt3drender-qrendersurfaceselector.html#surface-prop">surface</a>().</p>
<!-- @@@setSurface -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</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>
