Gimp.Image.pick_color

@accepts(Gimp.Image, int, [Gimp.Item], float, float, bool, bool, float, Gimp.RGB)
@returns(bool)
def pick_color(self, num_drawables, drawables, x, y, sample_merged, sample_average, average_radius, color):
    # Python wrapper for gimp_image_pick_color()
  

Determine the color at the given coordinates

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 drawables, then an error is returned. All drawables must belong to the image and be of the same type. If only one drawable is given and it 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. With several drawables specified, the composite image with only these drawables is used. If the sample_merged parameter is TRUE, the data of the composite image will be used instead of that for the specified drawables. This is equivalent to sampling for colors after merging all visible layers. In the case of a merged sampling, the supplied drawables are ignored.

self

The image.

num_drawables

The number of drawables.

drawables

The drawables to pick from.

x

x coordinate of upper-left corner of rectangle.

y

y coordinate of upper-left corner of rectangle.

sample_merged

Use the composite image, not the drawables.

sample_average

Average the color of all the pixels in a specified radius.

average_radius

The radius of pixels to average.

color

The return color.

Returns