---
name: "SDL_LockTexture"
section: "3"
platform: "linux"
package: "libsdl3-doc"
version: "3.2.10+ds-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/SDL_LockTexture"
---

# SDL\_LockTexture(3)

Lock a portion of the texture for write-only pixel access.

## NAME

SDL\_LockTexture - Lock a portion of the texture for **write-only** pixel access.

## HEADER FILE

Defined in SDL3/SDL\_render.h

## SYNOPSIS

```
#include "SDL3/SDL.h"
```

**bool SDL\_LockTexture(SDL\_Texture \*texture,**                 **const SDL\_Rect \*rect,**                 **void \*\*pixels, int \*pitch);**

## 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.

## 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.

## THREAD SAFETY

This function should only be called on the main thread.

## AVAILABILITY

This function is available since SDL 3.2.0.

## SEE ALSO

**•**(3), [**SDL\_LockTextureToSurface**(3)](/SDL_LockTextureToSurface/3.md), **•**(3), [**SDL\_UnlockTexture**(3)](/SDL_UnlockTexture/3.md)