SDL_LockSurface3
Set up a surface for directly accessing the pixels.
Usage
#include "SDL3/SDL.h"
bool SDL_LockSurface(SDL_Surface *surface);
Header file
Defined in SDL3/SDL_surface.h
Overview
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.
Function parameters
- surface
-
the
SDL_Surface
structure to be locked.
Return value
Returns true on success or false on failure; call
SDL_GetError () for more information.
Thread safety
This function is not thread safe. The locking referred to by this function is making the pixels available for direct access, not thread-safe locking.
Releases
12 releases since Debian 3.0 (Woody); the text changed 2 times.