<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qlayer.cpp -->
<title>Layer QML Type | 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-qml.html">QML Types</a></td><td >Layer QML Type</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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Layer QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Layer-brief -->
<p>Layer provides a way of filtering which entities will be rendered. <a href="#details">More...</a></p>
<!-- @@@Layer -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import Qt3D.Render 2.12</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.5</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-render-layer.html"><a href="qt3drender-qlayer.html">QLayer</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qt3d-core-component3d.html">Component3D</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qt3d-render-layer-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-qt3d-render-layer.html#recursive-prop">recursive</a></b></b> : bool</li>
</ul>
<!-- $$$Layer-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>Layer works in conjunction with the <a href="qml-qt3d-render-layerfilter.html">LayerFilter</a> in the FrameGraph.</p>
<p>A Layer can be applied to a subtree of entities by setting the recursive property to true.</p>
<pre class="cpp">
import Qt3D<span class="operator">.</span>Core <span class="number">2.0</span>
import Qt3D<span class="operator">.</span>Render <span class="number">2.0</span>
Entity {
id: root
components: RenderSettings {
<span class="comment">// FrameGraph</span>
Viewport {
ClearBuffers {
buffers: ClearBuffers<span class="operator">.</span>ColorDepthBuffer
CameraSelector {
camera: mainCamera
LayerFilter {
layers: <span class="operator">[</span>layer1<span class="operator">]</span>
}
}
}
}
}
<span class="comment">// Scene</span>
Camera { id: mainCamera }
Layer {
id: layer1
recursive: <span class="keyword">true</span>
}
GeometryRenderer { id: mesh }
Entity {
id: renderableEntity
components: <span class="operator">[</span> mesh<span class="operator">,</span> layer1 <span class="operator">]</span>
}
}
</pre>
<p><b>See also </b><a href="qml-qt3d-render-layerfilter.html">LayerFilter</a>.</p>
<!-- @@@Layer -->
<h2>Property Documentation</h2>
<!-- $$$recursive -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="recursive-prop">
<td class="tblQmlPropNode"><p>
<a name="recursive-prop"></a><span class="name">recursive</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Specifies if the layer is also applied to the entity subtree.</p>
</div></div><!-- @@@recursive -->
<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>
