---

PiGetPixelRGB()

Retrieve the RGB value of a pixel within an image

Synopsis:

int PiGetPixelRGB( PhImage_t const *image,
                   ushort_t x,
                   ushort_t y,
                   PgColor_t *value );

Library:

ph

Description:

This function retrieves the RGB value of a pixel within an image.

The image argument is a pointer to a PhImage_t structure that defines the image to be queried, while the x and y arguments specify the coordinates of the pixel to be examined. The value argument points to a PgColor_t where the result of the query is stored.

Returns:

0

Success.

-1

An error occurred because the pixel was out of bounds or the image type wasn't recognized.

Classification:

Photon

Safety:
Interrupt handler	No
Signal handler	No
Thread	No

See also:

PgColor_t, PhImage_t, PiGetPixel(), PiGetPixelFromData(), PiSetPixel(), PiSetPixelInData()

"Images" in the Raw Drawing and Animation chapter of the Photon Programmer's Guide

---