Sophie

Sophie

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

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" />
<!-- qwaylandoutput.cpp -->
  <title>WaylandOutput 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 >WaylandOutput 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">WaylandOutput QML Type</h1>
<span class="subtitle"></span>
<!-- $$$WaylandOutput-brief -->
<p>Provides access to a displayable area managed by the compositor. <a href="#details">More...</a></p>
<!-- @@@WaylandOutput -->
<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-waylandoutput-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-waylandoutput.html#automaticFrameCallback-prop">automaticFrameCallback</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandoutput.html#availableGeometry-prop">availableGeometry</a></b></b> : rect</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandoutput.html#compositor-prop">compositor</a></b></b> : WaylandCompositor</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandoutput.html#geometry-prop">geometry</a></b></b> : rect</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandoutput.html#manufacturer-prop">manufacturer</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandoutput.html#model-prop">model</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandoutput.html#physicalSize-prop">physicalSize</a></b></b> : size</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandoutput.html#position-prop">position</a></b></b> : point</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandoutput.html#scaleFactor-prop">scaleFactor</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandoutput.html#sizeFollowsWindow-prop">sizeFollowsWindow</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandoutput.html#subpixel-prop">subpixel</a></b></b> : enum</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandoutput.html#transform-prop">transform</a></b></b> : enum</li>
<li class="fn"><b><b><a href="qml-qtwayland-compositor-waylandoutput.html#window-prop">window</a></b></b> : Window</li>
</ul>
<!-- $$$WaylandOutput-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>The <a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a> manages a rectangular area within bounds of the compositor's geometry, to use it for displaying client content. This could, for instance, be a screen managed by the <a href="qml-qtwayland-compositor-waylandcompositor.html">WaylandCompositor</a>.</p>
<p>The type corresponds to the <code>wl_output</code> interface in the Wayland protocol.</p>
<!-- @@@WaylandOutput -->
<h2>Property Documentation</h2>
<!-- $$$automaticFrameCallback -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="automaticFrameCallback-prop">
<td class="tblQmlPropNode"><p>
<a name="automaticFrameCallback-prop"></a><span class="name">automaticFrameCallback</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the <a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a> automatically sends frame callbacks when rendering.</p>
<p>The default is true.</p>
</div></div><!-- @@@automaticFrameCallback -->
<br/>
<!-- $$$availableGeometry -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="availableGeometry-prop">
<td class="tblQmlPropNode"><p>
<a name="availableGeometry-prop"></a><span class="name">availableGeometry</span> : <span class="type">rect</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the geometry of the <a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a> available for displaying content. The available geometry is in output coordinates space, starts from 0,0 and it's as big as the output by default.</p>
<p><b>See also </b><a href="qwaylandoutput.html#geometry-prop">QWaylandOutput::geometry</a>.</p>
</div></div><!-- @@@availableGeometry -->
<br/>
<!-- $$$compositor -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="compositor-prop">
<td class="tblQmlPropNode"><p>
<a name="compositor-prop"></a><span class="name">compositor</span> : <span class="type"><a href="qml-qtwayland-compositor-waylandcompositor.html">WaylandCompositor</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the compositor displaying content on this <a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.</p>
<p><b>Note: </b>This property can be set only once, before the <a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a> component is completed.</p></div></div><!-- @@@compositor -->
<br/>
<!-- $$$geometry -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="geometry-prop">
<td class="tblQmlPropNode"><p>
<a name="geometry-prop"></a><span class="name">geometry</span> : <span class="type">rect</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the geometry of the <a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.</p>
</div></div><!-- @@@geometry -->
<br/>
<!-- $$$manufacturer -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="manufacturer-prop">
<td class="tblQmlPropNode"><p>
<a name="manufacturer-prop"></a><span class="name">manufacturer</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds a textual description of the manufacturer of this <a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.</p>
</div></div><!-- @@@manufacturer -->
<br/>
<!-- $$$model -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="model-prop">
<td class="tblQmlPropNode"><p>
<a name="model-prop"></a><span class="name">model</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds a textual description of the model of this <a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.</p>
</div></div><!-- @@@model -->
<br/>
<!-- $$$physicalSize -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="physicalSize-prop">
<td class="tblQmlPropNode"><p>
<a name="physicalSize-prop"></a><span class="name">physicalSize</span> : <span class="type">size</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the physical size of the <a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a> in millimeters.</p>
<p><b>See also </b><a href="qwaylandoutput.html#geometry-prop">QWaylandOutput::geometry</a>.</p>
</div></div><!-- @@@physicalSize -->
<br/>
<!-- $$$position -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="position-prop">
<td class="tblQmlPropNode"><p>
<a name="position-prop"></a><span class="name">position</span> : <span class="type">point</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the position of this <a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a> in the compositor's coordinate system.</p>
</div></div><!-- @@@position -->
<br/>
<!-- $$$scaleFactor -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="scaleFactor-prop">
<td class="tblQmlPropNode"><p>
<a name="scaleFactor-prop"></a><span class="name">scaleFactor</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the factor by which the <a href="qml-qtwayland-compositor-waylandcompositor.html">WaylandCompositor</a> scales surface buffers before they are displayed. It is used on high density output devices where unscaled content would be too small to be practical. The client can in turn set the scale factor of its buffer to match the output if it prefers to provide high resolution content that is suitable for the output device.</p>
<p>The default is 1 (no scaling).</p>
</div></div><!-- @@@scaleFactor -->
<br/>
<!-- $$$sizeFollowsWindow -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="sizeFollowsWindow-prop">
<td class="tblQmlPropNode"><p>
<a name="sizeFollowsWindow-prop"></a><span class="name">sizeFollowsWindow</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property controls whether the size of the <a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a> matches the size of its window.</p>
<p>If this property is true, all modes previously added are replaced by a mode that matches window size and screen refresh rate.</p>
<p>The default is false.</p>
</div></div><!-- @@@sizeFollowsWindow -->
<br/>
<!-- $$$subpixel -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="subpixel-prop">
<td class="tblQmlPropNode"><p>
<a name="subpixel-prop"></a><span class="name">subpixel</span> : <span class="type">enum</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the subpixel arrangement of this <a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.</p>
<ul>
<li><a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.SubpixelUnknown The subpixel arrangement is not set.</li>
<li><a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.SubpixelNone There are no subpixels.</li>
<li><a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.SubpixelHorizontalRgb The subpixels are arranged horizontally in red, green, blue order.</li>
<li><a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.SubpixelHorizontalBgr The subpixels are arranged horizontally in blue, green, red order.</li>
<li><a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.SubpixelVerticalRgb The subpixels are arranged vertically in red, green, blue order.</li>
<li><a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.SubpixelVerticalBgr The subpixels are arranged vertically in blue, green, red order.</li>
</ul>
<p>The default is <a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.SubpixelUnknown.</p>
</div></div><!-- @@@subpixel -->
<br/>
<!-- $$$transform -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="transform-prop">
<td class="tblQmlPropNode"><p>
<a name="transform-prop"></a><span class="name">transform</span> : <span class="type">enum</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the transformation that the <a href="qwaylandcompositor.html">QWaylandCompositor</a> applies to a surface to compensate for the orientation of the <a href="qwaylandoutput.html">QWaylandOutput</a>.</p>
<ul>
<li><a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.TransformNormal The orientation is normal.</li>
<li><a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.Transform90 The orientation is rotated 90 degrees.</li>
<li><a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.Transform180 The orientation is rotated 180 degrees.</li>
<li><a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.Transform270 The orientation is rotated 270 degrees.</li>
<li><a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.TransformFlipped The orientation is mirrored.</li>
<li><a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.TransformFlipped90 The orientation is mirrored, then rotated 90 degrees.</li>
<li><a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.TransformFlipped180 The orientation is mirrored, then rotated 180 degrees.</li>
<li><a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.TransformFlipped270 The orientation is mirrored, then rotated 270 degrees.</li>
</ul>
<p>The default is <a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.TransformNormal.</p>
</div></div><!-- @@@transform -->
<br/>
<!-- $$$window -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="window-prop">
<td class="tblQmlPropNode"><p>
<a name="window-prop"></a><span class="name">window</span> : <span class="type">Window</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the Window for this <a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a>.</p>
<p><b>Note: </b>This property can be set only once, before the <a href="qml-qtwayland-compositor-waylandoutput.html">WaylandOutput</a> component is completed.</p></div></div><!-- @@@window -->
<br/>
        </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>