PgMultiBlit(), PgMultiBlitCx()

Blit a multi-rectangular area

Synopsis:

int PgMultiBlit( unsigned short nrects,
                 const PhRect_t rects[],
                 const PhPoint_t *offset );

int PgMultiBlitCx( void *dc,
                   unsigned short nrects,
                   const PhRect_t rects[],
                   const PhPoint_t *offset );

Arguments:

dc

PgMultiBlitCx() only. A void pointer to any type of draw context. Examples of draw contexts are:

• a PhDrawContext_t returned by PhDCCreate()
• a PmMemoryContext_t returned by PmMemCreateMC()
• a PpPrintContext_t returned by PpCreatePC()
• a PdOffscreenContext_t returned by PdCreateOffscreenContext()

nrects

The number of items in the rects array.

rects[]

A pointer to an array of PhRect_t structures that define the areas the function blits. The areas can overlap; Photon detects the overlaps and the contents are blitted only once.

offset

A pointer to a PhPoint_t that defines an offset for the blitted area rect.

Library:

ph

Description:

These functions “blit” the multi-rectangular area that is defined by rects[]. The area is blitted by the given offset. When the draw context is the default context, other windows aren't affected by the blit.

PgMultiBlit() blits the region defined by the region set for the current draw context, while PgMultiBlitCx() lets you define the draw context dc.

Returns:

A nonnegative value

Success.

-1

The blit failed, possibly because the Photon Manager wasn't running.

Classification:

Photon

See also:

PgBlit*(), PhBlit(), PhMultiBlit(), PhMultiBlit(), PhPoint_t, PhRect_t, PtClippedBlit(), PtWidgetRid()