summaryrefslogtreecommitdiff
path: root/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/gdk-pixbuf/tmpl/module_interface.sgml')
-rw-r--r--docs/reference/gdk-pixbuf/tmpl/module_interface.sgml6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml b/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml
index c3c86af96..c6e56b89d 100644
--- a/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml
@@ -220,6 +220,12 @@ way to achieve the desired scaling during the loading of the image, it may
either ignore the size request, or only approximate it -- &gdk-pixbuf; will
then perform the required scaling on the completely loaded image.
</para>
+<para>
+If the function sets @width or @height to zero, the module should interpret
+this as a hint that it will be closed soon and shouldn't allocate further
+resources. This convention is used to implement gdk_pixbuf_get_file_info()
+efficiently.
+</para>
@width: pointer to a location containing the current image width
@height: pointer to a location containing the current image height