gimp_bucket_fill (1995-1996)

NAME

gimp_bucket_fill - Fill the area specified either by the current selection if there is one, or by a seed fill starting at the specified coordinates.

SYNOPSIS

gimp_bucket_fill (drawable,fill_mode,paint_mode,opacity,threshold,sample_merged,x,y)

DESCRIPTION

This tool requires information on the paint application mode, and the fill mode, which can either be in the foreground color, or in the currently active pattern. If there is no selection, a seed fill is executed at the specified coordinates and extends outward in keeping with the threshold parameter. If there is a selection in the target image, the threshold, sample merged, x, and y arguments are unused. If the sample_merged parameter is non-zero, the data of the composite image will be used instead of that for the specified drawable. This is equivalent to sampling for colors after merging all visible layers. In the case of merged sampling, the x,y coordinates are relative to the image's origin; otherwise, they are relative to the drawable's origin.

INPUT ARGUMENTS

TYPE	NAME	DESCRIPTION
DRAWABLE	drawable	The affected drawable
INT32	fill_mode	The type of fill: { FG_BUCKET_FILL (0), BG_BUCKET_FILL (1), PATTERN_BUCKET_FILL (2) }
INT32	paint_mode	The paint application mode: { NORMAL_MODE (0), DISSOLVE_MODE (1), BEHIND_MODE (2), MULTIPLY_MODE (3), SCREEN_MODE (4), OVERLAY_MODE (5), DIFFERENCE_MODE (6), ADDITION_MODE (7), SUBTRACT_MODE (8), DARKEN_ONLY_MODE (9), LIGHTEN_ONLY_MODE (10), HUE_MODE (11), SATURATION_MODE (12), COLOR_MODE (13), VALUE_MODE (14), DIVIDE_MODE (15) }
FLOAT	opacity	The opacity of the final bucket fill (0 <= opacity <= 100)
FLOAT	threshold	The threshold determines how extensive the seed fill will be. It's value is specified in terms of intensity levels (0 <= threshold <= 255). This parameter is only valid when there is no selection in the specified image.
INT32	sample_merged	Use the composite image, not the drawable
FLOAT	x	The x coordinate of this bucket fill's application. This parameter is only valid when there is no selection in the specified image.
FLOAT	y	The y coordinate of this bucket fill's application. This parameter is only valid when there is no selection in the specified image.

SOME SYNTAX ALTERNATIVES

$drawable->bucket_fill (fill_mode,paint_mode,opacity,threshold,sample_merged,x,y)

AUTHOR

Spencer Kimball & Peter Mattis
(c)1995-1996 Spencer Kimball & Peter Mattis