|
Size: 1370
Comment: update formatting - enums, structs, the/an
|
← Revision 8 as of 2011-01-11 23:22:09 ⇥
Size: 668
Comment: update content - w/ Sam; remove draft
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 3: | Line 3: |
| ||<tablewidth="100%" style="color: #FF0000;" :> DRAFT|| | |
| Line 6: | Line 5: |
| Use this function to ,,set up,, ^release^ a surface ,,for,, ^after^ directly accessing the pixels. | Use this function to release a surface after directly accessing the pixels. |
| Line 22: | Line 21: |
| 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. *<<BR>>Note : Since 1.1.8, the surface locks are recursive. See [[SDL_LockSurface]]() for more information. <<BR>>* |
<<Include(SDL_LockSurface, , , from="== Remarks ==", to="== Related Functions ==")>> |
SDL_UnlockSurface
Use this function to release a surface after directly accessing the pixels.
Syntax
void SDL_UnlockSurface(SDL_Surface* surface)
Function Parameters
surface |
the SDL_Surface structure 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.
