Browse Source

Document the pixel layout of YUV format surfaces

Fixes https://github.com/libsdl-org/SDL/issues/10530
Sam Lantinga 8 months ago
parent
commit
08de6656fc
1 changed files with 2 additions and 0 deletions
  1. 2 0
      include/SDL3/SDL_surface.h

+ 2 - 0
include/SDL3/SDL_surface.h

@@ -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