Reference for Processing version 1.5. If you have a previous version, use the reference included with your software. If you see any errors or have suggestions, please let us know. If you prefer a more technical reference, visit the Processing Javadoc.

Class | PImage

Name

### get()

Examples

    PImage img = loadImage("tower.jpg");
    background(img);
    noStroke();
    color c = img.get(60, 90);
    fill(c);
    rect(25, 25, 50, 50);

    PImage img = loadImage("tower.jpg");
    background(img);
    PImage b = img.get(50, 0, 50, 100);
    image(b, 0, 0);

Description

Reads the color of any pixel or grabs a group of pixels. If no parameters are specified, the entire image is returned. Get the value of one pixel by specifying an x,y coordinate. Get a section of the display window by specifing an additional width and height parameter. If the pixel requested is outside of the image window, black is returned. The numbers returned are scaled according to the current color ranges, but only RGB values are returned by this function. Even though you may have drawn a shape with colorMode(HSB), the numbers returned will be in RGB.
Getting the color of a single pixel with get(x, y) is easy, but not as fast as grabbing the data directly from pixels[]. The equivalent statement to "get(x, y)" using pixels[] is "pixels[y*width+x]". Processing requires calling loadPixels() to load the display window data into the pixels[] array before getting the values.
As of release 0149, this function ignores imageMode().

Syntax

    img.get()
    img.get(x, y)
    img.get(x, y, width, height)

Parameters

img | PImage: any variable of type PImage
x | int: x-coordinate of the pixel
y | int: y-coordinate of the pixel
width | int: width of pixel rectangle to get
height | int: height of pixel rectangle to get

Returns | color or PImage
Usage | Web & Application
Related | set() pixels[] copy()

Updated on August 30, 2010 04:29:39pm EDT