summaryrefslogtreecommitdiffstats
path: root/src/render/frontend/framegraph-components/qframegraph.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/render/frontend/framegraph-components/qframegraph.cpp')
-rw-r--r--src/render/frontend/framegraph-components/qframegraph.cpp52
1 files changed, 38 insertions, 14 deletions
diff --git a/src/render/frontend/framegraph-components/qframegraph.cpp b/src/render/frontend/framegraph-components/qframegraph.cpp
index 67774808e..754e90ed3 100644
--- a/src/render/frontend/framegraph-components/qframegraph.cpp
+++ b/src/render/frontend/framegraph-components/qframegraph.cpp
@@ -55,6 +55,33 @@ QFrameGraphPrivate::QFrameGraphPrivate()
}
+/*!
+ \class FrameGraph
+ \inmodule Qt3DRender
+ \since 5.3
+
+ \brief Defines the rendering method to be used by the renderer
+
+ FrameGraph is the Component that has an activeFrameGraph property
+ that should reference the root FrameGraphItem of a frame graph
+ tree. The Entity that contains a FrameGraph property defines the
+ rendering method to be used by the renderer.
+
+ \note Only one FrameGraph can be active at any moment.
+ */
+
+/*!
+ \qmltype FrameGraph
+ \instantiates Qt3D::QFrameGraph
+ \inherits Component3D
+ \inqmlmodule Qt3D.Render
+ \since 5.5
+ \brief For OpenGL ...
+*/
+
+/*! \fn void Qt3D::QFrameGraph::copy(const QNode *ref)
+ Copies the \a ref instance into this one.
+ */
void QFrameGraph::copy(const QNode *ref)
{
QComponent::copy(ref);
@@ -63,18 +90,9 @@ void QFrameGraph::copy(const QNode *ref)
}
/*!
- * \class Qt3D::FrameGraph
- *
- * \brief Component that has an activeFrameGraph property that should
- * reference the root FrameGraphItem of a frame graph tree. The Entity
- * that contains a FrameGraph property defines the rendering method to
- * be used by the renderer.
- *
- * Note that only a single FrameGraph can be active at any moment.
- *
- * \since 5.3
+ \fn Qt3D::QFrameGraph::QFrameGraph(QNode *parent)
+ Constructs a new QFrameGraph with the specified \a parent.
*/
-
QFrameGraph::QFrameGraph(QNode *parent)
: QComponent(*new QFrameGraphPrivate, parent)
{
@@ -87,9 +105,15 @@ QFrameGraph::QFrameGraph(QFrameGraphPrivate &dd, QNode *parent)
}
/*!
- * \property Qt3D::QFrameGraph::activeFrameGraph
- *
- * Holds the current activeFrameGraph root node.
+ \qmlproperty Qt3D.Render::FrameGraphNode Qt3D.Render::FrameGraph::activeFrameGraph
+
+ Holds the current activeFrameGraph root node.
+*/
+
+/*!
+ \property Qt3D::QFrameGraph::activeFrameGraph
+
+ Holds the current activeFrameGraph root node.
*/
QFrameGraphNode *QFrameGraph::activeFrameGraph() const
{