SDL_LockSurface

Set up a surface for directly accessing the pixels.

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.

extern (C) nothrow @nogc extern
bool
SDL_LockSurface

Parameters

surface SDL_Surface*

the SDL_Surface structure to be locked.

Return Value

Type: bool

true on success or false on failure; call SDL_GetError() for more information.

See Also

SDL_MUSTLOCK SDL_UnlockSurface

Meta