Bug 1004500 - Document imgIContainer::FLAG_WANT_DATA_SURFACE. r=seth
authorJonathan Watt <jwatt@jwatt.org>
Mon, 12 May 2014 01:54:21 +0100
changeset 182540 0276c57cffba7814152b8f0e65ddf4b8f744620d
parent 182539 d64fb8e9ef3f76aea2e7f9f57187213334bf9ad7
child 182541 81f84748793bfd022db5c583a58a680cf5877877
push id26764
push usercbook@mozilla.com
push dateMon, 12 May 2014 11:35:17 +0000
treeherdermozilla-central@a64ed5aba131 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersseth
bugs1004500
milestone32.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1004500 - Document imgIContainer::FLAG_WANT_DATA_SURFACE. r=seth
image/public/imgIContainer.idl
--- a/image/public/imgIContainer.idl
+++ b/image/public/imgIContainer.idl
@@ -147,16 +147,22 @@ interface imgIContainer : nsISupports
    */
 
   const long FLAG_NONE            = 0x0;
   const long FLAG_SYNC_DECODE     = 0x1;
   const long FLAG_DECODE_NO_PREMULTIPLY_ALPHA = 0x2;
   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;
 
   /**
     * Constants for specifying various "special" frames.
     *
     * FRAME_FIRST: The first frame
     * FRAME_CURRENT: The current frame
     *