summaryrefslogtreecommitdiffstats
path: root/src/quick3d/imports/scene3d/scene3drenderer.cpp
diff options
context:
space:
mode:
authorPaul Wicking <paul.wicking@qt.io>2018-04-23 14:09:21 +0200
committerPaul Wicking <paul.wicking@qt.io>2018-04-27 08:33:39 +0000
commit3fc080b6bdacc440efae453413dd8053bbecacf5 (patch)
tree3c634ef9e50784f704353b6fcf692f546706aa50 /src/quick3d/imports/scene3d/scene3drenderer.cpp
parent661f41e85c21b470a80c77aac3738a1ae24580a5 (diff)
Doc: Add basic documentation for Scene3D QML module
Adds Scene3D as QML module. Provides preliminary documentation for Scene3D QML type. Task-number: QTBUG-61651 Task-number: QTBUG-54816 Change-Id: I2811bb2165ca0adde574ddde70fa7185b3c03083 Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io> Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io> (cherry picked from commit 988928b9d37dfae08b5a98cd139eaaa14e72c02c)
Diffstat (limited to 'src/quick3d/imports/scene3d/scene3drenderer.cpp')
-rw-r--r--src/quick3d/imports/scene3d/scene3drenderer.cpp8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/quick3d/imports/scene3d/scene3drenderer.cpp b/src/quick3d/imports/scene3d/scene3drenderer.cpp
index 4822c7bc4..b3cac0dcd 100644
--- a/src/quick3d/imports/scene3d/scene3drenderer.cpp
+++ b/src/quick3d/imports/scene3d/scene3drenderer.cpp
@@ -92,17 +92,18 @@ private:
};
/*!
- \class Qt3DCore::Scene3DRenderer
+ \class Qt3DRender::Scene3DRenderer
\internal
- \brief The Qt3DCore::Scene3DRenderer class takes care of rendering a Qt3D scene
+ \brief The Scene3DRenderer class takes care of rendering a Qt3D scene
within a Framebuffer object to be used by the QtQuick 2 renderer.
- The Qt3DCore::Scene3DRenderer class renders a Qt3D scene as provided by a Qt3DCore::Scene3DItem.
+ The Scene3DRenderer class renders a Qt3D scene as provided by a Scene3DItem.
It owns the aspectEngine even though it doesn't instantiate it.
The shutdown procedure is a two steps process that goes as follow:
+ \list
\li The window is closed
\li This triggers the windowsChanged signal which the Scene3DRenderer
@@ -112,6 +113,7 @@ private:
\li The destroyed signal of the window is also connected to the
Scene3DRenderer. When triggered in the context of the main thread, the
cleanup slot is called.
+ \endlist
There is an alternate shutdown procedure in case the QQuickItem is
destroyed with an active window which can happen in the case where the