PhGetRects()

Get an event's rectangle set

Synopsis:

PhRect_t *PhGetRects( PhEvent_t const *event );

Library:

ph

Description:

This function gets the rectangle set associated with the specified event. The number of rectangles in the event's rectangle set is given by event->num_rects.

In the case of an expose event, this function returns a pointer to the list of rectangles that need to be repaired. In the case of a pointer event, only one rectangle is associated with the event — the one associated with the current position of the pointer.

For more information on the meaning of the rectangle set for different event types, see the event types described for the PhEvent_t structure.

Returns:

A pointer to the rectangles associated with the event.

Classification:

Photon

See also:

PhEvent_t, PhGetData(), PhRect_t

Events chapter of the Photon Programmer's Guide