Document the pixel layout of YUV format surfaces

Fixes https://github.com/libsdl-org/SDL/issues/10530
This commit is contained in:
Sam Lantinga
2024-12-06 16:14:05 -08:00
parent 2ac62d8c67
commit 08de6656fc

View File

@@ -115,6 +115,8 @@ typedef enum SDL_FlipMode
* remaining bytes to reach the pitch are used as padding to reach a desired
* alignment, and have undefined contents.
*
* When a surface holds YUV format data, the planes are assumed to be contiguous without padding between them, e.g. a 32x32 surface in NV12 format with a pitch of 32 would consist of 32x32 bytes of Y plane followed by 32x16 bytes of UV plane.
*
* \since This struct is available since SDL 3.1.3.
*
* \sa SDL_CreateSurface