summaryrefslogtreecommitdiffstats
path: root/src/render/texture/qabstracttextureimage.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/render/texture/qabstracttextureimage.cpp')
-rw-r--r--src/render/texture/qabstracttextureimage.cpp41
1 files changed, 41 insertions, 0 deletions
diff --git a/src/render/texture/qabstracttextureimage.cpp b/src/render/texture/qabstracttextureimage.cpp
index d3694efc9..42e78ced6 100644
--- a/src/render/texture/qabstracttextureimage.cpp
+++ b/src/render/texture/qabstracttextureimage.cpp
@@ -48,6 +48,40 @@ using namespace Qt3DCore;
namespace Qt3DRender {
+/*!
+ \class Qt3DRender::QTextureImageDataGenerator
+ \inmodule Qt3DRender
+ \since 5.7
+ \brief Provides texture image data for QAbstractTextureImage
+
+ QTextureImageDataGenerator is a data provider for QAbstractTexture.
+ QTextureImageDataGenerator can be used to expand Qt3D with more ways to load
+ texture image data as well as support user-defined formats and formats Qt3D
+ does not natively support. The data is returned by the QTextureImageDataPtr
+ which contains the data that will be loaded to the texture.
+ QTextureImageDataGenerator is executed by Aspect jobs in the backend.
+ */
+/*!
+ \typedef Qt3DRender::QTextureImageDataPtr
+ \relates Qt3DRender::QTextureImageDataGenerator
+
+ Shared pointer to \l QTextureImageData.
+*/
+
+/*!
+ \fn QTextureImageDataPtr QTextureImageDataGenerator::operator()()
+
+ Implement the method to return the texture image data.
+*/
+
+/*!
+ \fn bool QTextureImageDataGenerator::operator ==(const QTextureImageDataGenerator &other) const
+
+ Implement the method to compare this texture data generator to \a other.
+ The operator is used to check if the \l QAbstractTextureImage needs to reload
+ the \l QTextureImageData.
+*/
+
QAbstractTextureImagePrivate::QAbstractTextureImagePrivate()
: QNodePrivate(),
m_mipLevel(0),
@@ -90,6 +124,13 @@ QAbstractTextureImagePrivate::~QAbstractTextureImagePrivate()
*/
/*!
+ \fn QTextureImageDataGeneratorPtr QAbstractTextureImage::dataGenerator() const
+
+ Implement this method to return the \l QTextureImageDataGeneratorPtr, which will
+ provide the data for the texture image.
+*/
+
+/*!
Constructs a new QAbstractTextureImage instance with \a parent as parent.
*/
QAbstractTextureImage::QAbstractTextureImage(QNode *parent)