gimp_color_picker (1995-1996)

NAME

gimp_color_picker - Determine the color at the given drawable coordinates

SYNOPSIS

color = gimp_color_picker (image,drawable,x,y,sample_merged,sample_average,average_radius,save_color)

DESCRIPTION

This tool determines the color at the specified coordinates. The returned color is an RGB triplet even for grayscale and indexed drawables. If the coordinates lie outside of the extents of the specified drawable, then an error is returned. If the drawable has an alpha channel, the algorithm examines the alpha value of the drawable at the coordinates. If the alpha value is completely transparent (0), then an error is returned. 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 a merged sampling, the supplied drawable is ignored.

INPUT ARGUMENTS

TYPE	NAME	DESCRIPTION
IMAGE	image	The image
DRAWABLE	drawable	The affected drawable
FLOAT	x	x coordinate of upper-left corner of rectangle
FLOAT	y	y coordinate of upper-left corner of rectangle
INT32	sample_merged	Use the composite image, not the drawable
INT32	sample_average	Average the color of all the pixels in a specified radius
FLOAT	average_radius	The radius of pixels to average
INT32	save_color	Save the color to the active palette

RETURN VALUES

TYPE	NAME	DESCRIPTION
COLOUR	color	The return color

SOME SYNTAX ALTERNATIVES

color = $drawable->color_picker (x,y,sample_merged,sample_average,average_radius,save_color)
color = $image->color_picker (drawable,x,y,sample_merged,sample_average,average_radius,save_color)
color = gimp_color_picker (drawable,x,y,sample_merged,sample_average,average_radius,save_color)

AUTHOR

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