GetPixelAddress

Returns a pointer to the pixel at the specified coordinates.

Synopsis

void *GetPixelAddress (Item scrbitItem,Coord x,Coord y)

Description

GetPixelAddress() returns a pointer to the pixel at the specified coordinates.

The argument scrbitItem can refer to either a screen item or a bitmap item. If scrbitItem is a bitmap item, the returned pointer is the address of the pixel in the Bitmaps buffer. If scrbitItem is a screen item, the returned pointer is the address of the pixel in the buffer of the bitmap associated with the screen.

Arguments

screenItem: Item number of the screen or bitmap containing the pixel.

x: The column of the desired pixel address.

y: Row of the desired pixel address.

Return Value

The call returns a pointer to the pixel in the buffer of the relevant bitmap, or NULL if an error occurs (such as specifying a pixel that lies outside the clip boundaries of the bitmap).

Notes

Future display modes can cause this call to return addresses of varying alignments. Try not to assume too much about the characteristics of the memory to which the returned address points.

Implementation

Folio call implemented in Graphics folio V20.

Associated Files

graphics.h, graphics.lib