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 blink {
     33 
     34 class GraphicsContext;
     35 class GraphicsLayer;
     36 class IntRect;
     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     GraphicsLayerPaintChildClippingMask = (1 << 5),
     45     GraphicsLayerPaintAllWithOverflowClip = (GraphicsLayerPaintBackground | GraphicsLayerPaintForeground | GraphicsLayerPaintMask)
     46 };
     47 typedef unsigned GraphicsLayerPaintingPhase;
     48 
     49 enum {
     50     LayerTreeNormal = 0,
     51     LayerTreeIncludesDebugInfo = 1 << 0, // Dump extra debugging info like layer addresses.
     52     LayerTreeIncludesPaintInvalidationRects = 1 << 1,
     53     LayerTreeIncludesPaintingPhases = 1 << 2,
     54     LayerTreeIncludesRootLayer = 1 << 3,
     55     LayerTreeIncludesClipAndScrollParents = 1 << 4
     56 };
     57 typedef unsigned LayerTreeFlags;
     58 
     59 class PLATFORM_EXPORT GraphicsLayerClient {
     60 public:
     61     virtual ~GraphicsLayerClient() {}
     62 
     63     // Callback for when hardware-accelerated animation started.
     64     virtual void notifyAnimationStarted(const GraphicsLayer*, double monotonicTime) = 0;
     65 
     66     virtual void paintContents(const GraphicsLayer*, GraphicsContext&, GraphicsLayerPaintingPhase, const IntRect& inClip) = 0;
     67     virtual bool isTrackingPaintInvalidations() const { return false; }
     68 
     69     virtual String debugName(const GraphicsLayer*) = 0;
     70 
     71 #if ENABLE(ASSERT)
     72     // CompositedLayerMapping overrides this to verify that it is not
     73     // currently painting contents. An ASSERT fails, if it is.
     74     // This is executed in GraphicsLayer construction and destruction
     75     // to verify that we don't create or destroy GraphicsLayers
     76     // while painting.
     77     virtual void verifyNotPainting() { }
     78 #endif
     79 };
     80 
     81 } // namespace blink
     82 
     83 #endif // GraphicsLayerClient_h
     84