summaryrefslogtreecommitdiff
path: root/doc/public/xml/cairo-image.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/public/xml/cairo-image.xml')
-rw-r--r--doc/public/xml/cairo-image.xml6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/public/xml/cairo-image.xml b/doc/public/xml/cairo-image.xml
index 9c46882..9299114 100644
--- a/doc/public/xml/cairo-image.xml
+++ b/doc/public/xml/cairo-image.xml
@@ -260,6 +260,12 @@ destroy-notification fallback to the surface if necessary.
<para>
Get a pointer to the data of the image surface, for direct
inspection or modification.
+</para>
+<para>
+A call to <link linkend="cairo-surface-flush"><function>cairo_surface_flush()</function></link> is required before accessing the
+pixel data to ensure that all pending drawing operations are
+finished. A call to <link linkend="cairo-surface-mark-dirty"><function>cairo_surface_mark_dirty()</function></link> is required after
+the data is modified.
</para><variablelist role="params">
<varlistentry><term><parameter>surface</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="cairo-image-surface-t"><type>cairo_image_surface_t</type></link>