PdUnlockOffscreen()

Unlock an offscreen context

Synopsis:

int PdUnlockOffscreen( PdOffscreenContext_t *osc );

Arguments:

osc
A pointer to the offscreen context, as returned by PdCreateOffscreenContext(), that you want to unlock.

Library:

ph

Description:

This function unlocks the offscreen context, osc. You can lock the offscreen context by calling PdLockOffscreen() after calling PdCreateOffscreenLock() to create the lock.

Returns:

EOK
The offscreen context was successfully unlocked.
Pg_OSC_ALREADY_UNLOCKED
The context wasn't locked to begin with (i.e. the semaphore count wasn't increased).
Pg_OSC_LOCK_INVALID
The lock is invalid.
Pg_OSC_NOT_LOCKED
The context wasn't locked.

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

PdCreateOffscreenLock(), PdDestroyOffscreenLock(), PdGetOffscreenContextPtr(), PdIsOffscreenLocked(), PdLockOffscreen()

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