gfx/thebes/public/gfxQuartzNativeDrawing.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 Thebes gfx.
  16  *
  17  * The Initial Developer of the Original Code is Mozilla Corporation.
  18  * Portions created by the Initial Developer are Copyright (C) 2008
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Matthew Gregan <kinetik@flim.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 _GFXQUARTZNATIVEDRAWING_H_
  39 #define _GFXQUARTZNATIVEDRAWING_H_
  40
  41 #include "gfxContext.h"
  42 #include "gfxQuartzSurface.h"
  43
  44 class THEBES_API gfxQuartzNativeDrawing {
  45 public:
  46
  47     /* Create native Quartz drawing for a rectangle bounded by
  48      * nativeRect.
  49      *
  50      * Typical usage looks like:
  51      *
  52      *   gfxQuartzNativeDrawing nativeDraw(ctx, nativeRect);
  53      *   CGContextRef cgContext = nativeDraw.BeginNativeDrawing();
  54      *   if (!cgContext)
  55      *     return NS_ERROR_FAILURE;
  56      *
  57      *     ... call Quartz operations on CGContextRef to draw to nativeRect ...
  58      *
  59      *   nativeDraw.EndNativeDrawing();
  60      */
  61     gfxQuartzNativeDrawing(gfxContext *ctx,
  62                            const gfxRect& nativeRect);
  63
  64     /* Returns a CGContextRef which may be used for native drawing.  This
  65      * CGContextRef is valid until EndNativeDrawing is called; if it is used
  66      * for drawing after that time, the result is undefined. */
  67     CGContextRef BeginNativeDrawing();
  68
  69     /* Marks the end of native drawing */
  70     void EndNativeDrawing();
  71
  72 private:
  73     // don't allow copying via construction or assignment
  74     gfxQuartzNativeDrawing(const gfxQuartzNativeDrawing&);
  75     const gfxQuartzNativeDrawing& operator=(const gfxQuartzNativeDrawing&);
  76
  77     nsRefPtr<gfxContext> mContext;
  78     gfxRect mNativeRect; // not yet used, will be needed for offscreen buffers
  79
  80     // saved state
  81     nsRefPtr<gfxQuartzSurface> mQuartzSurface;
  82     CGContextRef mCGContext;
  83 };
  84
  85 #endif