summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntti Määttä <antti.maatta@qt.io>2016-09-02 13:29:16 +0300
committerAntti Määttä <antti.maatta@qt.io>2016-09-05 05:31:36 +0000
commit69f8f117912af25f5ac513de8627738d9c9dc1b0 (patch)
tree4628a215f4db7fb2e98fab2fa02a0a5865e4905d
parent4d4c7b617276446e87d05e97a1bcedb9e461d26d (diff)
Update QLayerFilter docs
Change-Id: I4715d22a583f16444ea9f35c6f9352d53e63f114 Reviewed-by: Paul Lemire <paul.lemire@kdab.com> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
-rw-r--r--src/render/framegraph/qlayerfilter.cpp32
1 files changed, 17 insertions, 15 deletions
diff --git a/src/render/framegraph/qlayerfilter.cpp b/src/render/framegraph/qlayerfilter.cpp
index 92c1e1266..f7f4dd12c 100644
--- a/src/render/framegraph/qlayerfilter.cpp
+++ b/src/render/framegraph/qlayerfilter.cpp
@@ -59,7 +59,10 @@ QLayerFilterPrivate::QLayerFilterPrivate()
\since 5.5
\brief Controls layers Drawn in a frame graph branch.
- A QLayerFiler can be used to instruct the renderer as to which layer(s) to draw in that branch of the frame graph.
+ A Qt3DRender::QLayerFilter can be used to instruct the renderer as to which layer(s)
+ to draw in that branch of the frame graph. The Qt3DRender::QLayerFilter selects which
+ entities to draw based on the Qt3DRender::QLayer instances added to the QLayerFilter
+ and as components to the \l Qt3DCore::QEntity.
*/
/*!
@@ -70,12 +73,20 @@ QLayerFilterPrivate::QLayerFilterPrivate()
\since 5.5
\brief Controls layers Drawn in a frame graph branch.
- A QLayerFiler can be used to instruct the renderer as to which layer(s) to draw in that branch of the frame graph.
+ A LayerFilter can be used to instruct the renderer as to which layer(s)
+ to draw in that branch of the frame graph. The LayerFilter selects which
+ entities to draw based on the \l Layer instances added to the LayerFilter
+ and as components to the \l Entity.
*/
+/*!
+ \qmlproperty list<Layer> Qt3D.Render::LayerFilter::layers
+ Holds a list of layers specifying the layers to select for drawing.
+ \readonly
+ */
/*!
- The constructor creates an instance with the specified \a parent.
+ The constructor creates an instance with the specified \a parent.
*/
QLayerFilter::QLayerFilter(QNode *parent)
: QFrameGraphNode(*new QLayerFilterPrivate, parent)
@@ -94,16 +105,7 @@ QLayerFilter::~QLayerFilter()
}
/*!
- \property Qt3DRender::QLayerFilter::layers
-
- */
-
-/*!
- \qmlproperty stringlist Qt3D.Render::LayerFilter::layers
-
-*/
-/*!
- Add \a layer to the current list of layers
+ Add \a layer to the current list of layers
*/
void QLayerFilter::addLayer(QLayer *layer)
{
@@ -131,7 +133,7 @@ void QLayerFilter::addLayer(QLayer *layer)
}
/*!
- Remove \a layer from the current list of layers
+ Remove \a layer from the current list of layers
*/
void QLayerFilter::removeLayer(QLayer *layer)
{
@@ -148,7 +150,7 @@ void QLayerFilter::removeLayer(QLayer *layer)
}
/*!
- \return the current list of layers
+ \return the current list of layers
*/
QVector<QLayer *> QLayerFilter::layers() const
{