PgGetRegion(), PgGetRegionCx()

Get the ID of the region that emits draw events

Synopsis:

PhRid_t PgGetRegion( void );

PhRid_t PgGetRegionCx( void *dc );

Arguments:

dc

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

Library:

ph

Description:

These functions get the ID of the region that currently emits draw events.

PgGetRegion() works on the current draw context, while you can specify the draw context for PgGetRegionCx().

Returns:

The ID of the region.

Classification:

Photon

See also:

PgSetRegion*()