From 77016efd27c70b4e7c577cf2f7b351b78b71c7b9 Mon Sep 17 00:00:00 2001
From: wm4 <wm4@nowhere>
Date: Sun, 21 Oct 2012 20:23:59 +0200
Subject: [PATCH] sub: add clarifying comments

---
 sub/sub.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/sub/sub.h b/sub/sub.h
index 88a49a2906..cc03396f04 100644
--- a/sub/sub.h
+++ b/sub/sub.h
@@ -27,6 +27,7 @@
 struct vo;
 struct sub_render_params;
 
+// NOTE: VOs must support at least SUBBITMAP_LIBASS and SUBBITMAP_RGBA.
 enum sub_bitmap_format {
     SUBBITMAP_EMPTY = 0,// no bitmaps; always has num_parts==0
     SUBBITMAP_LIBASS,   // A8, with a per-surface blend color (libass.color)
@@ -39,7 +40,8 @@ enum sub_bitmap_format {
 // For SUBBITMAP_INDEXED
 struct osd_bmp_indexed {
     uint8_t *bitmap;
-    // Each entry is like a pixel in SUBBITMAP_RGBA format
+    // Each entry is like a pixel in SUBBITMAP_RGBA format, but using straight
+    // alpha.
     uint32_t palette[256];
 };