PdIsOffscreenLocked()

Determine whether or not an offscreen context is locked

Synopsis:

int PdIsOffscreenLocked(
       PdOffscreenContext_t *osc );

Library:

ph

Description:

This function tests to see if the given offscreen context is currently locked.

This is really only useful for debugging purposes, because the state of the lock could potentially change between the time that PdIsOffscreenLocked() queries the status and reports it back to the application.

Returns:

One of:

Pg_OSC_LOCKED
Pg_OSC_LOCK_INVALID
Pg_OSC_NOT_LOCKED

Classification:

Photon

Safety:
Interrupt handler	No
Signal handler	No
Thread	No

See also:

PdCreateOffscreenLock(), PdDestroyOffscreenLock(), PdGetOffscreenContextPtr(), PdLockOffscreen(), PdUnlockOffscreen()

"Offscreen locks" in the Raw Drawing and Animation chapter of the Photon Programmer's Guide