gfx/thebes/gfxUtils.h

   1 /* -*- Mode: C++; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  * ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla Corporation code.
  16  *
  17  * The Initial Developer of the Original Code is Mozilla Foundation.
  18  * Portions created by the Initial Developer are Copyright (C) 2008
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Robert O'Callahan <robert@ocallahan.org>
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef GFX_UTILS_H
  39 #define GFX_UTILS_H
  40
  41 #include "gfxTypes.h"
  42
  43 class gfxImageSurface;
  44
  45 class THEBES_API gfxUtils {
  46 public:
  47     /*
  48      * Premultiply or Unpremultiply aSourceSurface, writing the result
  49      * to aDestSurface or back into aSourceSurface if aDestSurface is null.
  50      *
  51      * If aDestSurface is given, it must have identical format, dimensions, and
  52      * stride as the source.
  53      *
  54      * If the source is not ImageFormatARGB32, no operation is performed.  If
  55      * aDestSurface is given, the data is copied over.
  56      */
  57     static void PremultiplyImageSurface(gfxImageSurface *aSourceSurface,
  58                                         gfxImageSurface *aDestSurface = nsnull);
  59     static void UnpremultiplyImageSurface(gfxImageSurface *aSurface,
  60                                           gfxImageSurface *aDestSurface = nsnull);
  61 };
  62
  63 #endif