summaryrefslogtreecommitdiffstats
path: root/src/render/framegraph/qsortpolicy.cpp
diff options
context:
space:
mode:
authorLiang Qi <liang.qi@qt.io>2016-09-20 10:39:32 +0200
committerLiang Qi <liang.qi@qt.io>2016-09-20 10:39:32 +0200
commit0e3d54f8d7f9be26687afebcc9f456e4cefc2357 (patch)
treef3826c927305cc137006aed968be6fbf57b42009 /src/render/framegraph/qsortpolicy.cpp
parent52121396c55e6100316f006c87b4fdaa8b5a0719 (diff)
parent7e638edbd15640302516f9a69d20f62d26d4af06 (diff)
Merge remote-tracking branch 'origin/5.7' into 5.8
Conflicts: src/render/framegraph/qrendersurfaceselector.cpp src/render/frontend/qrendersettings.cpp src/render/jobs/renderviewjobutils_p.h tests/auto/render/render.pro Change-Id: Ibe9eb962e3990e07f01a5608a2d60c79bc4c160f
Diffstat (limited to 'src/render/framegraph/qsortpolicy.cpp')
-rw-r--r--src/render/framegraph/qsortpolicy.cpp63
1 files changed, 37 insertions, 26 deletions
diff --git a/src/render/framegraph/qsortpolicy.cpp b/src/render/framegraph/qsortpolicy.cpp
index 50fcae50f..a20ebd201 100644
--- a/src/render/framegraph/qsortpolicy.cpp
+++ b/src/render/framegraph/qsortpolicy.cpp
@@ -53,23 +53,34 @@ QSortPolicyPrivate::QSortPolicyPrivate()
}
/*!
- * \class Qt3DRender::QSortPolicy
- * \inmodule Qt3DRender
- * \brief Provides storage for the sort types to be used
- * \since 5.7
- *
- * \inherits Qt3DRender::QFrameGraphNode
- *
+ \class Qt3DRender::QSortPolicy
+ \inmodule Qt3DRender
+ \brief Provides storage for the sort types to be used
+ \since 5.7
+
+ \inherits Qt3DRender::QFrameGraphNode
+
+ A Qt3DRender::QSortPolicy class stores the sorting type used by the FrameGraph.
+ The sort types determine how drawable entities are sorted before drawing to
+ determine the drawing order. When QSortPolicy is present in the FrameGraph,
+ the sorting mechanism is determined by the SortTypes list. Multiple sort types
+ can be used simultanously. If QSortPolicy is not present in the FrameGraph,
+ entities are drawn in the order they appear in the entity hierarchy.
*/
/*!
- * \qmltype SortPolicy
- * \inqmlmodule Qt3D.Render
- * \since 5.7
- * \ingroup
- * \instantiates Qt3DRender::QSortPolicy
- * \brief Provides storage for the sort types to be used
- *
+ \qmltype SortPolicy
+ \inqmlmodule Qt3D.Render
+ \since 5.7
+ \instantiates Qt3DRender::QSortPolicy
+ \brief Provides storage for the sort types to be used
+
+ A SortPolicy class stores the sorting type used by the FrameGraph.
+ The sort types determine how drawable entities are sorted before drawing to
+ determine the drawing order. When SortPolicy is present in the FrameGraph,
+ the sorting mechanism is determined by the SortTypes list. Multiple sort
+ types can be used simultanously. If SortPolicy is not present in the FrameGraph,
+ entities are drawn in the order they appear in the entity hierarchy.
*/
/*!
@@ -82,7 +93,17 @@ QSortPolicyPrivate::QSortPolicyPrivate()
*/
/*!
- * Constructs QSortPolicy with given \a parent.
+ \property QSortPolicy::sortTypes
+ Specifies the sorting types to be used.
+*/
+
+/*!
+ \qmlproperty QVariantList SortPolicy::sortTypes
+ Specifies the sorting types to be used.
+*/
+
+/*!
+ Constructs QSortPolicy with given \a parent.
*/
QSortPolicy::QSortPolicy(QNode *parent)
: QFrameGraphNode(*new QSortPolicyPrivate, parent)
@@ -110,17 +131,7 @@ QNodeCreatedChangeBasePtr QSortPolicy::createNodeCreationChange() const
}
/*!
- \property Qt3DRender::QSortPolicy::sortTypes
- Specifies the sorting types to be used.
-*/
-
-/*!
- \qmlproperty QVariantList Qt3D.Render::QSortPolicy::sortTypes
- Specifies the sorting types to be used.
-
-*/
-/*!
- * \return the current sort types in use
+ \return the current sort types in use
*/
QVector<QSortPolicy::SortType> QSortPolicy::sortTypes() const
{