From 06602f4e80a00f349a22f505d31e459f6a22caf0 Mon Sep 17 00:00:00 2001
From: Sam Lantinga <[EMAIL REDACTED]>
Date: Thu, 20 Feb 2025 01:35:09 -0800
Subject: [PATCH] Document that the pitch is the length of the image data for
SDL_PIXELFORMAT_MJPG
---
include/SDL3/SDL_surface.h | 2 ++
1 file changed, 2 insertions(+)
diff --git a/include/SDL3/SDL_surface.h b/include/SDL3/SDL_surface.h
index 47d437fac5f53..dbe892c89a59b 100644
--- a/include/SDL3/SDL_surface.h
+++ b/include/SDL3/SDL_surface.h
@@ -120,6 +120,8 @@ typedef enum SDL_FlipMode
* format with a pitch of 32 would consist of 32x32 bytes of Y plane followed
* by 32x16 bytes of UV plane.
*
+ * When a surface holds MJPG format data, pixels points at the compressed JPEG image and pitch is the length of that data.
+ *
* \since This struct is available since SDL 3.2.0.
*
* \sa SDL_CreateSurface