Browse Source

Document that the pitch is the length of the image data for SDL_PIXELFORMAT_MJPG

Sam Lantinga 6 months ago
parent
commit
06602f4e80
1 changed files with 2 additions and 0 deletions
  1. 2 0
      include/SDL3/SDL_surface.h

+ 2 - 0
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