<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qwaylandview.cpp -->
<title>WaylandView QML Type | 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="qtwayland-compositor-qmlmodule.html">QML Types</a></td><td >WaylandView QML Type</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="#properties">Properties</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">WaylandView QML Type</h1>
<span class="subtitle"></span>
<!-- $$$WaylandView-brief -->
<p>Represents a view of a surface on an output. <a href="#details">More...</a></p>
<!-- @@@WaylandView -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtWayland.Compositor 1.3</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="qml-qtwayland-compositor-waylandview-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><b><a href="qml-qtwayland-compositor-waylandview.html#allowDiscardFrontBuffer-prop">allowDiscardFrontBuffer</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandview.html#bufferLocked-prop">bufferLocked</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandview.html#output-prop">output</a></b></b> : WaylandOutput</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandview.html#surface-prop">surface</a></b></b> : WaylandSurface</li>
</ul>
<!-- $$$WaylandView-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>The <a href="qml-qtwayland-compositor-waylandview.html">WaylandView</a> corresponds to the presentation of a surface on a specific output, managing the buffers that contain the contents to be rendered. You can have several views into the same surface.</p>
<!-- @@@WaylandView -->
<h2>Property Documentation</h2>
<!-- $$$allowDiscardFrontBuffer -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="allowDiscardFrontBuffer-prop">
<td class="tblQmlPropNode"><p>
<a name="allowDiscardFrontBuffer-prop"></a><span class="name">allowDiscardFrontBuffer</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>By default, the view locks the current buffer until advance() is called. Set this property to true to allow Qt to release the buffer when the primary view is no longer using it.</p>
<p>This can be used to avoid the situation where a secondary view that updates on a lower frequency will throttle the frame rate of the client application.</p>
</div></div><!-- @@@allowDiscardFrontBuffer -->
<br/>
<!-- $$$bufferLocked -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="bufferLocked-prop">
<td class="tblQmlPropNode"><p>
<a name="bufferLocked-prop"></a><span class="name">bufferLocked</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the view's buffer is currently locked. When the buffer is locked, advance() will not advance to the next buffer and returns <code>false</code>.</p>
<p>The default is <code>false</code>.</p>
</div></div><!-- @@@bufferLocked -->
<br/>
<!-- $$$output -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="output-prop">
<td class="tblQmlPropNode"><p>
<a name="output-prop"></a><span class="name">output</span> : <span class="type"><a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the output on which this view displays its surface.</p>
</div></div><!-- @@@output -->
<br/>
<!-- $$$surface -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="surface-prop">
<td class="tblQmlPropNode"><p>
<a name="surface-prop"></a><span class="name">surface</span> : <span class="type"><a href="qml-qtwayland-compositor-waylandsurface.html">WaylandSurface</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the surface viewed by this <a href="qml-qtwayland-compositor-waylandview.html">WaylandView</a>.</p>
</div></div><!-- @@@surface -->
<br/>
</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>
