summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim Janik <timj@gtk.org>2000-10-25 22:34:14 +0000
committerTim Janik <timj@src.gnome.org>2000-10-25 22:34:14 +0000
commitd69496c06092c0b8943b7240761ae27401c65e9f (patch)
tree600e6c46af603a9c4f8ca22954cc815466aa04c2 /docs
parent7ae3922d2cdc89cba86694f7e46393a629b12b61 (diff)
downloadgtk+-d69496c06092c0b8943b7240761ae27401c65e9f.tar.gz
urg, removed implementation of gtk_marshal_VOID__INT_INT_INT_INT. if
Wed Oct 25 20:47:41 2000 Tim Janik <timj@gtk.org> * gtk/gdk-pixbuf-loader.c (gdk_pixbuf_loader_class_init): urg, removed implementation of gtk_marshal_VOID__INT_INT_INT_INT. if people do that, couldn't they at least give it a non-standard name? * gtk/gtktextlayout.c: arg! yet another implementation of gtk_marshal_VOID__INT_INT_INT_INT(), is this a conspiracy? * gtk/gtktextbuffer.c: gotcha! captured a vagabonding gtk_marshal_VOID__INT_POINTER_INT() implementation, braught it back home. now i know this _is_ a conspiracy. * gtk/gtkwidget.c (gtk_widget_class_init): marshaller fixups for ::state-changed. * gtk/gtkaccelgroup.c (gtk_accel_group_create_remove): (gtk_accel_group_create_add): marshaller signature fixups. * gtk/gtklistitem.c (gtk_list_item_class_init): signal creation fixups, pass in GTK_TYPE_SCROLL_TYPE instead of GTK_TYPE_ENUM. * gtk/gtkobject.[hc]: removed GTK_CONNECTED flag, it's not valid anymore. Tue Oct 24 23:59:21 2000 Tim Janik <timj@gtk.org> * docs/reference/Makefile.am: disabled SUBDIRS for the moment, since due to the signal system changes, it wouldn't build currently. to be fixed soon. * docs/Changes-2.0.txt: GtkSignal/GSignal updates. * gtk/gtkwidget.c: ::direction_changed takes an enum as argument, so it needs gtk_marshal_VOID__ENUM() instead of gtk_marshal_NONE__UINT(). * gdk/gdk*.c: adapted type registration functions. * gtk/gtkbindings.c: * gtk/gtkaccelgroup.c: operate on GSignalQuery, GtkSignalQuery is gone. * gtk/gtkenums.h: define GtkSignalRunType in terms of GSignalType. * gtk/gtkobject.c: (gtk_object_destroy): (gtk_object_shutdown): fixed recursion guards. basically we have to catch the case where any of GObject.shutdown() or gtk_object_destroy() is called during ::destroy, and avoid recursion there. * gtk/gtktypeutils.c: * gtk/maketypes.awk: awk-script hackup to provide gtk_type_init() with boxed_copy/boxed_free. this needs a more general solution based on a publically installed code-generator utility. * gtk/gtktypeutils.[hc]: compat aliased GTK_TYPE_BOXED to G_TYPE_BOXED, glib's gobject has support for that now. define GtkSignalMarshaller in terms of GSignalCMarshaller. Mon Oct 23 09:36:42 2000 Tim Janik <timj@gtk.org> * gtk/gtksignal.[hc]: * gtk/gtkmarshal.[hc]: * gtk/Makefile.am: generate marshallers with glib-genmarshal and don't compile gtkmarshal.c on its own anymore, just include it in gtksignal.c. removed #include <gtkmarshal.h>s all over the place, gtksignal.h takes care of that. * *.c: marshaller name fixups. * gtk/gtkmarshal.list: added a comment briefing the format. Sun Oct 22 23:14:39 2000 Tim Janik <timj@gtk.org> * gtk/gtksignal.[hc]: nuked old implementation. we mostly have compatibility macros here now. more specifically, most of the API is preserved (yes, _most_, nonwithstanding the following exceptions listed, the API is stil lHUGE ;) things that got removed completely: GtkSignalQuery, gtk_signal_query(), gtk_signal_n_emissions(), gtk_signal_n_emissions_by_name(), gtk_signal_handlers_destroy(), gtk_signal_set_funcs(), gtk_signal_handler_pending_by_id(), gtk_signal_add_emission_hook(), gtk_signal_add_emission_hook_full(), gtk_signal_remove_emission_hook(). non-functional functions variants: gtk_signal_add_emission_hook(), gtk_signal_remove_emission_hook(). the GtkCallbackMarshal argument to gtk_signal_connect_full() is not supported anymore. (gtk_signal_compat_matched): new internal function to aid implementation of the compatibility macros, it provides functionality to block/unblock/disconnect handlers based on func/data. * gtk/gtkenums.h: define GtkSignalRunType in terms of GSignalType, * *.c: adaptions to new type registration API signatures. Fri Oct 20 15:26:33 2000 Tim Janik <timj@gtk.org> * gtk/gtktypeutils.[hc]: removed G_TYPE_GTK_POINTER cludge.
Diffstat (limited to 'docs')
-rw-r--r--docs/Changes-2.0.txt20
-rw-r--r--docs/reference/Makefile.am2
-rw-r--r--docs/reference/gdk-pixbuf/tmpl/animation.sgml144
-rw-r--r--docs/reference/gdk-pixbuf/tmpl/creating.sgml65
-rw-r--r--docs/reference/gdk-pixbuf/tmpl/file-loading.sgml15
-rw-r--r--docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml1348
-rw-r--r--docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml132
-rw-r--r--docs/reference/gdk-pixbuf/tmpl/initialization_versions.sgml59
-rw-r--r--docs/reference/gdk-pixbuf/tmpl/module_interface.sgml88
-rw-r--r--docs/reference/gdk-pixbuf/tmpl/refcounting.sgml31
-rw-r--r--docs/reference/gdk-pixbuf/tmpl/scaling.sgml124
-rw-r--r--docs/reference/gdk-pixbuf/tmpl/util.sgml44
-rw-r--r--docs/reference/gdk/tmpl/gdk-unused.sgml196
-rw-r--r--docs/reference/gdk/tmpl/input_devices.sgml6
-rw-r--r--docs/reference/gdk/tmpl/threads.sgml6
15 files changed, 1124 insertions, 1156 deletions
diff --git a/docs/Changes-2.0.txt b/docs/Changes-2.0.txt
index 437d73ffb7..0cdca5a4ee 100644
--- a/docs/Changes-2.0.txt
+++ b/docs/Changes-2.0.txt
@@ -106,6 +106,26 @@ Incompatible Changes from GTK+-1.2 to GTK+-1.4:
have to be moved into the ::destroy implementations. The reason for doing
this is that all object reference cycles should be broken at destruction
time.
+
+* Signal system changes:
+ The Gtk 2.0 signal merly proxies the GSignal system now.
+ For future usage, direct use of the GSignal API is recommended,
+ this avoids significant performance hits where GtkArg structures
+ have to be converted into GValues. For language bindings,
+ GSignal+GClosure provide a much more flexible and convenient
+ mechanism to hook into signal emissions or install class default
+ handlers, so the old GtkSignal API for language bindings is not
+ supported anymore.
+ Functions that got removed in the Gtk signal API:
+ gtk_signal_n_emissions(), gtk_signal_n_emissions_by_name(),
+ gtk_signal_set_funcs(), gtk_signal_handler_pending_by_id(),
+ gtk_signal_add_emission_hook(), gtk_signal_add_emission_hook_full(),
+ gtk_signal_remove_emission_hook(), gtk_signal_query().
+ gtk_signal_add_emission_hook(), gtk_signal_remove_emission_hook().
+ Also, the GtkCallbackMarshal argument to gtk_signal_connect_full() is
+ not supported anymore.
+ For many of the removed functions, similar variants are available
+ in the g_signal_* namespace.
- Inserting and deleting text in GtkEntry though functions such
as gtk_entry_insert_text() now leave the cursor at its original
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 2cd7f681da..38a74371d9 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -1,3 +1,3 @@
## Process this file with automake to produce Makefile.in
-SUBDIRS = gdk-pixbuf gdk gtk \ No newline at end of file
+#SUBDIRS = gdk-pixbuf gdk gtk
diff --git a/docs/reference/gdk-pixbuf/tmpl/animation.sgml b/docs/reference/gdk-pixbuf/tmpl/animation.sgml
index c8bff9b017..7a86308a2e 100644
--- a/docs/reference/gdk-pixbuf/tmpl/animation.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/animation.sgml
@@ -18,147 +18,3 @@ Animations as multi-frame structures.
#GdkPixbufLoader
</para>
-<!-- ##### ENUM GdkPixbufFrameAction ##### -->
- <para>
- Each animation frame can have several things happen to it when the
- next frame is displayed. The #GdkPixbufFrameAction determines
- this. These are essentially the overlay modes supported by GIF
- animations.
- </para>
-
-@GDK_PIXBUF_FRAME_RETAIN: The previous image should remain displayed,
-and will potentially be occluded by the new frame.
-@GDK_PIXBUF_FRAME_DISPOSE: The animation will be reverted to the state
-before the frame was shown.
-@GDK_PIXBUF_FRAME_REVERT: The animation will be reverted to the first
-frame.
-
-<!-- ##### STRUCT GdkPixbufFrame ##### -->
- <para>
- This structure describes a frame in a #GdkPixbufAnimation. Each
- frame consists of a #GdkPixbuf, an offset of the frame within the
- animation's bounding box, a duration, and an overlay mode or
- action.
- </para>
-
-
-<!-- ##### STRUCT GdkPixbufAnimation ##### -->
- <para>
- This structure describes an animation, which is represented as a
- list of #GdkPixbufFrame structures.
- </para>
-
-
-<!-- ##### FUNCTION gdk_pixbuf_animation_new_from_file ##### -->
-<para>
-
-</para>
-
-@filename:
-@error:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_animation_ref ##### -->
-<para>
-
-</para>
-
-@animation:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_animation_unref ##### -->
-<para>
-
-</para>
-
-@animation:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_animation_get_frames ##### -->
-<para>
-
-</para>
-
-@animation:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_animation_get_width ##### -->
-<para>
-
-</para>
-
-@animation:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_animation_get_num_frames ##### -->
-<para>
-
-</para>
-
-@animation:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_animation_get_height ##### -->
-<para>
-
-</para>
-
-@animation:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_pixbuf ##### -->
-<para>
-
-</para>
-
-@frame:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_action ##### -->
-<para>
-
-</para>
-
-@frame:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_y_offset ##### -->
-<para>
-
-</para>
-
-@frame:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_delay_time ##### -->
-<para>
-
-</para>
-
-@frame:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_x_offset ##### -->
-<para>
-
-</para>
-
-@frame:
-@Returns: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
-
-
diff --git a/docs/reference/gdk-pixbuf/tmpl/creating.sgml b/docs/reference/gdk-pixbuf/tmpl/creating.sgml
index b98b4024fa..72ca320a18 100644
--- a/docs/reference/gdk-pixbuf/tmpl/creating.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/creating.sgml
@@ -43,68 +43,3 @@ Creating a pixbuf from image data that is already in memory.
gdk_pixbuf_finalize().
</para>
-<!-- ##### FUNCTION gdk_pixbuf_new ##### -->
-<para>
-
-</para>
-
-@colorspace:
-@has_alpha:
-@bits_per_sample:
-@width:
-@height:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_new_from_data ##### -->
-<para>
-
-</para>
-
-@data:
-@colorspace:
-@has_alpha:
-@bits_per_sample:
-@width:
-@height:
-@rowstride:
-@destroy_fn:
-@destroy_fn_data:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_new_from_xpm_data ##### -->
-<para>
-
-</para>
-
-@data:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_new_from_inline ##### -->
-<para>
-
-</para>
-
-@inline_pixbuf:
-@copy_pixels:
-@length:
-@error:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_copy ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@Returns: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
-
-
diff --git a/docs/reference/gdk-pixbuf/tmpl/file-loading.sgml b/docs/reference/gdk-pixbuf/tmpl/file-loading.sgml
index 7025c7edd5..149903b437 100644
--- a/docs/reference/gdk-pixbuf/tmpl/file-loading.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/file-loading.sgml
@@ -25,18 +25,3 @@ Loading a pixbuf from a file.
#GdkPixbufLoader.
</para>
-<!-- ##### FUNCTION gdk_pixbuf_new_from_file ##### -->
-<para>
-
-</para>
-
-@filename:
-@error:
-@Returns: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
-
-
diff --git a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml
index 456531628e..41b1751d2e 100644
--- a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml
@@ -1,102 +1,9 @@
-<!-- ##### USER_FUNCTION GdkPixbufLastUnref ##### -->
- <para>
- A function of this type can be used to override the default
- operation when a pixbuf loses its last reference, i.e. when
- gdk_pixbuf_unref() is called on a #GdkPixbuf structure that has a
- reference count of 1. This function should determine whether to
- finalize the pixbuf by calling gdk_pixbuf_finalize(), or whether
- to just resume normal execution. The last unref handler for a
- #GdkPixbuf can be set using the
- gdk_pixbuf_set_last_unref_handler() function. By default, pixbufs
- will be finalized automatically if no last unref handler has been
- defined.
- </para>
-
-@pixbuf: The pixbuf that is losing its last reference.
-@data: User closure data.
-
-<!-- ##### SECTION ./tmpl/from-drawables.sgml:Title ##### -->
-Drawables to Pixbufs
-
-
-<!-- ##### ARG GnomeCanvasPixbuf:height_pixels ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/rendering.sgml:See_Also ##### -->
- <para>
- GdkRGB
- </para>
-
-
-<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:Title ##### -->
-X Drawables to Pixbufs
-
-
-<!-- ##### FUNCTION gdk_pixbuf_render_pixmap_and_mask ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@pixmap_return:
-@mask_return:
-@alpha_threshold: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
-
-<!-- ##### ARG GnomeCanvasPixbuf:width ##### -->
- <para>
- Indicates the width the pixbuf will be scaled to. This argument
- will only be used if the <link
- linkend="GnomeCanvasPixbuf--width-set">width_set</link> argument
- is %TRUE. If the <link
- linkend="GnomeCanvasPixbuf--width-in-pixels">width_in_pixels</link>
- argument is %FALSE, the width will be taken to be in canvas units,
- and thus will be scaled along with the canvas item's affine
- transformation. If width_in_pixels is %TRUE, the width will be
- taken to be in pixels, and will visually remain a constant size
- even if the item's affine transformation changes.
- </para>
-
-
-<!-- ##### FUNCTION gdk_pixbuf_render_to_drawable ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_get_rowstride ##### -->
<para>
</para>
@pixbuf:
-@drawable:
-@gc:
-@src_x:
-@src_y:
-@dest_x:
-@dest_y:
-@width:
-@height:
-@dither:
-@x_dither:
-@y_dither:
-
-<!-- ##### FUNCTION gdk_pixbuf_get_from_drawable ##### -->
-<para>
-
-</para>
-
-@dest:
-@src:
-@cmap:
-@src_x:
-@src_y:
-@dest_x:
-@dest_y:
-@width:
-@height:
@Returns: <!--
Local variables:
mode: sgml
@@ -104,104 +11,56 @@ sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
End:
-->
-<!-- ##### ARG GnomeCanvasPixbuf:x ##### -->
- <para>
- Indicates the horizontal translation offset of the pixbuf item's
- image. This offset may not actually appear horizontal, since it
- will be affected by the item's affine transformation. The default
- is 0.0.
- </para>
-
-
-<!-- ##### ARG GnomeCanvasPixbuf:y ##### -->
+<!-- ##### ARG GnomeCanvasPixbuf:width_in_pixels ##### -->
<para>
- Indicates the vertical translation offset of the pixbuf item's
- image. Works in the same way as the <link
- linkend="GnomeCanvasPixbuf--x">x</link> argument. The default is
- 0.0.
+ If this argument is %TRUE, then the width of the pixbuf will be
+ considered to be in pixels, that is, it will not be visually
+ scaled even if the item's affine transformation changes. If this
+ is %FALSE, then the width of the pixbuf will be considered to be
+ in canvas units, and so will be scaled normally by affine
+ transformations. The default is %FALSE.
</para>
-<!-- ##### SECTION ./tmpl/xlib-init.sgml:Short_Description ##### -->
-Initializing the &gdk-pixbuf; Xlib library.
-
-
-<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:Long_Description ##### -->
- <para>
- The functions in this section allow you to take the image data
- from an X drawable and dump it into a #GdkPixbuf. This can be
- used for screenshots and other special effects. Note that these
- operations can be expensive, since the image data has to be
- transferred from the X server to the client program and converted.
- </para>
-
+<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:See_Also ##### -->
<para>
- These functions are analogous to those for the Gdk version of
- &gdk-pixbuf;.
+ GdkRGB
</para>
-<!-- ##### FUNCTION gdk_pixbuf_new_from_art_pixbuf ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_load_module ##### -->
<para>
</para>
-@art_pixbuf:
+@image_module:
+@error:
@Returns:
-<!-- ##### SECTION ./tmpl/xlib-init.sgml:See_Also ##### -->
- <para>
- XlibRGB
- </para>
-
-
-<!-- ##### ARG GnomeCanvasPixbuf:y_in_pixels ##### -->
- <para>
- Works in the same way as the <link
- linkend="GnomeCanvasPixbuf--x-in-pixels">x_in_pixels</link>
- argument, but controls whether the <link
- linkend="GnomeCanvasPixbuf--y">y</link> translation offset is
- scaled or not. The default is %FALSE.
- </para>
-
-<!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
-
-
<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:See_Also ##### -->
<para>
#GnomeCanvas, #GdkPixbuf
</para>
-<!-- ##### ARG GnomeCanvasPixbuf:pixbuf ##### -->
- <para>
- Contains a pointer to a #GdkPixbuf structure that will be used by
- the pixbuf canvas item as an image source. When a pixbuf is set
- its reference count is incremented; if the pixbuf item kept a
- pointer to another #GdkPixbuf structure, the reference count of
- this structure will be decremented. Also, the GdkPixbuf's
- reference count will automatically be decremented when the
- #GnomeCanvasPixbuf item is destroyed. When a pixbuf is queried, a
- reference count will not be added to the return value; you must do
- this yourself if you intend to keep the pixbuf structure around.
- </para>
+<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Short_Description ##### -->
-<!-- ##### ARG GnomeCanvasPixbuf:y_pixels ##### -->
+
+<!-- ##### ENUM GdkPixbufError ##### -->
<para>
</para>
+@GDK_PIXBUF_ERROR_CORRUPT_IMAGE:
+@GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY:
+@GDK_PIXBUF_ERROR_BAD_OPTION_VALUE:
+@GDK_PIXBUF_ERROR_UNKNOWN_TYPE:
+@GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION:
+@GDK_PIXBUF_ERROR_FAILED:
-<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:See_Also ##### -->
- <para>
- GdkRGB
- </para>
+<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:Short_Description ##### -->
+Canvas item to display #GdkPixbuf images.
<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:Long_Description ##### -->
@@ -217,132 +76,81 @@ End:
</para>
-<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:Short_Description ##### -->
-Canvas item to display #GdkPixbuf images.
-
+<!-- ##### FUNCTION gdk_pixbuf_render_threshold_alpha ##### -->
+<para>
-<!-- ##### ARG GnomeCanvasPixbuf:x_in_pixels ##### -->
- <para>
- If this argument is %TRUE, the pixbuf's translation with respect
- to its logical origin in item-relative coordinates will be in
- pixels, that is, the visible offset will not change even if the
- item's affine transformation changes. If it is %FALSE, the
- pixbuf's translation will be taken to be in canvas units, and thus
- will change along with the item's affine transformation. The
- default is %FALSE.
- </para>
+</para>
+@pixbuf:
+@bitmap:
+@src_x:
+@src_y:
+@dest_x:
+@dest_y:
+@width:
+@height:
+@alpha_threshold:
-<!-- ##### SECTION ./tmpl/from-drawables.sgml:Long_Description ##### -->
+<!-- ##### SECTION ./tmpl/rendering.sgml:Long_Description ##### -->
<para>
- The functions in this section allow you to take the image data
- from a GDK drawable and dump it into a #GdkPixbuf. This can be
- used for screenshots and other special effects. Note that these
- operations can be expensive, since the image data has to be
- transferred from the X server to the client program and converted.
+ The &gdk-pixbuf; library provides several convenience functions to
+ render pixbufs to GDK drawables. It uses the GdkRGB to render the
+ image data.
</para>
-
-<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Long_Description ##### -->
<para>
- The XlibRGB set of functions is a port of the GdkRGB library to
- use plain Xlib and X drawables. You can use these functions to
- render RGB buffers into drawables very quickly with high-quality
- dithering.
+ At this point there is not a standard alpha channel extension for
+ the X Window System, so it is not possible to use full opacity
+ information when painting images to arbitrary drawables. The
+ &gdk-pixbuf; convenience functions will threshold the opacity
+ information to create a bi-level clipping mask (black and white),
+ and use that to draw the image onto a drawable.
</para>
-
-<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Short_Description ##### -->
-Functions for rendering RGB buffers to X drawables.
+ <important>
+ <para>
+ Since these functions use GdkRGB for rendering, you must
+ initialize GdkRGB before using any of them. You can do this by
+ calling gdk_rgb_init() near the beginning of your program.
+ </para>
+ </important>
-<!-- ##### MACRO GNOME_CANVAS_PIXBUF ##### -->
- <para>
- Casts a #GtkOjbect to a #GnomeCanvasPixbuf.
- </para>
+<!-- ##### SECTION ./tmpl/xlib-init.sgml:Title ##### -->
+&gdk-pixbuf; Xlib initialization
-@obj: A GTK+ object.
-<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:See_Also ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_saturate_and_pixelate ##### -->
<para>
</para>
+@src:
+@dest:
+@saturation:
+@pixelate:
-<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:Short_Description ##### -->
-Rendering a pixbuf to an X drawable.
-
-
-<!-- ##### FUNCTION gdk_pixbuf_finalize ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_get_height ##### -->
<para>
</para>
-@pixbuf: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
-
-<!-- ##### SECTION ./tmpl/rendering.sgml:Short_Description ##### -->
-Rendering a pixbuf to a GDK drawable.
-
+@pixbuf:
+@Returns:
-<!-- ##### FUNCTION gdk_pixbuf_set_last_unref_handler ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_get_bits_per_sample ##### -->
<para>
</para>
@pixbuf:
-@last_unref_fn:
-@last_unref_fn_data:
-
-<!-- ##### ARG GnomeCanvasPixbuf:x_set ##### -->
- <para>
- Determines whether the <link
- linkend="GnomeCanvasPixbuf--x">x</link> argument is used to
- translate the pixbuf from its logical origin in item-relative
- coordinates.
- </para>
-
-
-<!-- ##### ARG GnomeCanvasPixbuf:width_in_pixels ##### -->
- <para>
- If this argument is %TRUE, then the width of the pixbuf will be
- considered to be in pixels, that is, it will not be visually
- scaled even if the item's affine transformation changes. If this
- is %FALSE, then the width of the pixbuf will be considered to be
- in canvas units, and so will be scaled normally by affine
- transformations. The default is %FALSE.
- </para>
-
-
-<!-- ##### SECTION ./tmpl/xlib-init.sgml:Long_Description ##### -->
- <para>
- In addition to the normal Gdk-specific functions, the &gdk-pixbuf;
- package provides a small library that lets Xlib-only applications
- use #GdkPixbuf structures and render them to X drawables. The
- functions in this section are used to initialize the &gdk-pixbuf;
- Xlib library. This library must be initialized near the beginning
- or the program or before calling any of the other &gdk-pixbuf;
- Xlib functions; it cannot be initialized automatically since
- Xlib-only applications do not call gdk_rgb_init() like GNOME
- applications do.
- </para>
-
+@Returns:
-<!-- ##### FUNCTION gdk_pixbuf_get_format ##### -->
+<!-- ##### MACRO GDK_PIXBUF_MAJOR ##### -->
<para>
</para>
-@pixbuf:
-@Returns:
<!-- ##### ARG GnomeCanvasPixbuf:height_in_pixels ##### -->
<para>
@@ -352,167 +160,248 @@ Rendering a pixbuf to a GDK drawable.
</para>
-<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:See_Also ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_get_frames ##### -->
<para>
</para>
+@animation:
+@Returns:
-<!-- ##### ARG GnomeCanvasPixbuf:width_set ##### -->
- <para>
- Determines whether the <link
- linkend="GnomeCanvasPixbuf--width">width</link> argument is taken
- into account when scaling the pixbuf item. If this argument is
- %FALSE, then the width value of the pixbuf will be used instead.
- This argument is %FALSE by default.
- </para>
+<!-- ##### FUNCTION gdk_pixbuf_animation_get_width ##### -->
+<para>
+</para>
-<!-- ##### FUNCTION gdk_pixbuf_render_to_drawable_alpha ##### -->
+@animation:
+@Returns:
+
+<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:See_Also ##### -->
<para>
</para>
-@pixbuf:
-@drawable:
-@src_x:
-@src_y:
-@dest_x:
-@dest_y:
-@width:
-@height:
-@alpha_mode:
-@alpha_threshold:
-@dither:
-@x_dither:
-@y_dither:
-<!-- ##### SECTION ./tmpl/xlib-init.sgml:Title ##### -->
-&gdk-pixbuf; Xlib initialization
+<!-- ##### SECTION ./tmpl/rendering.sgml:Title ##### -->
+Rendering
+
+
+<!-- ##### MACRO GDK_PIXBUF_MINOR ##### -->
+<para>
+
+</para>
<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:Short_Description ##### -->
Getting parts of an X drawable's image data into a pixbuf.
-<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Title ##### -->
-XlibRGB
+<!-- ##### STRUCT GdkPixbufModule ##### -->
+<para>
+</para>
-<!-- ##### ARG GnomeCanvasPixbuf:x_pixels ##### -->
+@module_name:
+@format_check:
+@module:
+@load:
+@load_xpm_data:
+@begin_load:
+@stop_load:
+@load_increment:
+@load_animation:
+@save:
+
+<!-- ##### FUNCTION gdk_pixbuf_get_colorspace ##### -->
<para>
</para>
+@pixbuf:
+@Returns:
-<!-- ##### ARG GnomeCanvasPixbuf:height ##### -->
- <para>
- Indicates the height the pixbuf will be scaled to. This argument
- will only be used if the <link
- linkend="GnomeCanvasPixbuf--height-set">height_set</link> argument
- is %TRUE. Works in the same way as the <link
- linkend="GnomeCanvasPixbuf--width">width</link> argument.
- </para>
+<!-- ##### FUNCTION gdk_pixbuf_animation_get_num_frames ##### -->
+<para>
+</para>
-<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:See_Also ##### -->
+@animation:
+@Returns:
+
+<!-- ##### SECTION ./tmpl/from-drawables.sgml:Short_Description ##### -->
+Getting parts of a drawable's image data into a pixbuf.
+
+
+<!-- ##### FUNCTION gdk_pixbuf_render_pixmap_and_mask ##### -->
<para>
</para>
+@pixbuf:
+@pixmap_return:
+@mask_return:
+@alpha_threshold: <!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
-<!-- ##### SECTION ./tmpl/from-drawables.sgml:See_Also ##### -->
- <para>
- gdk_image_get().
- </para>
+<!-- ##### FUNCTION gdk_pixbuf_composite_color ##### -->
+<para>
+</para>
-<!-- ##### STRUCT GdkPixbufAnimationClass ##### -->
+@src:
+@dest:
+@dest_x:
+@dest_y:
+@dest_width:
+@dest_height:
+@offset_x:
+@offset_y:
+@scale_x:
+@scale_y:
+@interp_type:
+@overall_alpha:
+@check_x:
+@check_y:
+@check_size:
+@color1:
+@color2:
+
+<!-- ##### FUNCTION gdk_pixbuf_new_from_data ##### -->
<para>
</para>
+@data:
+@colorspace:
+@has_alpha:
+@bits_per_sample:
+@width:
+@height:
+@rowstride:
+@destroy_fn:
+@destroy_fn_data:
+@Returns:
-<!-- ##### SECTION ./tmpl/rendering.sgml:Title ##### -->
-Rendering
-
+<!-- ##### FUNCTION gdk_pixbuf_animation_new_from_file ##### -->
+<para>
-<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:Title ##### -->
-GnomeCanvasPixbuf
+</para>
+@filename:
+@error:
+@Returns:
-<!-- ##### MACRO GDK_PIXBUF_LOADER ##### -->
+<!-- ##### ARG GnomeCanvasPixbuf:y_in_pixels ##### -->
<para>
- Casts a #GtkObject to a #GdkPixbufLoader.
+ Works in the same way as the <link
+ linkend="GnomeCanvasPixbuf--x-in-pixels">x_in_pixels</link>
+ argument, but controls whether the <link
+ linkend="GnomeCanvasPixbuf--y">y</link> translation offset is
+ scaled or not. The default is %FALSE.
</para>
-@obj: A GTK+ object.
+<!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
-<!-- ##### ARG GnomeCanvasPixbuf:y_set ##### -->
+
+<!-- ##### STRUCT GdkPixbufAnimation ##### -->
<para>
- Determines whether the <link
- linkend="GnomeCanvasPixbuf--y">y</link> argument is used to
- translate the pixbuf from its logical origin in item-relative
- coordinates. Works in the same way as the <link
- linkend="GnomeCanvasPixbuf--x-set">x_set</link> argument. The
- default is %FALSE.
+ This structure describes an animation, which is represented as a
+ list of #GdkPixbufFrame structures.
</para>
-<!-- ##### SECTION ./tmpl/rendering.sgml:Long_Description ##### -->
- <para>
- The &gdk-pixbuf; library provides several convenience functions to
- render pixbufs to GDK drawables. It uses the GdkRGB to render the
- image data.
- </para>
+<!-- ##### SECTION ./tmpl/xlib-init.sgml:Short_Description ##### -->
+Initializing the &gdk-pixbuf; Xlib library.
- <para>
- At this point there is not a standard alpha channel extension for
- the X Window System, so it is not possible to use full opacity
- information when painting images to arbitrary drawables. The
- &gdk-pixbuf; convenience functions will threshold the opacity
- information to create a bi-level clipping mask (black and white),
- and use that to draw the image onto a drawable.
- </para>
- <important>
- <para>
- Since these functions use GdkRGB for rendering, you must
- initialize GdkRGB before using any of them. You can do this by
- calling gdk_rgb_init() near the beginning of your program.
- </para>
- </important>
+<!-- ##### FUNCTION gdk_pixbuf_frame_get_delay_time ##### -->
+<para>
+</para>
-<!-- ##### SECTION ./tmpl/from-drawables.sgml:Short_Description ##### -->
-Getting parts of a drawable's image data into a pixbuf.
+@frame:
+@Returns:
+<!-- ##### ENUM GdkInterpType ##### -->
+ <para>
+ This enumeration describes the different interpolation modes that
+ can be used with the scaling functions.
+
+ <note>
+ <para>
+ Cubic filtering is missing from the list; hyperbolic
+ interpolation is just as fast and results in higher quality.
+ </para>
+ </note>
+ </para>
-<!-- ##### FUNCTION gdk_pixbuf_render_threshold_alpha ##### -->
+@GDK_INTERP_NEAREST: Nearest neighbor sampling; this is the fastest
+and lowest quality mode.
+@GDK_INTERP_TILES: This is an accurate simulation of the PostScript
+image operator without any interpolation enabled. Each pixel is
+rendered as a tiny parallelogram of solid color, the edges of which
+are implemented with antialiasing. It resembles nearest neighbor for
+enlargement, and bilinear for reduction.
+@GDK_INTERP_BILINEAR: Bilinear interpolation. For enlargement, it is
+equivalent to point-sampling the ideal bilinear-interpolated image.
+For reduction, it is equivalent to laying down small tiles and
+integrating over the coverage area.
+@GDK_INTERP_HYPER: This is the slowest and highest quality
+reconstruction function. It is derived from the hyperbolic filters in
+Wolberg's "Digital Image Warping", and is formally defined as the
+hyperbolic-filter sampling the ideal hyperbolic-filter interpolated
+image (the filter is designed to be idempotent for 1:1 pixel mapping).
+
+<!-- ##### FUNCTION gdk_pixbuf_render_to_drawable_alpha ##### -->
<para>
</para>
@pixbuf:
-@bitmap:
+@drawable:
@src_x:
@src_y:
@dest_x:
@dest_y:
@width:
@height:
+@alpha_mode:
@alpha_threshold:
+@dither:
+@x_dither:
+@y_dither:
-<!-- ##### ARG GnomeCanvasPixbuf:width_pixels ##### -->
-<para>
-
-</para>
-
+<!-- ##### ENUM GdkPixbufFrameAction ##### -->
+ <para>
+ Each animation frame can have several things happen to it when the
+ next frame is displayed. The #GdkPixbufFrameAction determines
+ this. These are essentially the overlay modes supported by GIF
+ animations.
+ </para>
-<!-- ##### STRUCT GdkPixbufClass ##### -->
-<para>
+@GDK_PIXBUF_FRAME_RETAIN: The previous image should remain displayed,
+and will potentially be occluded by the new frame.
+@GDK_PIXBUF_FRAME_DISPOSE: The animation will be reverted to the state
+before the frame was shown.
+@GDK_PIXBUF_FRAME_REVERT: The animation will be reverted to the first
+frame.
-</para>
+<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Long_Description ##### -->
+ <para>
+ The XlibRGB set of functions is a port of the GdkRGB library to
+ use plain Xlib and X drawables. You can use these functions to
+ render RGB buffers into drawables very quickly with high-quality
+ dithering.
+ </para>
<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:Long_Description ##### -->
@@ -684,16 +573,407 @@ Getting parts of a drawable's image data into a pixbuf.
</refsect2>
-<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Long_Description ##### -->
+<!-- ##### SECTION ./tmpl/rendering.sgml:Short_Description ##### -->
+Rendering a pixbuf to a GDK drawable.
+
+
+<!-- ##### MACRO GDK_PIXBUF_LOADER ##### -->
+ <para>
+ Casts a #GtkObject to a #GdkPixbufLoader.
+ </para>
+
+@obj: A GTK+ object.
+
+<!-- ##### STRUCT GdkPixbufAnimationClass ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG GnomeCanvasPixbuf:x_set ##### -->
+ <para>
+ Determines whether the <link
+ linkend="GnomeCanvasPixbuf--x">x</link> argument is used to
+ translate the pixbuf from its logical origin in item-relative
+ coordinates.
+ </para>
+
+
+<!-- ##### USER_FUNCTION ModulePreparedNotifyFunc ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@user_data:
+
+<!-- ##### MACRO GNOME_CANVAS_PIXBUF ##### -->
+ <para>
+ Casts a #GtkOjbect to a #GnomeCanvasPixbuf.
+ </para>
+
+@obj: A GTK+ object.
+
+<!-- ##### FUNCTION gdk_pixbuf_ref ##### -->
+ <para>
+
+ </para>
+
+@pixbuf:
+@Returns:
+
+<!-- ##### FUNCTION gdk_pixbuf_get_width ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@Returns:
+
+<!-- ##### ENUM GdkColorspace ##### -->
+ <para>
+ This enumeration defines the color spaces that are supported by
+ the &gdk-pixbuf; library. Currently only RGB is supported.
+ </para>
+
+@GDK_COLORSPACE_RGB: Indicates a red/green/blue additive color space.
+
+<!-- ##### ARG GnomeCanvasPixbuf:width_set ##### -->
+ <para>
+ Determines whether the <link
+ linkend="GnomeCanvasPixbuf--width">width</link> argument is taken
+ into account when scaling the pixbuf item. If this argument is
+ %FALSE, then the width value of the pixbuf will be used instead.
+ This argument is %FALSE by default.
+ </para>
+
+
+<!-- ##### FUNCTION gdk_pixbuf_get_module ##### -->
+<para>
+
+</para>
+
+@buffer:
+@size:
+@filename:
+@error:
+@Returns:
+
+<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:Long_Description ##### -->
+ <para>
+ The functions in this section allow you to take the image data
+ from an X drawable and dump it into a #GdkPixbuf. This can be
+ used for screenshots and other special effects. Note that these
+ operations can be expensive, since the image data has to be
+ transferred from the X server to the client program and converted.
+ </para>
+
+ <para>
+ These functions are analogous to those for the Gdk version of
+ &gdk-pixbuf;.
+ </para>
+
+
+<!-- ##### FUNCTION gdk_pixbuf_get_named_module ##### -->
+<para>
+
+</para>
+
+@name:
+@error:
+@Returns:
+
+<!-- ##### FUNCTION gdk_pixbuf_new ##### -->
+<para>
+
+</para>
+
+@colorspace:
+@has_alpha:
+@bits_per_sample:
+@width:
+@height:
+@Returns:
+
+<!-- ##### USER_FUNCTION GdkPixbufLastUnref ##### -->
+ <para>
+ A function of this type can be used to override the default
+ operation when a pixbuf loses its last reference, i.e. when
+ gdk_pixbuf_unref() is called on a #GdkPixbuf structure that has a
+ reference count of 1. This function should determine whether to
+ finalize the pixbuf by calling gdk_pixbuf_finalize(), or whether
+ to just resume normal execution. The last unref handler for a
+ #GdkPixbuf can be set using the
+ gdk_pixbuf_set_last_unref_handler() function. By default, pixbufs
+ will be finalized automatically if no last unref handler has been
+ defined.
+ </para>
+
+@pixbuf: The pixbuf that is losing its last reference.
+@data: User closure data.
+
+<!-- ##### FUNCTION gdk_pixbuf_new_from_inline ##### -->
+<para>
+
+</para>
+
+@inline_pixbuf:
+@copy_pixels:
+@length:
+@error:
+@Returns:
+
+<!-- ##### SECTION ./tmpl/xlib-init.sgml:See_Also ##### -->
+ <para>
+ XlibRGB
+ </para>
+
+
+<!-- ##### FUNCTION gdk_pixbuf_unref ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+
+<!-- ##### FUNCTION gdk_pixbuf_get_has_alpha ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@Returns:
+
+<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### USER_FUNCTION GdkPixbufDestroyNotify ##### -->
+ <para>
+ A function of this type is responsible for freeing the pixel array
+ of a pixbuf. The gdk_pixbuf_new_from_data() function lets you
+ pass in a pre-allocated pixel array so that a pixbuf can be
+ created from it; in this case you will need to pass in a function
+ of #GdkPixbufDestroyNotify so that the pixel data can be freed
+ when the pixbuf is finalized.
+ </para>
+
+@pixels: The pixel array of the pixbuf that is being finalized.
+@data: User closure data.
+
+<!-- ##### MACRO GDK_PIXBUF_ERROR ##### -->
<para>
</para>
+<!-- ##### FUNCTION gdk_pixbuf_new_from_xpm_data ##### -->
+<para>
+
+</para>
+
+@data:
+@Returns:
+
+<!-- ##### FUNCTION gdk_pixbuf_new_from_art_pixbuf ##### -->
+<para>
+
+</para>
+
+@art_pixbuf:
+@Returns:
+
+<!-- ##### FUNCTION gdk_pixbuf_scale_simple ##### -->
+<para>
+
+</para>
+
+@src:
+@dest_width:
+@dest_height:
+@interp_type:
+@Returns:
+
+<!-- ##### ARG GnomeCanvasPixbuf:height ##### -->
+ <para>
+ Indicates the height the pixbuf will be scaled to. This argument
+ will only be used if the <link
+ linkend="GnomeCanvasPixbuf--height-set">height_set</link> argument
+ is %TRUE. Works in the same way as the <link
+ linkend="GnomeCanvasPixbuf--width">width</link> argument.
+ </para>
+
+
+<!-- ##### FUNCTION gdk_pixbuf_composite ##### -->
+<para>
+
+</para>
+
+@src:
+@dest:
+@dest_x:
+@dest_y:
+@dest_width:
+@dest_height:
+@offset_x:
+@offset_y:
+@scale_x:
+@scale_y:
+@interp_type:
+@overall_alpha:
+
+<!-- ##### FUNCTION gdk_pixbuf_frame_get_pixbuf ##### -->
+<para>
+
+</para>
+
+@frame:
+@Returns:
+
+<!-- ##### FUNCTION gdk_pixbuf_get_n_channels ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@Returns:
+
<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:Title ##### -->
Xlib Rendering
+<!-- ##### SECTION ./tmpl/from-drawables.sgml:See_Also ##### -->
+ <para>
+ gdk_image_get().
+ </para>
+
+
+<!-- ##### ARG GnomeCanvasPixbuf:height_pixels ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG GnomeCanvasPixbuf:pixbuf ##### -->
+ <para>
+ Contains a pointer to a #GdkPixbuf structure that will be used by
+ the pixbuf canvas item as an image source. When a pixbuf is set
+ its reference count is incremented; if the pixbuf item kept a
+ pointer to another #GdkPixbuf structure, the reference count of
+ this structure will be decremented. Also, the GdkPixbuf's
+ reference count will automatically be decremented when the
+ #GnomeCanvasPixbuf item is destroyed. When a pixbuf is queried, a
+ reference count will not be added to the return value; you must do
+ this yourself if you intend to keep the pixbuf structure around.
+ </para>
+
+
+<!-- ##### FUNCTION gdk_pixbuf_frame_get_action ##### -->
+<para>
+
+</para>
+
+@frame:
+@Returns:
+
+<!-- ##### FUNCTION gdk_pixbuf_frame_get_y_offset ##### -->
+<para>
+
+</para>
+
+@frame:
+@Returns:
+
+<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Short_Description ##### -->
+Functions for rendering RGB buffers to X drawables.
+
+
+<!-- ##### ARG GnomeCanvasPixbuf:x ##### -->
+ <para>
+ Indicates the horizontal translation offset of the pixbuf item's
+ image. This offset may not actually appear horizontal, since it
+ will be affected by the item's affine transformation. The default
+ is 0.0.
+ </para>
+
+
+<!-- ##### ARG GnomeCanvasPixbuf:y ##### -->
+ <para>
+ Indicates the vertical translation offset of the pixbuf item's
+ image. Works in the same way as the <link
+ linkend="GnomeCanvasPixbuf--x">x</link> argument. The default is
+ 0.0.
+ </para>
+
+
+<!-- ##### FUNCTION gdk_pixbuf_animation_get_height ##### -->
+<para>
+
+</para>
+
+@animation:
+@Returns:
+
+<!-- ##### ARG GnomeCanvasPixbuf:width ##### -->
+ <para>
+ Indicates the width the pixbuf will be scaled to. This argument
+ will only be used if the <link
+ linkend="GnomeCanvasPixbuf--width-set">width_set</link> argument
+ is %TRUE. If the <link
+ linkend="GnomeCanvasPixbuf--width-in-pixels">width_in_pixels</link>
+ argument is %FALSE, the width will be taken to be in canvas units,
+ and thus will be scaled along with the canvas item's affine
+ transformation. If width_in_pixels is %TRUE, the width will be
+ taken to be in pixels, and will visually remain a constant size
+ even if the item's affine transformation changes.
+ </para>
+
+
+<!-- ##### FUNCTION gdk_pixbuf_composite_color_simple ##### -->
+<para>
+
+</para>
+
+@src:
+@dest_width:
+@dest_height:
+@interp_type:
+@overall_alpha:
+@check_size:
+@color1:
+@color2:
+@Returns: <!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
+
+<!-- ##### MACRO GDK_PIXBUF_MICRO ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION gdk_pixbuf_preinit ##### -->
+<para>
+
+</para>
+
+@app:
+@modinfo:
+
+<!-- ##### FUNCTION gdk_pixbuf_set_last_unref_handler ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@last_unref_fn:
+@last_unref_fn_data:
+
<!-- ##### ARG GnomeCanvasPixbuf:height_set ##### -->
<para>
Determines whether the <link
@@ -705,7 +985,377 @@ Xlib Rendering
</para>
+<!-- ##### FUNCTION gdk_pixbuf_animation_unref ##### -->
+<para>
+
+</para>
+
+@animation:
+
+<!-- ##### FUNCTION gdk_pixbuf_render_to_drawable ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@drawable:
+@gc:
+@src_x:
+@src_y:
+@dest_x:
+@dest_y:
+@width:
+@height:
+@dither:
+@x_dither:
+@y_dither:
+
+<!-- ##### SECTION ./tmpl/xlib-init.sgml:Long_Description ##### -->
+ <para>
+ In addition to the normal Gdk-specific functions, the &gdk-pixbuf;
+ package provides a small library that lets Xlib-only applications
+ use #GdkPixbuf structures and render them to X drawables. The
+ functions in this section are used to initialize the &gdk-pixbuf;
+ Xlib library. This library must be initialized near the beginning
+ or the program or before calling any of the other &gdk-pixbuf;
+ Xlib functions; it cannot be initialized automatically since
+ Xlib-only applications do not call gdk_rgb_init() like GNOME
+ applications do.
+ </para>
+
+
+<!-- ##### ARG GnomeCanvasPixbuf:y_pixels ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION gdk_pixbuf_frame_get_x_offset ##### -->
+<para>
+
+</para>
+
+@frame:
+@Returns: <!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
+
+<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/rendering.sgml:See_Also ##### -->
+ <para>
+ GdkRGB
+ </para>
+
+
+<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:Short_Description ##### -->
+Rendering a pixbuf to an X drawable.
+
+
+<!-- ##### USER_FUNCTION ModuleUpdatedNotifyFunc ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@x:
+@y:
+@width:
+@height:
+@user_data:
+
+<!-- ##### FUNCTION gdk_pixbuf_finalize ##### -->
+<para>
+
+</para>
+
+@pixbuf: <!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
+
+<!-- ##### FUNCTION gdk_pixbuf_get_pixels ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@Returns:
+
+<!-- ##### FUNCTION gdk_pixbuf_get_from_drawable ##### -->
+<para>
+
+</para>
+
+@dest:
+@src:
+@cmap:
+@src_x:
+@src_y:
+@dest_x:
+@dest_y:
+@width:
+@height:
+@Returns: <!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
+
+<!-- ##### USER_FUNCTION ModuleFrameDoneNotifyFunc ##### -->
+<para>
+
+</para>
+
+@frame:
+@user_data:
+
+<!-- ##### FUNCTION gdk_pixbuf_postinit ##### -->
+<para>
+
+</para>
+
+@app:
+@modinfo:
+
<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Title ##### -->
gdk-pixbuf-io
+<!-- ##### FUNCTION gdk_pixbuf_copy ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@Returns: <!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
+
+<!-- ##### ARG GnomeCanvasPixbuf:y_set ##### -->
+ <para>
+ Determines whether the <link
+ linkend="GnomeCanvasPixbuf--y">y</link> argument is used to
+ translate the pixbuf from its logical origin in item-relative
+ coordinates. Works in the same way as the <link
+ linkend="GnomeCanvasPixbuf--x-set">x_set</link> argument. The
+ default is %FALSE.
+ </para>
+
+
+<!-- ##### FUNCTION gdk_pixbuf_animation_ref ##### -->
+<para>
+
+</para>
+
+@animation:
+@Returns:
+
+<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:Title ##### -->
+GnomeCanvasPixbuf
+
+
+<!-- ##### STRUCT GdkPixbuf ##### -->
+ <para>
+ This is the main structure in the &gdk-pixbuf; library. It is
+ used to represent images. It contains information about the
+ image's pixel data, its color space, bits per sample, width and
+ height, and the rowstride or number of bytes between rows.
+ </para>
+
+
+<!-- ##### ARG GnomeCanvasPixbuf:x_pixels ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO GDK_PIXBUF_VERSION ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### VARIABLE gdk_pixbuf_version ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION gdk_pixbuf_scale ##### -->
+<para>
+
+</para>
+
+@src:
+@dest:
+@dest_x:
+@dest_y:
+@dest_width:
+@dest_height:
+@offset_x:
+@offset_y:
+@scale_x:
+@scale_y:
+@interp_type:
+
+<!-- ##### FUNCTION gdk_pixbuf_get_format ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@Returns:
+
+<!-- ##### SECTION ./tmpl/from-drawables.sgml:Long_Description ##### -->
+ <para>
+ The functions in this section allow you to take the image data
+ from a GDK drawable and dump it into a #GdkPixbuf. This can be
+ used for screenshots and other special effects. Note that these
+ operations can be expensive, since the image data has to be
+ transferred from the X server to the client program and converted.
+ </para>
+
+
+<!-- ##### ARG GnomeCanvasPixbuf:width_pixels ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ENUM GdkPixbufAlphaMode ##### -->
+ <para>
+ These values can be passed to
+ gdk_pixbuf_render_to_drawable_alpha() to control how the alpha
+ chanel of an image should be handled. This function can create a
+ bilevel clipping mask (black and white) and use it while painting
+ the image. In the future, when the X Window System gets an alpha
+ channel extension, it will be possible to do full alpha
+ compositing onto arbitrary drawables. For now both cases fall
+ back to a bilevel clipping mask.
+ </para>
+
+@GDK_PIXBUF_ALPHA_BILEVEL: A bilevel clipping mask (black and white)
+will be created and used to draw the image. Pixels below 0.5 opacity
+will be considered fully transparent, and all others will be
+considered fully opaque.
+@GDK_PIXBUF_ALPHA_FULL: For now falls back to #GDK_PIXBUF_ALPHA_BILEVEL.
+In the future it will do full alpha compositing.
+
+<!-- ##### STRUCT GdkPixbufFrame ##### -->
+ <para>
+ This structure describes a frame in a #GdkPixbufAnimation. Each
+ frame consists of a #GdkPixbuf, an offset of the frame within the
+ animation's bounding box, a duration, and an overlay mode or
+ action.
+ </para>
+
+
+<!-- ##### FUNCTION gdk_pixbuf_add_alpha ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@substitute_color:
+@r:
+@g:
+@b:
+@Returns:
+
+<!-- ##### USER_FUNCTION ModuleAnimationDoneNotifyFunc ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@user_data:
+
+<!-- ##### FUNCTION gdk_pixbuf_copy_area ##### -->
+<para>
+
+</para>
+
+@src_pixbuf:
+@src_x:
+@src_y:
+@width:
+@height:
+@dest_pixbuf:
+@dest_x:
+@dest_y: <!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
+
+<!-- ##### FUNCTION gdk_pixbuf_init ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:Title ##### -->
+X Drawables to Pixbufs
+
+
+<!-- ##### STRUCT GdkPixbufClass ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/from-drawables.sgml:Title ##### -->
+Drawables to Pixbufs
+
+
+<!-- ##### ARG GnomeCanvasPixbuf:x_in_pixels ##### -->
+ <para>
+ If this argument is %TRUE, the pixbuf's translation with respect
+ to its logical origin in item-relative coordinates will be in
+ pixels, that is, the visible offset will not change even if the
+ item's affine transformation changes. If it is %FALSE, the
+ pixbuf's translation will be taken to be in canvas units, and thus
+ will change along with the item's affine transformation. The
+ default is %FALSE.
+ </para>
+
+
+<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Title ##### -->
+XlibRGB
+
+
+<!-- ##### FUNCTION gdk_pixbuf_new_from_file ##### -->
+<para>
+
+</para>
+
+@filename:
+@error:
+@Returns: <!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
+
diff --git a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml
index 403941efa9..897d59bf8f 100644
--- a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml
@@ -15,135 +15,3 @@ Information that describes an image.
<para>
</para>
-<!-- ##### ENUM GdkPixbufError ##### -->
-<para>
-
-</para>
-
-@GDK_PIXBUF_ERROR_CORRUPT_IMAGE:
-@GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY:
-@GDK_PIXBUF_ERROR_BAD_OPTION_VALUE:
-@GDK_PIXBUF_ERROR_UNKNOWN_TYPE:
-@GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION:
-@GDK_PIXBUF_ERROR_FAILED:
-
-<!-- ##### MACRO GDK_PIXBUF_ERROR ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### ENUM GdkColorspace ##### -->
- <para>
- This enumeration defines the color spaces that are supported by
- the &gdk-pixbuf; library. Currently only RGB is supported.
- </para>
-
-@GDK_COLORSPACE_RGB: Indicates a red/green/blue additive color space.
-
-<!-- ##### ENUM GdkPixbufAlphaMode ##### -->
- <para>
- These values can be passed to
- gdk_pixbuf_render_to_drawable_alpha() to control how the alpha
- chanel of an image should be handled. This function can create a
- bilevel clipping mask (black and white) and use it while painting
- the image. In the future, when the X Window System gets an alpha
- channel extension, it will be possible to do full alpha
- compositing onto arbitrary drawables. For now both cases fall
- back to a bilevel clipping mask.
- </para>
-
-@GDK_PIXBUF_ALPHA_BILEVEL: A bilevel clipping mask (black and white)
-will be created and used to draw the image. Pixels below 0.5 opacity
-will be considered fully transparent, and all others will be
-considered fully opaque.
-@GDK_PIXBUF_ALPHA_FULL: For now falls back to #GDK_PIXBUF_ALPHA_BILEVEL.
-In the future it will do full alpha compositing.
-
-<!-- ##### STRUCT GdkPixbuf ##### -->
- <para>
- This is the main structure in the &gdk-pixbuf; library. It is
- used to represent images. It contains information about the
- image's pixel data, its color space, bits per sample, width and
- height, and the rowstride or number of bytes between rows.
- </para>
-
-
-<!-- ##### FUNCTION gdk_pixbuf_get_colorspace ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_get_n_channels ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_get_has_alpha ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_get_bits_per_sample ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_get_pixels ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_get_width ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_get_height ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_get_rowstride ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@Returns: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
-
-
diff --git a/docs/reference/gdk-pixbuf/tmpl/initialization_versions.sgml b/docs/reference/gdk-pixbuf/tmpl/initialization_versions.sgml
index 41302c27ca..26746d7402 100644
--- a/docs/reference/gdk-pixbuf/tmpl/initialization_versions.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/initialization_versions.sgml
@@ -14,62 +14,3 @@ Initialization and Versions
</para>
-<!-- ##### FUNCTION gdk_pixbuf_init ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION gdk_pixbuf_preinit ##### -->
-<para>
-
-</para>
-
-@app:
-@modinfo:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_postinit ##### -->
-<para>
-
-</para>
-
-@app:
-@modinfo:
-
-
-<!-- ##### VARIABLE gdk_pixbuf_version ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GDK_PIXBUF_VERSION ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GDK_PIXBUF_MAJOR ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GDK_PIXBUF_MINOR ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO GDK_PIXBUF_MICRO ##### -->
-<para>
-
-</para>
-
-
-
diff --git a/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml b/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml
index 734ee8034a..7e1402e2f5 100644
--- a/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml
@@ -14,91 +14,3 @@ Module Interface
</para>
-<!-- ##### USER_FUNCTION ModulePreparedNotifyFunc ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@user_data:
-
-
-<!-- ##### USER_FUNCTION ModuleUpdatedNotifyFunc ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@x:
-@y:
-@width:
-@height:
-@user_data:
-
-
-<!-- ##### USER_FUNCTION ModuleFrameDoneNotifyFunc ##### -->
-<para>
-
-</para>
-
-@frame:
-@user_data:
-
-
-<!-- ##### USER_FUNCTION ModuleAnimationDoneNotifyFunc ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@user_data:
-
-
-<!-- ##### STRUCT GdkPixbufModule ##### -->
-<para>
-
-</para>
-
-@module_name:
-@format_check:
-@module:
-@load:
-@load_xpm_data:
-@begin_load:
-@stop_load:
-@load_increment:
-@load_animation:
-@save:
-
-<!-- ##### FUNCTION gdk_pixbuf_get_module ##### -->
-<para>
-
-</para>
-
-@buffer:
-@size:
-@filename:
-@error:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_get_named_module ##### -->
-<para>
-
-</para>
-
-@name:
-@error:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_load_module ##### -->
-<para>
-
-</para>
-
-@image_module:
-@error:
-@Returns:
-
-
diff --git a/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml b/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml
index f975e4f69a..770b66ae19 100644
--- a/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml
@@ -54,34 +54,3 @@ Functions to perform reference counting and memory management on a
#GdkPixbuf, gdk_pixbuf_new_from_data().
</para>
-<!-- ##### USER_FUNCTION GdkPixbufDestroyNotify ##### -->
- <para>
- A function of this type is responsible for freeing the pixel array
- of a pixbuf. The gdk_pixbuf_new_from_data() function lets you
- pass in a pre-allocated pixel array so that a pixbuf can be
- created from it; in this case you will need to pass in a function
- of #GdkPixbufDestroyNotify so that the pixel data can be freed
- when the pixbuf is finalized.
- </para>
-
-@pixels: The pixel array of the pixbuf that is being finalized.
-@data: User closure data.
-
-
-<!-- ##### FUNCTION gdk_pixbuf_ref ##### -->
- <para>
-
- </para>
-
-@pixbuf:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_unref ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-
-
diff --git a/docs/reference/gdk-pixbuf/tmpl/scaling.sgml b/docs/reference/gdk-pixbuf/tmpl/scaling.sgml
index a8d41a1170..b4bf82445c 100644
--- a/docs/reference/gdk-pixbuf/tmpl/scaling.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/scaling.sgml
@@ -68,127 +68,3 @@ expose_cb (GtkWidget *widget, GdkEventExpose *event, gpointer data)
GdkRGB
</para>
-<!-- ##### ENUM GdkInterpType ##### -->
- <para>
- This enumeration describes the different interpolation modes that
- can be used with the scaling functions.
-
- <note>
- <para>
- Cubic filtering is missing from the list; hyperbolic
- interpolation is just as fast and results in higher quality.
- </para>
- </note>
- </para>
-
-@GDK_INTERP_NEAREST: Nearest neighbor sampling; this is the fastest
-and lowest quality mode.
-@GDK_INTERP_TILES: This is an accurate simulation of the PostScript
-image operator without any interpolation enabled. Each pixel is
-rendered as a tiny parallelogram of solid color, the edges of which
-are implemented with antialiasing. It resembles nearest neighbor for
-enlargement, and bilinear for reduction.
-@GDK_INTERP_BILINEAR: Bilinear interpolation. For enlargement, it is
-equivalent to point-sampling the ideal bilinear-interpolated image.
-For reduction, it is equivalent to laying down small tiles and
-integrating over the coverage area.
-@GDK_INTERP_HYPER: This is the slowest and highest quality
-reconstruction function. It is derived from the hyperbolic filters in
-Wolberg's "Digital Image Warping", and is formally defined as the
-hyperbolic-filter sampling the ideal hyperbolic-filter interpolated
-image (the filter is designed to be idempotent for 1:1 pixel mapping).
-
-<!-- ##### FUNCTION gdk_pixbuf_scale ##### -->
-<para>
-
-</para>
-
-@src:
-@dest:
-@dest_x:
-@dest_y:
-@dest_width:
-@dest_height:
-@offset_x:
-@offset_y:
-@scale_x:
-@scale_y:
-@interp_type:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_composite ##### -->
-<para>
-
-</para>
-
-@src:
-@dest:
-@dest_x:
-@dest_y:
-@dest_width:
-@dest_height:
-@offset_x:
-@offset_y:
-@scale_x:
-@scale_y:
-@interp_type:
-@overall_alpha:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_composite_color ##### -->
-<para>
-
-</para>
-
-@src:
-@dest:
-@dest_x:
-@dest_y:
-@dest_width:
-@dest_height:
-@offset_x:
-@offset_y:
-@scale_x:
-@scale_y:
-@interp_type:
-@overall_alpha:
-@check_x:
-@check_y:
-@check_size:
-@color1:
-@color2:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_scale_simple ##### -->
-<para>
-
-</para>
-
-@src:
-@dest_width:
-@dest_height:
-@interp_type:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_composite_color_simple ##### -->
-<para>
-
-</para>
-
-@src:
-@dest_width:
-@dest_height:
-@interp_type:
-@overall_alpha:
-@check_size:
-@color1:
-@color2:
-@Returns: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
-
-
diff --git a/docs/reference/gdk-pixbuf/tmpl/util.sgml b/docs/reference/gdk-pixbuf/tmpl/util.sgml
index 35726a967b..bb91711e77 100644
--- a/docs/reference/gdk-pixbuf/tmpl/util.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/util.sgml
@@ -17,47 +17,3 @@ Utility and miscellaneous convenience functions.
#GdkPixbuf
</para>
-<!-- ##### FUNCTION gdk_pixbuf_add_alpha ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@substitute_color:
-@r:
-@g:
-@b:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_pixbuf_copy_area ##### -->
-<para>
-
-</para>
-
-@src_pixbuf:
-@src_x:
-@src_y:
-@width:
-@height:
-@dest_pixbuf:
-@dest_x:
-@dest_y: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
-
-
-<!-- ##### FUNCTION gdk_pixbuf_saturate_and_pixelate ##### -->
-<para>
-
-</para>
-
-@src:
-@dest:
-@saturation:
-@pixelate:
-
-
diff --git a/docs/reference/gdk/tmpl/gdk-unused.sgml b/docs/reference/gdk/tmpl/gdk-unused.sgml
index f455390216..830db8f65e 100644
--- a/docs/reference/gdk/tmpl/gdk-unused.sgml
+++ b/docs/reference/gdk/tmpl/gdk-unused.sgml
@@ -1,8 +1,34 @@
-<!-- ##### SECTION ./tmpl/gdkregion.sgml:See_Also ##### -->
+<!-- ##### FUNCTION gdk_input_set_mode ##### -->
<para>
+Enables or disables a device, and determines how the
+device maps onto the screen.
+</para>
+@deviceid: the device to configure.
+@mode: the new mode.
+@Returns: %TRUE if the device supports the given mode, otherwise
+ %FALSE and the device's mode is unchanged.
+
+<!-- ##### FUNCTION gdk_input_set_key ##### -->
+<para>
+Sets the key event generated when a macro button is pressed.
</para>
+@deviceid: the device to configure.
+@index: the index of the macro button.
+@keyval: the key value for the #GdkKeypressEvent to generate.
+ (a value of 0 means no event will be generated.)
+@modifiers: the modifier field for the generated
+ #GdkKeyPressEvent.
+
+<!-- ##### FUNCTION gdk_regions_intersect ##### -->
+<para>
+Returns the intersection of two regions.
+</para>
+
+@source1: a #GdkRegion.
+@source2: a #GdkRegion.
+@Returns: the intersection of @source1 and @source2.
<!-- ##### FUNCTION gdk_regions_xor ##### -->
<para>
@@ -16,21 +42,32 @@ but which are not in both.
@Returns: the difference between the union and the intersection of @source1
and @source2.
-<!-- ##### FUNCTION gdk_input_motion_events ##### -->
+<!-- ##### FUNCTION gdk_regions_subtract ##### -->
<para>
-Retrieves the motion history for a given device/window pair.
+Subtracts one region from another.
+The result is a region containing all the pixels which are in @source1, but
+which are not in @source2.
</para>
-@window: a #GdkWindow.
-@deviceid: the device for which to retrieve motion history.
-@start: the start time.
-@stop: the stop time.
-@nevents_return: location to store the number of events returned.
-@Returns: a newly allocated array containing all the events
- from @start to @stop. This array should be freed
- with g_free() when you are finished using it.
+@source1: a #GdkRegion.
+@source2: a #GdkRegion to subtract from @source1.
+@Returns: @source1 - @source2.
-<!-- ##### SECTION ./tmpl/gdkregion.sgml:Long_Description ##### -->
+<!-- ##### FUNCTION gdk_input_list_devices ##### -->
+<para>
+Lists all available input devices, along with their
+configuration information.
+</para>
+
+@Returns: A #GList of #GdkDeviceInfo structures. This list
+ is internal data of GTK+ and should not be modified
+ or freed.
+
+<!-- ##### SECTION ./tmpl/gdkregion.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:See_Also ##### -->
<para>
</para>
@@ -40,6 +77,29 @@ Retrieves the motion history for a given device/window pair.
+<!-- ##### MACRO GDK_CORE_POINTER ##### -->
+<para>
+This macro contains an integer value representing
+the device ID for the core pointer device.
+</para>
+
+
+<!-- ##### VARIABLE gdk_threads_mutex ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION gdk_input_set_axes ##### -->
+<para>
+Sets the mapping of the axes (valuators) of a device
+onto the predefined valuator types that GTK+ understands.
+</para>
+
+@deviceid: the device to configure.
+@axes: an array of GdkAxisUse. This length of this array
+ must match the number of axes for the device.
+
<!-- ##### STRUCT GdkDeviceInfo ##### -->
<para>
The #GdkDeviceInfo structure contains information about a
@@ -64,70 +124,69 @@ device. It has the following fields:
which describe what key press events are generated
for each macro button.
-<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Title ##### -->
-Pango Interaction
+<!-- ##### SECTION ./tmpl/gdkregion.sgml:Title ##### -->
+Points, Rectangles and Regions
-<!-- ##### FUNCTION gdk_regions_union ##### -->
+<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Long_Description ##### -->
<para>
-Returns the union of two regions.
-This is all pixels in either of @source1 or @source2.
+
</para>
-@source1: a #GdkRegion.
-@source2: a #GdkRegion.
-@Returns: the union of @source1 and @source2.
-<!-- ##### SECTION ./tmpl/gdkregion.sgml:Short_Description ##### -->
+<!-- ##### ENUM GdkPixbufAlphaMode ##### -->
+<para>
+</para>
+@GDK_PIXBUF_ALPHA_BILEVEL:
+@GDK_PIXBUF_ALPHA_FULL:
-<!-- ##### FUNCTION gdk_input_set_key ##### -->
+<!-- ##### FUNCTION gdk_input_motion_events ##### -->
<para>
-Sets the key event generated when a macro button is pressed.
+Retrieves the motion history for a given device/window pair.
</para>
-@deviceid: the device to configure.
-@index: the index of the macro button.
-@keyval: the key value for the #GdkKeypressEvent to generate.
- (a value of 0 means no event will be generated.)
-@modifiers: the modifier field for the generated
- #GdkKeyPressEvent.
+@window: a #GdkWindow.
+@deviceid: the device for which to retrieve motion history.
+@start: the start time.
+@stop: the stop time.
+@nevents_return: location to store the number of events returned.
+@Returns: a newly allocated array containing all the events
+ from @start to @stop. This array should be freed
+ with g_free() when you are finished using it.
-<!-- ##### FUNCTION gdk_input_list_devices ##### -->
+<!-- ##### VARIABLE gdk_core_pointer ##### -->
<para>
-Lists all available input devices, along with their
-configuration information.
+
</para>
-@Returns: A #GList of #GdkDeviceInfo structures. This list
- is internal data of GTK+ and should not be modified
- or freed.
-<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:See_Also ##### -->
+<!-- ##### SECTION ./tmpl/gdkregion.sgml:See_Also ##### -->
<para>
</para>
-<!-- ##### ENUM GdkPixbufAlphaMode ##### -->
+<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Title ##### -->
+Pango Interaction
+
+
+<!-- ##### SECTION ./tmpl/gdkregion.sgml:Long_Description ##### -->
<para>
</para>
-@GDK_PIXBUF_ALPHA_BILEVEL:
-@GDK_PIXBUF_ALPHA_FULL:
-<!-- ##### FUNCTION gdk_regions_subtract ##### -->
+<!-- ##### FUNCTION gdk_regions_union ##### -->
<para>
-Subtracts one region from another.
-The result is a region containing all the pixels which are in @source1, but
-which are not in @source2.
+Returns the union of two regions.
+This is all pixels in either of @source1 or @source2.
</para>
@source1: a #GdkRegion.
-@source2: a #GdkRegion to subtract from @source1.
-@Returns: @source1 - @source2.
+@source2: a #GdkRegion.
+@Returns: the union of @source1 and @source2.
<!-- ##### FUNCTION gdk_input_window_get_pointer ##### -->
<para>
@@ -146,23 +205,6 @@ they will be ignored.
@ytilt: location to store current tilt in the y direction.
@mask: location to store the current modifier state.
-<!-- ##### MACRO GDK_CORE_POINTER ##### -->
-<para>
-This macro contains an integer value representing
-the device ID for the core pointer device.
-</para>
-
-
-<!-- ##### FUNCTION gdk_input_set_axes ##### -->
-<para>
-Sets the mapping of the axes (valuators) of a device
-onto the predefined valuator types that GTK+ understands.
-</para>
-
-@deviceid: the device to configure.
-@axes: an array of GdkAxisUse. This length of this array
- must match the number of axes for the device.
-
<!-- ##### FUNCTION gdk_input_set_source ##### -->
<para>
Sets the source type for a device.
@@ -171,33 +213,3 @@ Sets the source type for a device.
@deviceid: the device to configure
@source: the new source type.
-<!-- ##### SECTION ./tmpl/gdkregion.sgml:Title ##### -->
-Points, Rectangles and Regions
-
-
-<!-- ##### FUNCTION gdk_regions_intersect ##### -->
-<para>
-Returns the intersection of two regions.
-</para>
-
-@source1: a #GdkRegion.
-@source2: a #GdkRegion.
-@Returns: the intersection of @source1 and @source2.
-
-<!-- ##### FUNCTION gdk_input_set_mode ##### -->
-<para>
-Enables or disables a device, and determines how the
-device maps onto the screen.
-</para>
-
-@deviceid: the device to configure.
-@mode: the new mode.
-@Returns: %TRUE if the device supports the given mode, otherwise
- %FALSE and the device's mode is unchanged.
-
-<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
diff --git a/docs/reference/gdk/tmpl/input_devices.sgml b/docs/reference/gdk/tmpl/input_devices.sgml
index 572bd69743..1f9b99c12d 100644
--- a/docs/reference/gdk/tmpl/input_devices.sgml
+++ b/docs/reference/gdk/tmpl/input_devices.sgml
@@ -175,12 +175,6 @@ types that GTK+ understands.
@Returns:
-<!-- ##### VARIABLE gdk_core_pointer ##### -->
-<para>
-
-</para>
-
-
<!-- ##### FUNCTION gdk_device_set_source ##### -->
<para>
diff --git a/docs/reference/gdk/tmpl/threads.sgml b/docs/reference/gdk/tmpl/threads.sgml
index 5e7e049abb..4bc696e768 100644
--- a/docs/reference/gdk/tmpl/threads.sgml
+++ b/docs/reference/gdk/tmpl/threads.sgml
@@ -42,9 +42,3 @@ Threads
-<!-- ##### VARIABLE gdk_threads_mutex ##### -->
-<para>
-
-</para>
-
-