Make 3.0 parallel-installable to 2.x

[~andy/gtk] / docs / reference / gdk / tmpl / rgb.sgml

diff --git a/docs/reference/gdk/tmpl/rgb.sgml b/docs/reference/gdk/tmpl/rgb.sgml
index d7c3d97e9a25e5e5e43db8c692f08d6e202f0afe..a60e73980c00ffa32c6bc518c3c857853e37cf96 100644 (file)
--- a/docs/reference/gdk/tmpl/rgb.sgml
+++ b/docs/reference/gdk/tmpl/rgb.sgml
@@ -12,7 +12,7 @@ colormap images to a #GdkDrawable. It does this as efficiently as
 possible, handling issues such as colormaps, visuals, dithering,
 temporary buffers, and so on. Most code should use the higher-level
 #GdkPixbuf features in place of this module; for example,
-gdk_pixbuf_render_to_drawable() uses GdkRGB in its implementation.
+gdk_draw_pixbuf() uses GdkRGB in its implementation.
 </para>
 
 <para>
@@ -34,6 +34,13 @@ created in grayscale and direct color modes, and the visual is changed
 in cases where a "better" visual than the default is available.
 </para>
 
+<para>
+If GDK is built with the Sun mediaLib library, the GdkRGB functions are
+accelerated using mediaLib, which provides hardware acceleration on Intel,
+AMD, and Sparc chipsets.  If desired, mediaLib support can be turned off
+by setting the GDK_DISABLE_MEDIALIB environment variable.
+</para>
+
 <example>
 <title>A simple example program using GdkRGB</title>
 <programlisting>
@@ -107,7 +114,7 @@ colors.</para></listitem>
 </varlistentry>
 
 <varlistentry>
-<term>#GdkPixbuf and gdk_pixbuf_render_to_drawable()</term>
+<term>#GdkPixbuf and gdk_draw_pixbuf()</term>
 <listitem><para>Higher-level image handling.</para></listitem>
 </varlistentry>
 
@@ -115,12 +122,10 @@ colors.</para></listitem>
 
 </para>
 
-<!-- ##### FUNCTION gdk_rgb_init ##### -->
-<para>
-This function no longer does anything at all. It's completely useless
-(and harmless).
-</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
 
+<!-- ##### SECTION Image ##### -->
 
 
 <!-- ##### FUNCTION gdk_draw_rgb_image ##### -->
@@ -275,40 +280,18 @@ start of the next.
 <!-- ##### ENUM GdkRgbDither ##### -->
 <para>
 Selects whether or not GdkRGB applies dithering
-to the image on display. There are three values:
+to the image on display. 
 </para>
 
-<itemizedlist>
-
-<listitem>
-<para>
-%GDK_RGB_DITHER_NONE: Never use dithering.
-</para>
-</listitem>
-
-<listitem>
-<para>
-%GDK_RGB_DITHER_NORMAL: Use dithering in 8 bits per pixel (and below)
-only.
-</para>
-</listitem>
-
-<listitem>
-<para>
-%GDK_RGB_DITHER_MAX: Use dithering in 16 bits per pixel and below.
-</para>
-</listitem>
-
-</itemizedlist>
-
 <para>
 Since GdkRGB currently only handles images with 8 bits per component,
 dithering on 24 bit per pixel displays is a moot point.
 </para>
 
-@GDK_RGB_DITHER_NONE: 
-@GDK_RGB_DITHER_NORMAL: 
-@GDK_RGB_DITHER_MAX: 
+@GDK_RGB_DITHER_NONE: Never use dithering.
+@GDK_RGB_DITHER_NORMAL: Use dithering in 8 bits per pixel (and below)
+only.
+@GDK_RGB_DITHER_MAX: Use dithering in 16 bits per pixel and below.
 
 <!-- ##### FUNCTION gdk_rgb_cmap_new ##### -->
 <para>
@@ -337,39 +320,8 @@ A private data structure which maps color indices to actual RGB
 colors. This is used only for gdk_draw_indexed_image().
 </para>
 
-@colors: 
-@n_colors: 
-
-<!-- ##### FUNCTION gdk_rgb_gc_set_foreground ##### -->
-<para>
-Sets the foreground color in @gc to the specified color (or the
-closest approximation, in the case of limited visuals).
-</para>
-
-@gc: The #GdkGC to modify.
-@rgb: The color, represented as a 0xRRGGBB integer value.
-
-
-<!-- ##### FUNCTION gdk_rgb_gc_set_background ##### -->
-<para>
-Sets the background color in @gc to the specified color (or the
-closest approximation, in the case of limited visuals).
-</para>
-
-@gc: The #GdkGC to modify.
-@rgb: The color, represented as a 0xRRGGBB integer value.
-
-
-<!-- ##### FUNCTION gdk_rgb_xpixel_from_rgb ##### -->
-<para>
-Finds the X pixel closest in color to the @rgb color specified. This
-value may be used to set the <structfield>pixel</structfield> field of
-a #GdkColor struct.
-</para>
-
-@rgb: The color, represented as a 0xRRGGBB integer value.
-@Returns: The X pixel value.
-
+@colors: The colors, represented as 0xRRGGBB integer values.
+@n_colors: The number of colors in the cmap.
 
 <!-- ##### FUNCTION gdk_rgb_find_color ##### -->
 <para>
@@ -411,6 +363,7 @@ private colormap.
 <para>
 </para>
 
+@void: 
 @Returns: 
 
 
@@ -419,18 +372,10 @@ private colormap.
 
 </para>
 
+@void: 
 @Returns: 
 
 
-<!-- ##### MACRO gdk_rgb_get_cmap ##### -->
-<para>
-Gets the colormap set by GdkRGB. This colormap and the corresponding
-visual should be used when creating windows that will be drawn in by GdkRGB.
-</para>
-
-@Returns: The #GdkColormap set by GdkRGB.
-
-
 <!-- ##### FUNCTION gdk_rgb_ditherable ##### -->
 <para>
 Determines whether the preferred visual is ditherable. This function may be
@@ -439,6 +384,7 @@ dither mode is desired; if the display is not ditherable, it may make
 sense to gray out or hide the corresponding UI widget.
 </para>
 
+@void: 
 @Returns: %TRUE if the preferred visual is ditherable.