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 namespace WebCore {
     30 
     31 class FloatPoint;
     32 class GraphicsContext;
     33 class GraphicsLayer;
     34 class IntPoint;
     35 class IntRect;
     36 class TransformationMatrix;
     37 
     38 enum GraphicsLayerPaintingPhaseFlags {
     39     GraphicsLayerPaintBackground = (1 << 0),
     40     GraphicsLayerPaintForeground = (1 << 1),
     41     GraphicsLayerPaintMask = (1 << 2),
     42     GraphicsLayerPaintOverflowContents = (1 << 3),
     43     GraphicsLayerPaintCompositedScroll = (1 << 4),
     44     GraphicsLayerPaintAllWithOverflowClip = (GraphicsLayerPaintBackground | GraphicsLayerPaintForeground | GraphicsLayerPaintMask)
     45 };
     46 typedef unsigned GraphicsLayerPaintingPhase;
     47 
     48 enum AnimatedPropertyID {
     49     AnimatedPropertyInvalid,
     50     AnimatedPropertyWebkitTransform,
     51     AnimatedPropertyOpacity,
     52     AnimatedPropertyBackgroundColor,
     53     AnimatedPropertyWebkitFilter
     54 };
     55 
     56 enum {
     57     LayerTreeNormal = 0,
     58     LayerTreeIncludesDebugInfo = 1 << 0, // Dump extra debugging info like layer addresses.
     59     LayerTreeIncludesRepaintRects = 1 << 1,
     60     LayerTreeIncludesPaintingPhases = 1 << 2,
     61     LayerTreeIncludesRootLayer = 1 << 3
     62 };
     63 typedef unsigned LayerTreeFlags;
     64 
     65 class GraphicsLayerClient {
     66 public:
     67     virtual ~GraphicsLayerClient() {}
     68 
     69     // Callback for when hardware-accelerated animation started.
     70     virtual void notifyAnimationStarted(const GraphicsLayer*, double time) = 0;
     71 
     72     virtual void paintContents(const GraphicsLayer*, GraphicsContext&, GraphicsLayerPaintingPhase, const IntRect& inClip) = 0;
     73     virtual void didCommitChangesForLayer(const GraphicsLayer*) const { }
     74 
     75     // Provides current transform (taking transform-origin and animations into account). Input matrix has been
     76     // initialized to identity already. Returns false if the layer has no transform.
     77     virtual bool getCurrentTransform(const GraphicsLayer*, TransformationMatrix&) const { return false; }
     78 
     79     virtual bool isTrackingRepaints() const { return false; }
     80 
     81 #ifndef NDEBUG
     82     // RenderLayerBacking overrides this to verify that it is not
     83     // currently painting contents. An ASSERT fails, if it is.
     84     // This is executed in GraphicsLayer construction and destruction
     85     // to verify that we don't create or destroy GraphicsLayers
     86     // while painting.
     87     virtual void verifyNotPainting() { }
     88 #endif
     89 };
     90 
     91 } // namespace WebCore
     92 
     93 #endif // GraphicsLayerClient_h
     94