Commit c9b30265 authored by Sven Neumann's avatar Sven Neumann Committed by Sven Neumann

libgimp/gimp*_pdb.c autogenerate gtkdoc comments for all PDB wrappers.

2000-08-25  Sven Neumann  <sven@gimp.org>

        * libgimp/gimp*_pdb.c
        * tools/pdbgen/lib.pl: autogenerate gtkdoc comments for all PDB
        wrappers.
parent adcb223e
2000-08-25 Sven Neumann <sven@gimp.org>
* libgimp/gimp*_pdb.c
* tools/pdbgen/lib.pl: autogenerate gtkdoc comments for all PDB
wrappers.
Thu Aug 24 23:37:46 CEST 2000 Marc Lehmann <pcg@goof.com>
* gimp.m4: Make it work with 1.1 again without sacrifing 1.0
......
......@@ -23,6 +23,26 @@
#include "gimp.h"
/**
* gimp_brushes_get_brush_data:
* @name: the brush name (\"\" means current active pattern).
* @opacity: The brush opacity.
* @spacing: The brush spacing.
* @paint_mode: The paint mode.
* @width: The brush width.
* @height: The brush height.
* @length: Length of brush mask data.
* @mask_data: The brush mask data.
*
* Retrieve information about the currently active brush (including
* data).
*
* This procedure retrieves information about the currently active
* brush. This includes the brush name, and the brush extents (width
* and height). It also returns the brush data.
*
* Returns: The brush name.
*/
gchar *
gimp_brushes_get_brush_data (gchar *name,
gdouble *opacity,
......
......@@ -23,6 +23,21 @@
#include "gimp.h"
/**
* gimp_brushes_popup:
* @brush_callback: The callback PDB proc to call when brush selection is made.
* @popup_title: Title to give the brush popup window.
* @initial_brush: The name of the brush to set as the first selected.
* @opacity: The initial opacity of the brush.
* @spacing: The initial spacing of the brush (if < 0 then use brush default spacing).
* @paint_mode: The initial paint mode.
*
* Invokes the Gimp brush selection.
*
* This procedure popups the brush selection dialog.
*
* Returns: TRUE on success.
*/
gboolean
gimp_brushes_popup (gchar *brush_callback,
gchar *popup_title,
......@@ -52,6 +67,16 @@ gimp_brushes_popup (gchar *brush_callback,
return success;
}
/**
* gimp_brushes_close_popup:
* @brush_callback: The name of the callback registered for this popup.
*
* Popdown the Gimp brush selection.
*
* This procedure closes an opened brush selection dialog.
*
* Returns: TRUE on success.
*/
gboolean
gimp_brushes_close_popup (gchar *brush_callback)
{
......@@ -71,6 +96,20 @@ gimp_brushes_close_popup (gchar *brush_callback)
return success;
}
/**
* gimp_brushes_set_popup:
* @brush_callback: The name of the callback registered for this popup.
* @brush_name: The name of the brush to set as selected.
* @opacity: The initial opacity of the brush.
* @spacing: The initial spacing of the brush (if < 0 then use brush default spacing).
* @paint_mode: The initial paint mode.
*
* Sets the current brush selection in a popup.
*
* Sets the current brush selection in a popup.
*
* Returns: TRUE on success.
*/
gboolean
gimp_brushes_set_popup (gchar *brush_callback,
gchar *brush_name,
......
......@@ -23,6 +23,29 @@
#include "gimp.h"
/**
* _gimp_channel_new:
* @image_ID: The image to which to add the channel.
* @width: The channel width.
* @height: The channel height.
* @name: The channel name.
* @opacity: The channel opacity.
* @red:
* @green:
* @blue: The channel compositing color.
*
* Create a new channel.
*
* This procedure creates a new channel with the specified width and
* height. Name, opacity, and color are also supplied parameters. The
* new channel still needs to be added to the image, as this is not
* automatic. Add the new channel with the 'gimp_image_add_channel'
* command. Other attributes such as channel show masked, should be set
* with explicit procedure calls. The channel's contents are undefined
* initially.
*
* Returns: The newly created channel.
*/
gint32
_gimp_channel_new (gint32 image_ID,
gint width,
......@@ -60,6 +83,16 @@ _gimp_channel_new (gint32 image_ID,
return channel_ID;
}
/**
* gimp_channel_copy:
* @channel_ID: The channel to copy.
*
* Copy a channel.
*
* This procedure copies the specified channel and returns the copy.
*
* Returns: The newly copied channel.
*/
gint32
gimp_channel_copy (gint32 channel_ID)
{
......@@ -80,6 +113,17 @@ gimp_channel_copy (gint32 channel_ID)
return channel_copy_ID;
}
/**
* gimp_channel_delete:
* @channel_ID: The channel to delete.
*
* Delete a channel.
*
* This procedure deletes the specified channel. This does not need to
* be done if a gimage containing this channel was already deleted.
*
* Returns: TRUE on success.
*/
gboolean
gimp_channel_delete (gint32 channel_ID)
{
......@@ -99,6 +143,16 @@ gimp_channel_delete (gint32 channel_ID)
return success;
}
/**
* gimp_channel_get_name:
* @channel_ID: The channel.
*
* Get the name of the specified channel.
*
* This procedure returns the specified channel's name.
*
* Returns: The channel name.
*/
gchar *
gimp_channel_get_name (gint32 channel_ID)
{
......@@ -119,6 +173,17 @@ gimp_channel_get_name (gint32 channel_ID)
return name;
}
/**
* gimp_channel_set_name:
* @channel_ID: The channel.
* @name: The new channel name.
*
* Set the name of the specified channel.
*
* This procedure sets the specified channel's name.
*
* Returns: TRUE on success.
*/
gboolean
gimp_channel_set_name (gint32 channel_ID,
gchar *name)
......@@ -140,6 +205,16 @@ gimp_channel_set_name (gint32 channel_ID,
return success;
}
/**
* gimp_channel_get_visible:
* @channel_ID: The channel.
*
* Get the visibility of the specified channel.
*
* This procedure returns the specified channel's visibility.
*
* Returns: The channel visibility.
*/
gboolean
gimp_channel_get_visible (gint32 channel_ID)
{
......@@ -160,6 +235,17 @@ gimp_channel_get_visible (gint32 channel_ID)
return visible;
}
/**
* gimp_channel_set_visible:
* @channel_ID: The channel.
* @visible: The new channel visibility.
*
* Set the visibility of the specified channel.
*
* This procedure sets the specified channel's visibility.
*
* Returns: TRUE on success.
*/
gboolean
gimp_channel_set_visible (gint32 channel_ID,
gboolean visible)
......@@ -181,6 +267,19 @@ gimp_channel_set_visible (gint32 channel_ID,
return success;
}
/**
* gimp_channel_get_show_masked:
* @channel_ID: The channel.
*
* Get the composite method of the specified channel.
*
* This procedure returns the specified channel's composite method. If
* it is non-zero, then the channel is composited with the image so
* that masked regions are shown. Otherwise, selected regions are
* shown.
*
* Returns: The channel composite method.
*/
gboolean
gimp_channel_get_show_masked (gint32 channel_ID)
{
......@@ -201,6 +300,19 @@ gimp_channel_get_show_masked (gint32 channel_ID)
return show_masked;
}
/**
* gimp_channel_set_show_masked:
* @channel_ID: The channel.
* @show_masked: The new channel composite method.
*
* Set the composite method of the specified channel.
*
* This procedure sets the specified channel's composite method. If it
* is non-zero, then the channel is composited with the image so that
* masked regions are shown. Otherwise, selected regions are shown.
*
* Returns: TRUE on success.
*/
gboolean
gimp_channel_set_show_masked (gint32 channel_ID,
gboolean show_masked)
......@@ -222,6 +334,16 @@ gimp_channel_set_show_masked (gint32 channel_ID,
return success;
}
/**
* gimp_channel_get_opacity:
* @channel_ID: The channel.
*
* Get the opacity of the specified channel.
*
* This procedure returns the specified channel's opacity.
*
* Returns: The channel opacity.
*/
gdouble
gimp_channel_get_opacity (gint32 channel_ID)
{
......@@ -242,6 +364,17 @@ gimp_channel_get_opacity (gint32 channel_ID)
return opacity;
}
/**
* gimp_channel_set_opacity:
* @channel_ID: The channel.
* @opacity: The new channel opacity.
*
* Set the opacity of the specified channel.
*
* This procedure sets the specified channel's opacity.
*
* Returns: TRUE on success.
*/
gboolean
gimp_channel_set_opacity (gint32 channel_ID,
gdouble opacity)
......@@ -263,6 +396,19 @@ gimp_channel_set_opacity (gint32 channel_ID,
return success;
}
/**
* gimp_channel_get_color:
* @channel_ID: The channel.
* @red:
* @green:
* @blue: The channel compositing color.
*
* Get the compositing color of the specified channel.
*
* This procedure returns the specified channel's compositing color.
*
* Returns: TRUE on success.
*/
gboolean
gimp_channel_get_color (gint32 channel_ID,
guchar *red,
......@@ -292,6 +438,19 @@ gimp_channel_get_color (gint32 channel_ID,
return success;
}
/**
* gimp_channel_set_color:
* @channel_ID: The channel.
* @red:
* @green:
* @blue: The new channel compositing color.
*
* Set the compositing color of the specified channel.
*
* This procedure sets the specified channel's compositing color.
*
* Returns: TRUE on success.
*/
gboolean
gimp_channel_set_color (gint32 channel_ID,
guchar red,
......@@ -320,6 +479,19 @@ gimp_channel_set_color (gint32 channel_ID,
return success;
}
/**
* gimp_channel_get_tattoo:
* @channel_ID: The channel.
*
* Get the tattoo of the specified channel.
*
* This procedure returns the specified channel's tattoo. A tattoo is a
* unique and permanent identifier attached to a channel that can be
* used to uniquely identify a channel within an image even between
* sessions.
*
* Returns: The channel tattoo.
*/
gint
gimp_channel_get_tattoo (gint32 channel_ID)
{
......@@ -340,6 +512,20 @@ gimp_channel_get_tattoo (gint32 channel_ID)
return tattoo;
}
/**
* gimp_channel_set_tattoo:
* @channel_ID: The channel.
* @tattoo: The new channel tattoo.
*
* Set the tattoo of the specified channel.
*
* This procedure sets the specified channel's tattoo. A tattoo is a
* unique and permanent identifier attached to a channel that can be
* used to uniquely identify a channel within an image even between
* sessions.
*
* Returns: TRUE on success.
*/
gboolean
gimp_channel_set_tattoo (gint32 channel_ID,
gint tattoo)
......
......@@ -23,6 +23,26 @@
#include "gimp.h"
/**
* gimp_channel_ops_offset:
* @drawable_ID: The drawable to offset.
* @wrap_around: wrap image around or fill vacated regions.
* @fill_type: fill vacated regions of drawable with background or transparent.
* @offset_x: offset by this amount in X direction.
* @offset_y: offset by this amount in Y direction.
*
* Offset the drawable by the specified amounts in the X and Y
* directions
*
* This procedure offsets the specified drawable by the amounts
* specified by 'offset_x' and 'offset_y'. If 'wrap_around' is set to
* TRUE, then portions of the drawable which are offset out of bounds
* are wrapped around. Alternatively, the undefined regions of the
* drawable can be filled with transparency or the background color, as
* specified by the 'fill_type' parameter.
*
* Returns: TRUE on success.
*/
gboolean
gimp_channel_ops_offset (gint32 drawable_ID,
gboolean wrap_around,
......@@ -50,6 +70,17 @@ gimp_channel_ops_offset (gint32 drawable_ID,
return success;
}
/**
* gimp_channel_ops_duplicate:
* @image_ID: The image.
*
* Duplicate the specified image
*
* This procedure duplicates the specified image, copying all layers,
* channels, and image information.
*
* Returns: The new, duplicated image.
*/
gint32
gimp_channel_ops_duplicate (gint32 image_ID)
{
......
......@@ -23,6 +23,20 @@
#include "gimp.h"
/**
* gimp_brightness_contrast:
* @drawable_ID: The drawable.
* @brightness: Brightness adjustment.
* @contrast: Contrast adjustment.
*
* Modify brightness/contrast in the specified drawable.
*
* This procedures allows the brightness and contrast of the specified
* drawable to be modified. Both 'brightness' and 'contrast' parameters
* are defined between -127 and 127.
*
* Returns: TRUE on success.
*/
gboolean
gimp_brightness_contrast (gint32 drawable_ID,
gint brightness,
......@@ -46,6 +60,33 @@ gimp_brightness_contrast (gint32 drawable_ID,
return success;
}
/**
* gimp_levels:
* @drawable_ID: The drawable.
* @channel: The channel to modify.
* @low_input: Intensity of lowest input.
* @high_input: Intensity of highest input.
* @gamma: Gamma correction factor.
* @low_output: Intensity of lowest output.
* @high_output: Intensity of highest output.
*
* Modifies intensity levels in the specified drawable.
*
* This tool allows intensity levels in the specified drawable to be
* remapped according to a set of parameters. The low/high input levels
* specify an initial mapping from the source intensities. The gamma
* value determines how intensities between the low and high input
* intensities are interpolated. A gamma value of 1.0 results in a
* linear interpolation. Higher gamma values result in more high-level
* intensities. Lower gamma values result in more low-level
* intensities. The low/high output levels constrain the final
* intensity mapping--that is, no final intensity will be lower than
* the low output level and no final intensity will be higher than the
* high output level. This tool is only valid on RGB color and
* grayscale images. It will not operate on indexed drawables.
*
* Returns: TRUE on success.
*/
gboolean
gimp_levels (gint32 drawable_ID,
GimpChannelLutType channel,
......@@ -77,6 +118,18 @@ gimp_levels (gint32 drawable_ID,
return success;
}
/**
* gimp_posterize:
* @drawable_ID: The drawable.
* @levels: Levels of posterization.
*
* Posterize the specified drawable.
*
* This procedures reduces the number of shades allows in each
* intensity channel to the specified 'levels' parameter.
*
* Returns: TRUE on success.
*/
gboolean
gimp_posterize (gint32 drawable_ID,
gint levels)
......@@ -98,6 +151,17 @@ gimp_posterize (gint32 drawable_ID,
return success;
}
/**
* gimp_desaturate:
* @drawable_ID: The drawable.
*
* Desaturate the contents of the specified drawable.
*
* This procedure desaturates the contents of the specified drawable.
* This procedure only works on drawables of type RGB color.
*
* Returns: TRUE on success.
*/
gboolean
gimp_desaturate (gint32 drawable_ID)
{
......@@ -117,6 +181,24 @@ gimp_desaturate (gint32 drawable_ID)
return success;
}
/**
* gimp_equalize:
* @drawable_ID: The drawable.
* @mask_only: Equalization option.
*
* Equalize the contents of the specified drawable.
*
* This procedure equalizes the contents of the specified drawable.
* Each intensity channel is equalizeed independently. The equalized
* intensity is given as inten' = (255 - inten). Indexed color
* drawables are not valid for this operation. The 'mask_only' option
* specifies whether to adjust only the area of the image within the
* selection bounds, or the entire image based on the histogram of the
* selected area. If there is no selection, the entire image is
* adjusted based on the histogram for the entire image.
*
* Returns: TRUE on success.
*/
gboolean
gimp_equalize (gint32 drawable_ID,
gboolean mask_only)
......@@ -138,6 +220,19 @@ gimp_equalize (gint32 drawable_ID,
return success;
}
/**
* gimp_invert:
* @drawable_ID: The drawable.
*
* Invert the contents of the specified drawable.
*
* This procedure inverts the contents of the specified drawable. Each
* intensity channel is inverted independently. The inverted intensity
* is given as inten' = (255 - inten). Indexed color drawables are not
* valid for this operation.
*
* Returns: TRUE on success.
*/
gboolean
gimp_invert (gint32 drawable_ID)
{
......@@ -157,6 +252,25 @@ gimp_invert (gint32 drawable_ID)
return success;
}
/**
* gimp_curves_spline:
* @drawable_ID: The drawable.
* @channel: The channel to modify.
* @num_points: The number of values in the control point array.
* @control_pts: The spline control points: { cp1.x, cp1.y, cp2.x, cp2.y, ... }.
*
* Modifies the intensity curve(s) for specified drawable.
*
* Modifies the intensity mapping for one channel in the specified
* drawable. The drawable must be either grayscale or RGB, and the
* channel can be either an intensity component, or the value. The
* 'control_pts' parameter is an array of integers which define a set
* of control points which describe a Catmull Rom spline which yields
* the final intensity curve. Use the 'gimp_curves_explicit' function
* to explicitly modify intensity levels.
*
* Returns: TRUE on success.
*/
gboolean
gimp_curves_spline (gint32 drawable_ID,
GimpChannelLutType channel,
......@@ -182,6 +296,25 @@ gimp_curves_spline (gint32 drawable_ID,
return success;
}
/**
* gimp_curves_explicit:
* @drawable_ID: The drawable.
* @channel: The channel to modify.
* @num_bytes: The number of bytes in the new curve (always 256).
* @curve: The explicit curve.
*
* Modifies the intensity curve(s) for specified drawable.
*
* Modifies the intensity mapping for one channel in the specified
* drawable. The drawable must be either grayscale or RGB, and the
* channel can be either an intensity component, or the value. The
* 'curve' parameter is an array of bytes which explicitly defines how
* each pixel value in the drawable will be modified. Use the
* 'gimp_curves_spline' function to modify intensity levels with
* Catmull Rom splines.
*
* Returns: TRUE on success.
*/
gboolean
gimp_curves_explicit (gint32 drawable_ID,
GimpChannelLutType channel,
......@@ -207,6 +340,28 @@ gimp_curves_explicit (gint32 drawable_ID,
return success;
}
/**
* gimp_color_balance:
* @drawable_ID: The drawable.
* @transfer_mode: Transfer mode.
* @preserve_lum: Preserve luminosity values at each pixel.
* @cyan_red: Cyan-Red color balance.
* @magenta_green: Magenta-Green color balance.
* @yellow_blue: Yellow-Blue color balance.
*
* Modify the color balance of the specified drawable.
*
* Modify the color balance of the specified drawable. There are three
* axis which can be modified: cyan-red, magenta-green, and
* yellow-blue. Negative values increase the amount of the former,
* positive values increase the amount of the latter. Color balance can
* be controlled with the 'transfer_mode' setting, which allows
* shadows, midtones, and highlights in an image to be affected
* differently. The 'preserve_lum' parameter, if non-zero, ensures that
* the luminosity of each pixel remains fixed.
*
* Returns: TRUE on success.
*/
gboolean
gimp_color_balance (gint32 drawable_ID,
GimpTransferMode transfer_mode,
......@@ -236,6 +391,38 @@ gimp_color_balance (gint32 drawable_ID,
return success;
}
/**
* gimp_histogram:
* @drawable_ID: The drawable.
* @channel: The channel to modify.
* @start_range: Start of the intensity measurement range.
* @end_range: End of the intensity measurement range.
* @mean: Mean itensity value.
* @std_dev: Standard deviation of intensity values.
* @median: Median itensity value.
* @pixels: Alpha-weighted pixel count for entire image.
* @count: Alpha-weighted pixel count for range.
* @percentile: Percentile that range falls under.
*
* Returns information on the intensity histogram for the specified
* drawable.
*
* This tool makes it possible to gather information about the
* intensity histogram of a drawable. A channel to examine is first
* specified. This can be either value, red, green, or blue, depending
* on whether the drawable is of type color or grayscale. The drawable
* may not be indexed. Second, a range of intensities are specified.
* The gimp_histogram function returns statistics based on the pixels
* in the drawable that fall under this range of values. Mean, standard
* deviation, median, number of pixels, and percentile are all
* returned. Additionally, the total count of pixels in the image is
* returned. Counts of pixels are weighted by any associated alpha
* values and by the current selection mask. That is, pixels that lie
* outside an active selection mask will not be counted. Similarly,
* pixels with transparent alpha values will not be counted.
*
* Returns: TRUE on success.
*/
gboolean
gimp_histogram (gint32 drawable_ID,
GimpChannelLutType channel,
......@@ -284,6 +471,22 @@ gimp_histogram (gint32 drawable_ID,
return success;
}
/**
* gimp_hue_saturation:
* @drawable_ID: The drawable.
* @hue_range: Range of affected hues.
* @hue_offset: Hue offset in degrees.
* @lightness: lightness modification.
* @saturation: saturation modification.
*
* Modify hue, lightness, and saturation in the specified drawable.
*
* This procedures allows the hue, lightness, and saturation in the
* specified drawable to be modified. The 'hue_range' parameter
* provides the capability to limit range of affected hues.
*
* Returns: TRUE on success.
*/
gboolean
gimp_hue_saturation (gint32 drawable_ID,
GimpHueRange hue_range,
......@@ -311,6 +514,21 @@ gimp_hue_saturation (gint32 drawable_ID,
return success;
}
/**
* gimp_threshold:
* @drawable_ID: The drawable.
* @low_threshold: The low threshold value.
* @high_threshold: The high threshold value.
*
* Threshold the specified drawable.
*
* This procedures generates a threshold map of the specified drawable.
* All pixels between the values of 'low_threshold' and
* 'high_threshold' are replaced with white, and all other pixels with
* black.
*
* Returns: TRUE on success.
*/
gboolean
gimp_threshold (gint32 drawable_ID,
gint low_threshold,
......
......@@ -23,6 +23,19 @@
#include "gimp.h"
/**
* gimp_convert_rgb:
* @image_ID: The image.
*
* Convert specified image to RGB color
*
* This procedure converts the specified image to RGB color. This
* process requires an image of type GRAY or INDEXED. No image content
* is lost in this process aside from the colormap for an indexed
* image.
*
* Returns: TRUE on success.
*/
gboolean
gimp_convert_rgb (gint32 image_ID)
{
......@@ -42,6 +55,18 @@ gimp_convert_rgb (gint32 image_ID)
return success;
}
/**
* gimp_convert_grayscale:
* @image_ID: The image.
*
* Convert specified image to grayscale (256 intensity levels)
*
* This procedure converts the specified image to grayscale with 8 bits
* per pixel (256 intensity levels). This process requires an image of
* type RGB or INDEXED.
*
* Returns: TRUE on success.
*/
gboolean
gimp_convert_grayscale (gint32 image_ID)
{
......@@ -61,6 +86,34 @@ gimp_convert_grayscale (gint32 image_ID)
return success;
}
/**
* gimp_convert_indexed:
* @image_ID: The image.
* @dither_type: dither type (0=none, 1=fs, 2=fs/low-bleed 3=fixed).