GRAPHICS: Add some docs and sanity checks to the YUV to RGB code

1 files changed, 18 insertions, 0 deletions

diff --git a/graphics/yuv_to_rgb.h b/graphics/yuv_to_rgb.h
index 30f64ee570..9b561f2002 100644
--- a/graphics/yuv_to_rgb.h
+++ b/graphics/yuv_to_rgb.h
@@ -23,6 +23,12 @@
  *
  */
 
+/**
+ * @file
+ * YUV to RGB conversion used in engines:
+ * - sword25
+ */
+
 #ifndef GRAPHICS_YUV_TO_RGB_H
 #define GRAPHICS_YUV_TO_RGB_H
 
@@ -33,6 +39,18 @@ namespace Graphics {
 
 struct Surface;
 
+/**
+ * Convert a YUV420 image to an RGB surface
+ *
+ * @param dst     the destination surface
+ * @param ySrc    the source of the y component
+ * @param uSrc    the source of the u component
+ * @param vSrc    the source of the v component
+ * @param yWidth  the width of the y surface (must be divisible by 2)
+ * @param yHeight the height of the y surface (must be divisible by 2)
+ * @param yPitch  the pitch of the y surface
+ * @param uvPitch the pitch of the u and v surfaces
+ */
 void convertYUV420ToRGB(Graphics::Surface *dst, const byte *ySrc, const byte *uSrc, const byte *vSrc, int yWidth, int yHeight, int yPitch, int uvPitch);
 
 } // End of namespace Graphics