Function SDL_LockSurface

pub unsafe extern "C" fn SDL_LockSurface(
    surface: *mut SDL_Surface,
) -> bool

Available on crate feature dep_sdl3 only.

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.

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.

Availability

This function is available since SDL 3.2.0.

See also

• SDL_MUSTLOCK
• SDL_UnlockSurface