Home | History | Annotate | Download | only in graphics 
      1 /*
      2  * Copyright (C) 2009 Apple Inc. All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions
      6  * are met:
      7  * 1. Redistributions of source code must retain the above copyright
      8  *    notice, this list of conditions and the following disclaimer.
      9  * 2. Redistributions in binary form must reproduce the above copyright
     10  *    notice, this list of conditions and the following disclaimer in the
     11  *    documentation and/or other materials provided with the distribution.
     12  *
     13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
     14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
     17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
     20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
     21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     24  */
     25 
     26 #ifndef GraphicsLayerClient_h
     27 #define GraphicsLayerClient_h
     28 
     29 #include "platform/PlatformExport.h"
     30 #include "wtf/text/WTFString.h"
     31 
     32 namespace WebCore {
     33 
     34 class FloatPoint;
     35 class GraphicsContext;
     36 class GraphicsLayer;
     37 class IntPoint;
     38 class IntRect;
     39 class TransformationMatrix;
     40 
     41 enum GraphicsLayerPaintingPhaseFlags {
     42     GraphicsLayerPaintBackground = (1 << 0),
     43     GraphicsLayerPaintForeground = (1 << 1),
     44     GraphicsLayerPaintMask = (1 << 2),
     45     GraphicsLayerPaintOverflowContents = (1 << 3),
     46     GraphicsLayerPaintCompositedScroll = (1 << 4),
     47     GraphicsLayerPaintChildClippingMask = (1 << 5),
     48     GraphicsLayerPaintAllWithOverflowClip = (GraphicsLayerPaintBackground | GraphicsLayerPaintForeground | GraphicsLayerPaintMask)
     49 };
     50 typedef unsigned GraphicsLayerPaintingPhase;
     51 
     52 enum {
     53     LayerTreeNormal = 0,
     54     LayerTreeIncludesDebugInfo = 1 << 0, // Dump extra debugging info like layer addresses.
     55     LayerTreeIncludesRepaintRects = 1 << 1,
     56     LayerTreeIncludesPaintingPhases = 1 << 2,
     57     LayerTreeIncludesRootLayer = 1 << 3,
     58     LayerTreeIncludesClipAndScrollParents = 1 << 4
     59 };
     60 typedef unsigned LayerTreeFlags;
     61 
     62 class PLATFORM_EXPORT GraphicsLayerClient {
     63 public:
     64     virtual ~GraphicsLayerClient() {}
     65 
     66     // Callback for when hardware-accelerated animation started.
     67     virtual void notifyAnimationStarted(const GraphicsLayer*, double wallClockTime, double monotonicTime) = 0;
     68 
     69     virtual void paintContents(const GraphicsLayer*, GraphicsContext&, GraphicsLayerPaintingPhase, const IntRect& inClip) = 0;
     70     virtual void didCommitChangesForLayer(const GraphicsLayer*) const { }
     71 
     72     // Provides current transform (taking transform-origin and animations into account). Input matrix has been
     73     // initialized to identity already. Returns false if the layer has no transform.
     74     virtual bool getCurrentTransform(const GraphicsLayer*, TransformationMatrix&) const { return false; }
     75 
     76     virtual bool isTrackingRepaints() const { return false; }
     77 
     78     virtual String debugName(const GraphicsLayer*) = 0;
     79 
     80 #ifndef NDEBUG
     81     // CompositedLayerMapping overrides this to verify that it is not
     82     // currently painting contents. An ASSERT fails, if it is.
     83     // This is executed in GraphicsLayer construction and destruction
     84     // to verify that we don't create or destroy GraphicsLayers
     85     // while painting.
     86     virtual void verifyNotPainting() { }
     87 #endif
     88 };
     89 
     90 } // namespace WebCore
     91 
     92 #endif // GraphicsLayerClient_h
     93