gimp-image-pick-color

Spencer Kimball & Peter Mattis

Description

Determine the color at the given drawable coordinates

Help

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 TRUE, 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.


Type

unknown

Parameters

Type Name Description
PF_IMAGE image The image
PF_DRAWABLE drawable The drawable to pick from
PF_FLOAT x x coordinate of upper-left corner of rectangle
PF_FLOAT y y coordinate of upper-left corner of rectangle
PF_INT sample-merged Use the composite image, not the drawable (TRUE or FALSE)
PF_INT sample-average Average the color of all the pixels in a specified radius (TRUE or FALSE)
PF_FLOAT average-radius The radius of pixels to average (average-radius >= 0)

Return

Type Name Description
PF_COLOUR color The return color