summaryrefslogtreecommitdiffstats
path: root/src/extras
diff options
context:
space:
mode:
authorLiang Qi <liang.qi@qt.io>2019-07-31 15:40:18 +0200
committerLiang Qi <liang.qi@qt.io>2019-07-31 15:40:18 +0200
commitf8a85093097cbd1783f19602513631e06c762fd9 (patch)
tree8109c1a04a578c7a79a25b0a2fe4c1463b0a264c /src/extras
parentf3b6963f8b873c190cc1033cb8dabaf1d63ee2b6 (diff)
parent64e10caaa1c261167fd98f91ce87cbefd11782ca (diff)
Merge remote-tracking branch 'origin/5.13' into dev
Conflicts: tests/manual/manual.pro Change-Id: I15d497da84d3fe684c3a598831171d6aed7534ca
Diffstat (limited to 'src/extras')
-rw-r--r--src/extras/defaults/qskyboxentity.cpp45
1 files changed, 45 insertions, 0 deletions
diff --git a/src/extras/defaults/qskyboxentity.cpp b/src/extras/defaults/qskyboxentity.cpp
index 7de552b38..e82a30950 100644
--- a/src/extras/defaults/qskyboxentity.cpp
+++ b/src/extras/defaults/qskyboxentity.cpp
@@ -238,6 +238,30 @@ void QSkyboxEntityPrivate::reloadTexture()
*/
/*!
+ * \qmltype SkyboxEntity
+ * \instantiates Qt3DExtras::QSkyboxEntity
+ \inqmlmodule Qt3D.Extras
+ *
+ * \brief SkyboxEntity is a convenience Entity subclass that can be used to
+ * insert a skybox in a 3D scene.
+ *
+ * By specifying a base name and an extension, SkyboxEntity will take care of
+ * building a TextureCubeMap to be rendered at runtime. The images in the
+ * source directory should match the pattern: \b base name + *
+ * "_posx|_posy|_posz|_negx|_negy|_negz" + extension
+ *
+ * By default the extension defaults to .png.
+ *
+ * Be sure to disable frustum culling in the FrameGraph through which the
+ * skybox rendering happens.
+ *
+ * \note Please note that you shouldn't try to render a skybox with an
+ * orthographic projection.
+ *
+ * \since 5.5
+ */
+
+/*!
* Constructs a new Qt3DExtras::QSkyboxEntity object with \a parent as parent.
*/
QSkyboxEntity::QSkyboxEntity(QNode *parent)
@@ -269,6 +293,11 @@ void QSkyboxEntity::setBaseName(const QString &baseName)
Contains the base name of the Skybox.
*/
/*!
+ \qmlproperty string QSkyboxEntity::baseName
+
+ Contains the base name of the Skybox.
+*/
+/*!
* Returns the base name of the Skybox.
*/
QString QSkyboxEntity::baseName() const
@@ -298,6 +327,15 @@ void QSkyboxEntity::setExtension(const QString &extension)
The default value is: .png
*/
+
+/*!
+ \qmlproperty string QSkyboxEntity::extension
+
+ Contains the extension of the filename for the skybox image, including the
+ leading '.'.
+
+ The default value is: .png
+*/
/*!
* Returns the extension
*/
@@ -336,5 +374,12 @@ bool QSkyboxEntity::isGammaCorrectEnabled() const
\property QSkyboxEntity::gammaCorrect
A boolean indicating whether gamma correction is enabled.
+ \since 5.9
+*/
+/*!
+ \qmlproperty bool QSkyboxEntity::gammaCorrect
+
+ A boolean indicating whether gamma correction is enabled.
+ \since 5.9
*/
QT_END_NAMESPACE