src/third_party/WebKit/public/platform/WebLayerTreeView.h

   1 /*
   2  * Copyright (C) 2011 Google 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  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef WebLayerTreeView_h
  27 #define WebLayerTreeView_h
  28
  29 #include "WebColor.h"
  30 #include "WebCommon.h"
  31 #include "WebFloatPoint.h"
  32 #include "WebNonCopyable.h"
  33 #include "WebPrivateOwnPtr.h"
  34 #include "WebSize.h"
  35
  36 class SkBitmap;
  37
  38 namespace blink {
  39 class WebCompositeAndReadbackAsyncCallback;
  40 class WebGraphicsContext3D;
  41 class WebLayer;
  42 struct WebPoint;
  43 struct WebRect;
  44 struct WebRenderingStats;
  45
  46 class WebLayerTreeView {
  47 public:
  48     virtual ~WebLayerTreeView() { }
  49
  50     // Initialization and lifecycle --------------------------------------
  51
  52     // Indicates that the compositing surface used by this WebLayerTreeView is ready to use.
  53     // A WebLayerTreeView may request a context from its client before the surface is ready,
  54     // but it won't attempt to use it.
  55     virtual void setSurfaceReady() = 0;
  56
  57     // Sets the root of the tree. The root is set by way of the constructor.
  58     virtual void setRootLayer(const WebLayer&) = 0;
  59     virtual void clearRootLayer() = 0;
  60
  61
  62     // View properties ---------------------------------------------------
  63
  64     virtual void setViewportSize(const WebSize& layoutViewportSize, const WebSize& deviceViewportSize) = 0;
  65     // Gives the viewport size in layer space.
  66     virtual WebSize layoutViewportSize() const = 0;
  67     // Gives the viewport size in physical device pixels (may be different
  68     // from the above if there exists page scale, device scale or fixed layout
  69     // mode).
  70     virtual WebSize deviceViewportSize() const = 0;
  71
  72     virtual void setDeviceScaleFactor(float) = 0;
  73     virtual float deviceScaleFactor() const = 0;
  74
  75     // Sets the background color for the viewport.
  76     virtual void setBackgroundColor(WebColor) = 0;
  77
  78     // Sets the background transparency for the viewport. The default is 'false'.
  79     virtual void setHasTransparentBackground(bool) = 0;
  80
  81     // Sets the overhang gutter bitmap.
  82     virtual void setOverhangBitmap(const SkBitmap&) { }
  83
  84     // Sets whether this view is visible. In threaded mode, a view that is not visible will not
  85     // composite or trigger updateAnimations() or layout() calls until it becomes visible.
  86     virtual void setVisible(bool) = 0;
  87
  88     // Sets the current page scale factor and minimum / maximum limits. Both limits are initially 1 (no page scale allowed).
  89     virtual void setPageScaleFactorAndLimits(float pageScaleFactor, float minimum, float maximum) = 0;
  90
  91     // Starts an animation of the page scale to a target scale factor and scroll offset.
  92     // If useAnchor is true, destination is a point on the screen that will remain fixed for the duration of the animation.
  93     // If useAnchor is false, destination is the final top-left scroll position.
  94     virtual void startPageScaleAnimation(const WebPoint& destination, bool useAnchor, float newPageScale, double durationSec) = 0;
  95
  96     virtual void heuristicsForGpuRasterizationUpdated(bool) { }
  97
  98
  99     // Flow control and scheduling ---------------------------------------
 100
 101     // Indicates that an animation needs to be updated.
 102     virtual void setNeedsAnimate() = 0;
 103
 104     // Indicates whether a commit is pending.
 105     virtual bool commitRequested() const = 0;
 106
 107     // Relays the end of a fling animation.
 108     virtual void didStopFlinging() { }
 109
 110     // Composites and attempts to read back the result into the provided
 111     // buffer. If it wasn't possible, e.g. due to context lost, will return
 112     // false. Pixel format is 32bit (RGBA), and the provided buffer must be
 113     // large enough contain viewportSize().width() * viewportSize().height()
 114     // pixels. The WebLayerTreeView does not assume ownership of the buffer.
 115     // The buffer is not modified if the false is returned.
 116     virtual bool compositeAndReadback(void *pixels, const WebRect&) = 0;
 117
 118     // The caller is responsible for keeping the WebCompositeAndReadbackAsyncCallback
 119     // object alive until it is called.
 120     virtual void compositeAndReadbackAsync(WebCompositeAndReadbackAsyncCallback*) { }
 121
 122     // Blocks until the most recently composited frame has finished rendering on the GPU.
 123     // This can have a significant performance impact and should be used with care.
 124     virtual void finishAllRendering() = 0;
 125
 126     // Prevents updates to layer tree from becoming visible.
 127     virtual void setDeferCommits(bool deferCommits) { }
 128
 129     // Take responsiblity for this layer's animations, even if this layer hasn't yet
 130     // been added to the tree.
 131     virtual void registerForAnimations(WebLayer* layer) { }
 132
 133     // Identify key layers to the compositor when using the pinch virtual viewport.
 134     virtual void registerViewportLayers(
 135         const WebLayer* pageScaleLayerLayer,
 136         const WebLayer* innerViewportScrollLayer,
 137         const WebLayer* outerViewportScrollLayer) { }
 138     virtual void clearViewportLayers() { }
 139
 140     // Debugging / dangerous ---------------------------------------------
 141
 142     // Toggles the FPS counter in the HUD layer
 143     virtual void setShowFPSCounter(bool) { }
 144
 145     // Toggles the paint rects in the HUD layer
 146     virtual void setShowPaintRects(bool) { }
 147
 148     // Toggles the debug borders on layers
 149     virtual void setShowDebugBorders(bool) { }
 150
 151     // Toggles continuous painting
 152     virtual void setContinuousPaintingEnabled(bool) { }
 153
 154     // Toggles scroll bottleneck rects on the HUD layer
 155     virtual void setShowScrollBottleneckRects(bool) { }
 156 };
 157
 158 } // namespace blink
 159
 160 #endif // WebLayerTreeView_h