PgSetRegion(), PgSetRegionCx()

Specify which region will emit draw events

Synopsis:

void PgSetRegion( PhRid_t rid );

void PgSetRegionCx( void *dc,
                    PhRid_t rid );

Arguments:

dc

PgSetGCCx() 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()

rid

The region ID

Library:

ph

Description:

These functions specify which region will emit subsequent draw events.

If rid is the current region, this function does nothing.

If rid isn't the current region, this function:

• Specifies rid as the region which will emit draw events.
• Resets the clipping rectangle to the full size of the region. Note that all draws are clipped to the region that emits them.
• Flushes the data before changing the current region, if the draw buffer contains unflushed data.

PgSetRegion() works on the current draw context, while you can specify the draw context for PgSetRegionCx().

Classification:

Photon

See also:

PgFlush*(), PgGetRegion*(), PgSetClipping*()