SDL_UpdateYUVTexture(3)

SDL_UpdateYUVTexture3

Update a rectangle within a planar yv12 or iyuv texture with new pixel data.

Usage

#include "SDL3/SDL.h"

bool SDL_UpdateYUVTexture(SDL_Texture *texture, const SDL_Rect *rect, const Uint8 *Yplane, int Ypitch, const Uint8 *Uplane, int Upitch, const Uint8 *Vplane, int Vpitch);

Header file

Defined in SDL3/SDL_render.h

Overview

You can use SDL_UpdateTexture () as long as your pixel data is a contiguous block of Y and U/V planes in the proper order, but this function is available if your pixel data is not contiguous.

Function parameters

texture

the texture to update.

rect

a pointer to the rectangle of pixels to update, or NULL to update the entire texture.

Yplane

the raw pixel data for the Y plane.

Ypitch

the number of bytes between rows of pixel data for the Y plane.

Uplane

the raw pixel data for the U plane.

Upitch

the number of bytes between rows of pixel data for the U plane.

Vplane

the raw pixel data for the V plane.

Vpitch

the number of bytes between rows of pixel data for the V plane.

Return value

Returns true on success or false on failure; 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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.