table of contents
SDL_LockSurface(3) | SDL3 FUNCTIONS | SDL_LockSurface(3) |
NAME¶
SDL_LockSurface - Set up a surface for directly accessing the pixels.
HEADER FILE¶
Defined in SDL3/SDL_surface.h
SYNOPSIS¶
#include "SDL3/SDL.h"
int SDL_LockSurface(SDL_Surface *surface);
DESCRIPTION¶
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 0 on success or a negative error code on failure; call
SDL_GetError () for more information.
AVAILABILITY¶
This function is available since SDL 3.0.0.
SEE ALSO¶
SDL 3.1.2 | Simple Directmedia Layer |