summaryrefslogtreecommitdiff
path: root/docs/reference
diff options
context:
space:
mode:
authorMatthias Clasen <matthiasc@src.gnome.org>2001-10-30 23:58:00 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2001-10-30 23:58:00 +0000
commita5b8d8c1158967110f968766750acfcc479af26c (patch)
treeaf599a8fdbbea9e6ade18185fbab17833b998665 /docs/reference
parent7d02abe46e5682387134546404a112a0adc173c2 (diff)
downloadgdk-pixbuf-a5b8d8c1158967110f968766750acfcc479af26c.tar.gz
Updates. (#63293)
* gdk-pixbuf/gdk-pixbuf-sections.txt, gdk-pixbuf/tmpl/animation.sgml, gdk-pixbuf/tmpl/module_interface.sgml: Updates. (#63293)
Diffstat (limited to 'docs/reference')
-rw-r--r--docs/reference/ChangeLog6
-rw-r--r--docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt15
-rw-r--r--docs/reference/gdk-pixbuf/tmpl/animation.sgml6
-rw-r--r--docs/reference/gdk-pixbuf/tmpl/module_interface.sgml71
4 files changed, 57 insertions, 41 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 7235391e5..6d748cf57 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,9 @@
+2001-10-31 Matthias Clasen <matthiasc@poet.de>
+
+ * gdk-pixbuf/gdk-pixbuf-sections.txt,
+ gdk-pixbuf/tmpl/animation.sgml,
+ gdk-pixbuf/tmpl/module_interface.sgml: Updates. (#63293)
+
2001-10-28 Anders Carlsson <andersca@gnu.org>
* gtk/tmpl/gtkadjustment.sgml: Update struct member docs
diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt b/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt
index 871c56862..adf386585 100644
--- a/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt
+++ b/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt
@@ -98,28 +98,17 @@ gdk_pixbuf_fill
<SECTION>
<FILE>animation</FILE>
-GdkPixbufFrameAction
GdkPixbufFrame
GdkPixbufAnimation
GdkPixbufAnimationIter
-GdkPixbufGifAnim
gdk_pixbuf_animation_new_from_file
gdk_pixbuf_animation_ref
gdk_pixbuf_animation_unref
-gdk_pixbuf_animation_get_frames
gdk_pixbuf_animation_get_width
-gdk_pixbuf_animation_get_num_frames
gdk_pixbuf_animation_get_height
gdk_pixbuf_animation_get_iter
gdk_pixbuf_animation_is_static_image
gdk_pixbuf_animation_get_static_image
-gdk_pixbuf_frame_copy
-gdk_pixbuf_frame_free
-gdk_pixbuf_frame_get_pixbuf
-gdk_pixbuf_frame_get_action
-gdk_pixbuf_frame_get_y_offset
-gdk_pixbuf_frame_get_delay_time
-gdk_pixbuf_frame_get_x_offset
gdk_pixbuf_animation_iter_advance
gdk_pixbuf_animation_iter_get_delay_time
gdk_pixbuf_animation_iter_on_currently_loading_frame
@@ -129,13 +118,11 @@ gdk_pixbuf_animation_iter_get_pixbuf
GDK_PIXBUF_ANIMATION
GDK_TYPE_PIXBUF_ANIMATION
GDK_IS_PIXBUF_ANIMATION
-GDK_TYPE_PIXBUF_FRAME
GDK_IS_PIXBUF_ANIMATION_ITER
GDK_PIXBUF_ANIMATION_ITER
GDK_TYPE_PIXBUF_ANIMATION_ITER
<SUBSECTION Private>
-gdk_pixbuf_frame_get_type
gdk_pixbuf_animation_get_type
gdk_pixbuf_animation_iter_get_type
</SECTION>
@@ -183,8 +170,6 @@ gdk_pixbuf_loader_get_type
ModuleFillVtableFunc
ModulePreparedNotifyFunc
ModuleUpdatedNotifyFunc
-ModuleFrameDoneNotifyFunc
-ModuleAnimationDoneNotifyFunc
GdkPixbufModule
</SECTION>
diff --git a/docs/reference/gdk-pixbuf/tmpl/animation.sgml b/docs/reference/gdk-pixbuf/tmpl/animation.sgml
index 742169e7a..72115ad4a 100644
--- a/docs/reference/gdk-pixbuf/tmpl/animation.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/animation.sgml
@@ -20,9 +20,10 @@ Animated images.
#GdkPixbufLoader
</para>
+
<!-- ##### STRUCT GdkPixbufFrame ##### -->
<para>
-
+ This object describes an individual frame of an animation.
</para>
@@ -34,7 +35,8 @@ Animated images.
<!-- ##### STRUCT GdkPixbufAnimationIter ##### -->
<para>
-
+A #GdkPixbufAnimationIter provides the necessary functionality to
+display an animation. See gdk_pixbuf_animation_get_iter().
</para>
diff --git a/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml b/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml
index 139ee467d..f0cca4fd4 100644
--- a/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml
@@ -16,48 +16,71 @@ Module Interface
<!-- ##### USER_FUNCTION ModuleFillVtableFunc ##### -->
<para>
-
+Defines the type of the function used to set the vtable of a
+#GdkPixbufModule when it is loaded.
</para>
-@module:
+@module: a #GdkPixbufModule.
<!-- ##### USER_FUNCTION ModulePreparedNotifyFunc ##### -->
<para>
-
+Defines the type of the function that gets called once the initial
+setup of @pixbuf is done.
+</para>
+<para>
+#GdkPixbufLoader uses a function of this type to emit the
+"<link linkend="GdkPixbufLoader-area-prepared">area_prepared</link>"
+signal.
</para>
-@pixbuf:
-@anim:
-@user_data:
+@pixbuf: the #GdkPixbuf that is currently being loaded.
+@anim: if an animation is being loaded, the #GdkPixbufAnimation, else %NULL.
+@user_data: the loader.
<!-- ##### USER_FUNCTION ModuleUpdatedNotifyFunc ##### -->
<para>
-
+Defines the type of the function that gets called every time a region
+of @pixbuf is updated.
+</para>
+<para>
+#GdkPixbufLoader uses a function of this type to emit the
+"<link linkend="GdkPixbufLoader-area-updated">area_updated</link>"
+signal.
</para>
-@pixbuf:
-@x:
-@y:
-@width:
-@height:
-@user_data:
+@pixbuf: the #GdkPixbuf that is currently being loaded.
+@x: the X origin of the updated area.
+@y: the Y origin of the updated area.
+@width: the width of the updated area.
+@height: the height of the updated area.
+@user_data: the loader.
<!-- ##### STRUCT GdkPixbufModule ##### -->
<para>
-
+A #GdkPixbufModule contains the necessary functions to load and save
+images in a certain file format.
+</para>
+<para>
+A #GdkPixbufModule can be loaded dynamically from a #GModule.
+Each loadable module must contain a #ModuleFillVtableFunc function named
+<funcion>gdk_pixbuf__<replaceable>module_name</replaceable>_fill_vtable</function>.
+It will get called when the module is loaded and must set the function
+pointers of the #GdkPixbufModule.
</para>
-@module_name:
-@format_check:
-@module:
-@load:
-@load_xpm_data:
-@begin_load:
-@stop_load:
-@load_increment:
-@load_animation:
-@save:
+@module_name: the name of the module, usually the same as the
+ usual file extension for images of this type, eg. "xpm", "jpeg" or "png".
+@format_check: checks if the given data is the beginning of a valid image
+ in the format supported by the module.
+@module: the loaded #GModule.
+@load: loads an image from a file.
+@load_xpm_data: loads an image from data in memory.
+@begin_load: begins an incremental load.
+@stop_load: stops an incremental load.
+@load_increment: continues an incremental load.
+@load_animation: loads an animation from a file.
+@save: saves a #GdkPixbuf to a file.