.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_LockSurface:
.\"   https://wiki.libsdl.org/SDL_LockSurface
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_LockSurface
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_LockSurface 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_LockSurface \- Set up a surface for directly accessing the pixels\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "int SDL_LockSurface(SDL_Surface *surface);
.fi
.SH DESCRIPTION
Between calls to 
.BR SDL_LockSurface
() /

.BR SDL_UnlockSurface
(), you can write to and read from
.BR surface->pixels
, using the pixel format stored in
.BR surface->format
\[char46] Once
you are done accessing the surface, you should use

.BR SDL_UnlockSurface
() to release it\[char46]

Not all surfaces require locking\[char46] If
.BR 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\[char46]

.SH FUNCTION PARAMETERS
.TP
.I surface
the 
.BR SDL_Surface
 structure to be locked
.SH RETURN VALUE
Returns 0 on success or a negative error code on failure; call

.BR SDL_GetError
() for more information\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR SDL_MUSTLOCK (3),
.BR SDL_UnlockSurface (3)