PgWaitVSync(), PgWaitVSyncCx()

Wait for vertical synchronization

Synopsis:

void PgWaitVSync( void );

void PgWaitVSyncCx( void *dc );

Arguments:

dc

PgWaitVSyncCx() 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 insert a "wait for vertical sync" tag into the drawstream. The driver waits until a vertical refresh has started before continuing to render the draw stream.

These functions is available only in direct mode.

PgWaitVSync() works on the current draw context, while you can specify the draw context for PgWaitVSyncCx().

Examples:

PgSetFillColor(Pg_RED);
PgWaitVSync();
PgDrawIRect(0,0,99,99,Pg_DRAW_FILL);
PgSetFillColor(Pg_BLACK);
PgDrawIRect(9,9,89,89,Pg_DRAW_FILL);
PgFlush();  // Wait for Vsync, then draw 2 rects

Classification:

Photon

See also:

PgWaitDrawComplete(), PgWaitHWIdle()

"Direct mode" in the Raw Drawing and Animation chapter of the Photon Programmer's Guide