summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2019-09-05 13:49:19 +0200
committerTopi Reiniƶ <topi.reinio@qt.io>2019-09-27 10:48:20 +0000
commitbd3aa578b8d822840fc3d4a6ef819b29b2c26034 (patch)
tree430e91f0803a82f6ae65ed077dd5057bc98bd25f
parent7b7d3cbb23eab884577f2341deb25bdd36c4cae6 (diff)
Doc: Fix documentation issues for Qt3DRender::QTexture* classes
Fixes: QTWEBSITE-878 Change-Id: I8a4ac1de75dfb8ec4ff784a01d3e4abbc031a7ba Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
-rw-r--r--src/render/texture/qtexture.cpp26
1 files changed, 24 insertions, 2 deletions
diff --git a/src/render/texture/qtexture.cpp b/src/render/texture/qtexture.cpp
index 0e652c6ff..59857ea53 100644
--- a/src/render/texture/qtexture.cpp
+++ b/src/render/texture/qtexture.cpp
@@ -1036,6 +1036,7 @@ void TextureDownloadRequest::onCompleted()
/*!
\class Qt3DRender::QTexture1D
+ \inheaderfile Qt3DRender/QTexture
\inmodule Qt3DRender
\since 5.5
\brief A QAbstractTexture with a Target1D target format.
@@ -1056,6 +1057,7 @@ QTexture1D::~QTexture1D()
/*!
\class Qt3DRender::QTexture1DArray
+ \inheaderfile Qt3DRender/QTexture
\inmodule Qt3DRender
\since 5.5
\brief A QAbstractTexture with a Target1DArray target format.
@@ -1076,6 +1078,7 @@ QTexture1DArray::~QTexture1DArray()
/*!
\class Qt3DRender::QTexture2D
+ \inheaderfile Qt3DRender/QTexture
\inmodule Qt3DRender
\since 5.5
\brief A QAbstractTexture with a Target2D target format.
@@ -1096,6 +1099,7 @@ QTexture2D::~QTexture2D()
/*!
\class Qt3DRender::QTexture2DArray
+ \inheaderfile Qt3DRender/QTexture
\inmodule Qt3DRender
\since 5.5
\brief A QAbstractTexture with a Target2DArray target format.
@@ -1116,6 +1120,7 @@ QTexture2DArray::~QTexture2DArray()
/*!
\class Qt3DRender::QTexture3D
+ \inheaderfile Qt3DRender/QTexture
\inmodule Qt3DRender
\since 5.5
\brief A QAbstractTexture with a Target3D target format.
@@ -1136,6 +1141,7 @@ QTexture3D::~QTexture3D()
/*!
\class Qt3DRender::QTextureCubeMap
+ \inheaderfile Qt3DRender/QTexture
\inmodule Qt3DRender
\since 5.5
\brief A QAbstractTexture with a TargetCubeMap target format.
@@ -1156,6 +1162,7 @@ QTextureCubeMap::~QTextureCubeMap()
/*!
\class Qt3DRender::QTextureCubeMapArray
+ \inheaderfile Qt3DRender/QTexture
\inmodule Qt3DRender
\since 5.5
\brief A QAbstractTexture with a TargetCubeMapArray target format.
@@ -1176,6 +1183,7 @@ QTextureCubeMapArray::~QTextureCubeMapArray()
/*!
\class Qt3DRender::QTexture2DMultisample
+ \inheaderfile Qt3DRender/QTexture
\inmodule Qt3DRender
\since 5.5
\brief A QAbstractTexture with a Target2DMultisample target format.
@@ -1196,6 +1204,7 @@ QTexture2DMultisample::~QTexture2DMultisample()
/*!
\class Qt3DRender::QTexture2DMultisampleArray
+ \inheaderfile Qt3DRender/QTexture
\inmodule Qt3DRender
\since 5.5
\brief A QAbstractTexture with a Target2DMultisampleArray target format.
@@ -1216,6 +1225,7 @@ QTexture2DMultisampleArray::~QTexture2DMultisampleArray()
/*!
\class Qt3DRender::QTextureRectangle
+ \inheaderfile Qt3DRender/QTexture
\inmodule Qt3DRender
\since 5.5
\brief A QAbstractTexture with a TargetRectangle target format.
@@ -1236,6 +1246,7 @@ QTextureRectangle::~QTextureRectangle()
/*!
\class Qt3DRender::QTextureBuffer
+ \inheaderfile Qt3DRender/QTexture
\inmodule Qt3DRender
\since 5.5
\brief A QAbstractTexture with a TargetBuffer target format.
@@ -1275,6 +1286,7 @@ void QTextureLoaderPrivate::updateGenerator()
/*!
\class Qt3DRender::QTextureLoader
+ \inheaderfile Qt3DRender/QTexture
\inmodule Qt3DRender
\brief Handles the texture loading and setting the texture's properties.
*/
@@ -1488,7 +1500,9 @@ bool QTextureFromSourceGenerator::isMirrored() const
}
/*!
- * \class QSharedGLTexture
+ * \class Qt3DRender::QSharedGLTexture
+ * \inmodule Qt3DRender
+ * \inheaderfile Qt3DRender/QTexture
* \brief Allows to use a textureId from a separate OpenGL context in a Qt 3D scene.
*
* Depending on the rendering mode used by Qt 3D, the shared context will either be:
@@ -1515,6 +1529,14 @@ bool QTextureFromSourceGenerator::isMirrored() const
* specify the correct sampler type to be used.
*/
+/*!
+ \qmltype SharedGLTexture
+ \instantiates Qt3DRender::QSharedGLTexture
+ \inqmlmodule Qt3D.Render
+ \brief Allows to use a textureId from a separate OpenGL context in a Qt 3D scene.
+ \since 5.13
+*/
+
QSharedGLTexture::QSharedGLTexture(Qt3DCore::QNode *parent)
: QAbstractTexture(parent)
{
@@ -1527,7 +1549,7 @@ QSharedGLTexture::~QSharedGLTexture()
}
/*!
- * \qmlproperty textureId
+ * \qmlproperty int SharedGLTexture::textureId
*
* The OpenGL texture id value that you want Qt3D to gain access to.
*/