PgSetMultiClip()

Set a list of rectangles to clip drawing

Synopsis:

int PgSetMultiClip( int num, 
                    PhRect_t const *clip_list );

Description:

This function sets a list of rectangles to clip subsequent drawing operations. The rectangles are always relative to the origin of the current region. To disable this clipping, set clip_list to NULL or num to 0.

All subsequent drawing operations will be clipped to the intersection of the clipping rectangles set by PgSetClipping(), PgSetMultiClip(), and PgSetUserClip().

PhAttach(), PhReattach(), and PgSetRegion() reset the clipping rectangle to the full size of the region.

This function emits a draw command.

Returns:

0

Success.

-1

Unable to allocate enough memory (using malloc()) to store the clipping rectangles.

Classification:

Photon

See also:

PgSetClipping(), PgSetUserClip(), PgSetClipping(), PgSetUserClip()