Back to index

lightning-sunbird  0.9+nobinonly
nsQDFlushManager.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is supposed to avoid exccessive QuickDraw flushes.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Mark Mentovai <mark@moxienet.com>.
00019  * Portions created by the Initial Developer are Copyright (C) 2005
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsQDFlushManager_h___
00039 #define nsQDFlushManager_h___
00040 
00041 #include "nscore.h"
00042 
00043 #include "nsCOMPtr.h"
00044 #include "nsIQDFlushManager.h"
00045 #include "nsITimer.h"
00046 
00047 #include <Carbon/Carbon.h>
00048 
00049 // The expected use is to replace these calls:
00050 //   ::QDFlushPortBuffer(port, region)
00051 // with these:
00052 //   nsCOMPtr<nsIQDFlushManager> qdFlushManager =
00053 //    do_GetService("@mozilla.org/gfx/qdflushmanager;1");
00054 //   qdFlushManager->FlushPortBuffer(port, region);
00055 // and at port destruction time:
00056 //   qdFlushManager->RemovePort(port)
00057 
00058 class nsQDFlushPort : public nsITimerCallback
00059 {
00060   // nsQDFlushManager is responsible for maintaining the list of port objects.
00061   friend class nsQDFlushManager;
00062 
00063   NS_DECL_ISUPPORTS
00064   NS_DECL_NSITIMERCALLBACK
00065 
00066 protected:
00067                         nsQDFlushPort(CGrafPtr aPort);
00068                         ~nsQDFlushPort();
00069 
00070   void                  Init(CGrafPtr aPort);
00071   void                  Destroy();
00072   void                  FlushPortBuffer(RgnHandle aRegion);
00073   PRInt64               TimeUntilFlush(AbsoluteTime aNow);
00074 
00075   // To use the display's refresh rate as the update Hz, see
00076   // http://developer.apple.com/documentation/Performance/Conceptual/Drawing/Articles/FlushingContent.html .
00077   // Here, use a hard-coded 30 Hz instead.
00078   static const PRUint32 kRefreshRateHz = 30;    // Maximum number of updates
00079                                                 // per second
00080 
00081   nsQDFlushPort*        mNext;                  // Next object in list
00082   CGrafPtr              mPort;                  // Associated port
00083   AbsoluteTime          mLastFlushTime;         // Last QDFlushPortBuffer call
00084   nsCOMPtr<nsITimer>    mFlushTimer;            // Timer for scheduled flush
00085   PRPackedBool          mFlushTimerRunning;     // Is it?
00086 };
00087 
00088 class NS_EXPORT nsQDFlushManager : public nsIQDFlushManager
00089 {
00090   NS_DECL_ISUPPORTS
00091   NS_DECL_NSIQDFLUSHMANAGER
00092 
00093 public:
00094                               nsQDFlushManager();
00095                               ~nsQDFlushManager();
00096 
00097 protected:
00098   nsQDFlushPort*              CreateOrGetPort(CGrafPtr aPort);
00099 
00100   nsQDFlushPort*              mPortList;        // Head of list
00101 };
00102 
00103 // 6F91262A-CF9E-4DDD-AA01-7A1FCCF14281
00104 #define NS_QDFLUSHMANAGER_CLASSNAME "QuickDraw Buffer Flusher"
00105 #define NS_QDFLUSHMANAGER_CID \
00106  {0x6F91262A, 0xCF9E, 0x4DDD, {0xAA, 0x01, 0x7A, 0x1F, 0xCC, 0xF1, 0x42, 0x81}}
00107 #define NS_QDFLUSHMANAGER_CONTRACTID "@mozilla.org/gfx/qdflushmanager;1"
00108 
00109 #endif /* nsQDFlushManager_h___ */