Wiki Page Content

Revision 6 as of 2010-10-11 04:51:50

Clear message

DRAFT

SDL_UnlockSurface

Use this function to set up release a surface for after directly accessing the pixels.

Syntax

void SDL_UnlockSurface(SDL_Surface* surface)

Function Parameters

surface

the SDL_Surface to be unlocked

Code Examples

/* Make the pixels pointer valid in the surface */

SDL_LockSurface(surface);

/* Surface is locked */
/* Direct pixel access on surface here */

SDL_UnlockSurface(surface);

/* Surface is now unlocked */

Remarks

Between calls to SDL_LockSurface() / SDL_UnlockSurface(), you can write to and read from surface->pixels, using the pixel format stored in surface->format. Once you are done accessing the surface, you should use SDL_UnlockSurface() to release it.

Not all surfaces require locking. If SDL_MUSTLOCK(surface) evaluates to 0, then you can read and write to the surface at any time, and the pixel format of the surface will not change.

No operating system or library calls should be made between lock/unlock pairs, as critical system locks may be held during this time.

*
Note : Since 1.1.8, the surface locks are recursive. See SDL_LockSurface() for more information.
*


CategoryAPI, CategorySurface

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit