From 4b6d3a8f6df02633732e93e373b9dfc3184750a7 Mon Sep 17 00:00:00 2001
From: Jonathan Watt <jwatt@jwatt.org>
Date: Mon, 12 May 2014 01:54:21 +0100
Subject: [PATCH] Bug 1004500 - Document imgIContainer::FLAG_WANT_DATA_SURFACE.
 r=seth

---
 image/public/imgIContainer.idl | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/image/public/imgIContainer.idl b/image/public/imgIContainer.idl
index a500558fa553..2ee0ce4a4aae 100644
--- a/image/public/imgIContainer.idl
+++ b/image/public/imgIContainer.idl
@@ -152,6 +152,12 @@ interface imgIContainer : nsISupports
   const long FLAG_DECODE_NO_COLORSPACE_CONVERSION = 0x4;
   const long FLAG_CLAMP           = 0x8;
   const long FLAG_HIGH_QUALITY_SCALING = 0x10;
+  /**
+   * Can be passed to GetFrame when the caller wants a DataSourceSurface
+   * instead of a hardware accelerated surface. This can be important for
+   * performance (by avoiding an upload to/readback from the GPU) when the
+   * caller knows they want a SourceSurface of type DATA.
+   */
   const long FLAG_WANT_DATA_SURFACE = 0x20;
 
   /**