|
⇤ ← Revision 1 as of 2010-02-25 06:25:51
Size: 1373
Comment: create page, add content (Rev 5540)
|
Size: 1319
Comment: removed unnecessary markup
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 17: | Line 17: |
| <<Color2(green,should hyperlink be removed?)>> | |
| Line 28: | Line 27: |
| Between calls to [[SDL_LockSurface]]() / [[SDL_UnlockSurface]](), you can write to and read from \c surface->pixels, using the pixel format stored in \c surface->format. Once you are done accessing the surface, you should use [[SDL_UnlockSurface]]() to release it. | 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. |
DRAFT |
SDL_LockSurface
Use this function to set up a surface for directly accessing the pixels.
Contents
Syntax
int SDL_LockSurface(SDL_Surface* surface)
Function Parameters
surface |
a pointer to the SDL_Surface to be locked |
Return Value
Returns 0, or -1 if the surface couldn't be locked; call SDL_GetError() for more information.
Code Examples
You can add your code example here
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.
