From c839fd50b5ddfcceada8cbbd3046ce219df248a0 Mon Sep 17 00:00:00 2001
From: Matthew Hoops
Date: Sun, 12 Aug 2012 17:44:23 -0400
Subject: GRAPHICS: Clarify format of the palette in ImageDecoder

---
 graphics/decoders/image_decoder.h | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'graphics/decoders')

diff --git a/graphics/decoders/image_decoder.h b/graphics/decoders/image_decoder.h
index 7fa00749ff..830645d361 100644
--- a/graphics/decoders/image_decoder.h
+++ b/graphics/decoders/image_decoder.h
@@ -75,6 +75,9 @@ public:
 	 * until destroy() or loadStream() is called, or until this ImageDecoder's
 	 * destructor is called.
 	 *
+	 * The palette's format is the same as PaletteManager's palette
+	 * (interleaved RGB values).
+	 *
 	 * @return the decoded palette, or 0 if no palette is present
 	 */
 	virtual const byte *getPalette() const { return 0; }
-- 
cgit v1.2.3