table of contents
- experimental 3.1.0+ds-1
SDL_LockTextureToSurface(3) | SDL3 FUNCTIONS | SDL_LockTextureToSurface(3) |
NAME¶
SDL_LockTextureToSurface - Lock a portion of the texture for write-only pixel access, and expose it as a SDL surface.
SYNOPSIS¶
#include "SDL3/SDL.h"
int SDL_LockTextureToSurface(SDL_Texture *texture, const SDL_Rect *rect, SDL_Surface **surface);
DESCRIPTION¶
Besides providing an SDL_Surface
instead of raw pixel data, this function operates like SDL_LockTexture
.
As an optimization, the pixels made available for editing don't necessarily contain the old texture data. This is a write-only operation, and if you need to keep a copy of the texture data you should do that at the application level.
You must use SDL_UnlockTexture () to unlock the pixels and apply any changes.
The returned surface is freed internally after calling
SDL_UnlockTexture () or
SDL_DestroyTexture (). The caller should not free it.
FUNCTION PARAMETERS¶
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.0 | SDL |