aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlbert Astals Cid <albert.astals@canonical.com>2015-08-14 14:51:34 +0200
committerAlbert Astals Cid <albert.astals@canonical.com>2015-08-19 10:47:22 +0000
commitcfc73960f2d55fa141edbadea7616a7f7f947877 (patch)
tree10a13edd39d6322110eebfe59fda2ad552e5e34f
parent653f4d6ce5851011e52c37b01ef81c7fbc16c26c (diff)
Improve QQuickImageResponse::textureFactory documentation
Change-Id: Id754f1f1454af566cb3cf20f5ca947f972ef2caf Reviewed-by: Robin Burchell <robin.burchell@viroteck.net>
-rw-r--r--src/quick/util/qquickimageprovider.cpp7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/quick/util/qquickimageprovider.cpp b/src/quick/util/qquickimageprovider.cpp
index 89615a2079..5d492a4e75 100644
--- a/src/quick/util/qquickimageprovider.cpp
+++ b/src/quick/util/qquickimageprovider.cpp
@@ -194,8 +194,11 @@ void QQuickImageResponse::cancel()
\fn QQuickTextureFactory *QQuickImageResponse::textureFactory() const
Returns the texture factory for the job. You can use QQuickTextureFactory::textureFactoryForImage
- if your provider works with QImage. This method is only called when the error string is not empty and the
- engine takes ownership of the returned QQuickTextureFactory.
+ if your provider works with QImage. The engine takes ownership of the returned QQuickTextureFactory.
+
+ \note This method will be called only when needed. For example, it may not be called if there is an
+ error or the job is cancelled. Therefore, allocate the QQuickTextureFactory instance only in this
+ method or otherwise ensure its deletion.
*/