SDL_LockTexture - Lock a portion of the texture for write-only pixel access.
Contents
Availability
This function is available since SDL 3.2.0.
Description
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.
Function Parameters
texture
the texture to lock for access, which was created with SDL_TEXTUREACCESS_STREAMING .
rect an SDL_Rect
structure representing the area to lock for access; NULL to lock the entire texture.
pixels this is filled in with a pointer to the locked pixels, appropriately offset by the locked area.
pitch this is filled in with the pitch of the locked pixels; the pitch is the length of one row in
bytes.
Header File
Defined in SDL3/SDL_render.h
Name
SDL_LockTexture - Lock a portion of the texture for write-only pixel access.
Return Value
Returns true on success or false if the texture is not valid or was not created with
SDL_TEXTUREACCESS_STREAMING ; call
SDL_GetError () for more information.
See Also
•(3), SDL_LockTextureToSurface(3), •(3), SDL_UnlockTexture(3) Simple Directmedia Layer SDL 3.2.10 SDL_LockTexture(3)
Synopsis
#include"SDL3/SDL.h"boolSDL_LockTexture(SDL_Texture*texture,constSDL_Rect*rect,void**pixels,int*pitch);
Thread Safety
This function should only be called on the main thread.
