aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/util
diff options
context:
space:
mode:
authorKim Motoyoshi Kalland <kim.kalland@nokia.com>2012-09-04 16:25:25 +0200
committerQt by Nokia <qt-info@nokia.com>2012-09-05 11:13:56 +0200
commit8c5b720d707d6d36cdb5f6df1645c3045be48680 (patch)
tree5366de3bbc9a6a8f9939cd46246ad7bb7c0eb735 /src/quick/util
parent3f0ebc440a38bed7f9cd130b3934620d57734241 (diff)
Doc: Fix some documentation issues.
Change-Id: I0f7e60fd6060381bd8790dfaacc3a39a890a0fe7 Reviewed-by: aavit <qt_aavit@ovi.com>
Diffstat (limited to 'src/quick/util')
-rw-r--r--src/quick/util/qquickimageprovider.cpp24
1 files changed, 20 insertions, 4 deletions
diff --git a/src/quick/util/qquickimageprovider.cpp b/src/quick/util/qquickimageprovider.cpp
index 49ac80d310..69c426e590 100644
--- a/src/quick/util/qquickimageprovider.cpp
+++ b/src/quick/util/qquickimageprovider.cpp
@@ -61,16 +61,30 @@ public:
Creating a texture directly is not possible as there is rarely an OpenGL context
available in the thread that is responsible for loading the image data.
- */
+*/
+
+/*!
+ Constructs a texture factory. Since QQuickTextureFactory is abstract, it
+ cannot be instantiated directly.
+*/
QQuickTextureFactory::QQuickTextureFactory()
{
}
+/*!
+ Destroys the texture factory.
+*/
+
QQuickTextureFactory::~QQuickTextureFactory()
{
}
+/*!
+ \fn int QQuickTextureFactory::textureByteCount() const
+
+ Returns the number of bytes of memory the texture consumes.
+*/
/*!
\fn QImage QQuickTextureFactory::image() const
@@ -91,10 +105,11 @@ QImage QQuickTextureFactory::image() const
/*!
- \fn QSGTexture *QQuickTextureFactory::createTexture() const
+ \fn QSGTexture *QQuickTextureFactory::createTexture(QQuickWindow *window) const
This function is called on the scene graph rendering thread to create a QSGTexture
- instance from the factory.
+ instance from the factory. \a window provides the context which this texture is
+ created in.
QML will internally cache the returned texture as needed. Each call to this
function should return a unique instance.
@@ -233,7 +248,8 @@ QImage QQuickTextureFactory::image() const
*/
/*!
- Creates an image provider that will provide images of the given \a type.
+ Creates an image provider that will provide images of the given \a type and
+ behave according to the given \a flags.
*/
QQuickImageProvider::QQuickImageProvider(ImageType type, Flags flags)
: d(new QQuickImageProviderPrivate)