NAME

       SDL_LockSurface - Set up a surface for directly accessing the pixels.

SYNOPSIS

       #include <SDL3/SDL_surface.h>

       bool 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

       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.

AVAILABILITY

       This function is available since SDL 3.2.0.

SEE ALSO

       SDL_MUSTLOCK(3), SDL_UnlockSurface(3)

Simple Directmedia Layer                           SDL 3.2.26                                 SDL_LockSurface(3)