Home | History | Annotate | Download | only in platform 
      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 WebGraphicsContext3D;
     40 class WebLayer;
     41 struct WebPoint;
     42 struct WebRect;
     43 struct WebRenderingStats;
     44 
     45 class WebLayerTreeView {
     46 public:
     47     virtual ~WebLayerTreeView() { }
     48 
     49     // Initialization and lifecycle --------------------------------------
     50 
     51     // Indicates that the compositing surface used by this WebLayerTreeView is ready to use.
     52     // A WebLayerTreeView may request a context from its client before the surface is ready,
     53     // but it won't attempt to use it.
     54     virtual void setSurfaceReady() = 0;
     55 
     56     // Sets the root of the tree. The root is set by way of the constructor.
     57     virtual void setRootLayer(const WebLayer&) = 0;
     58     virtual void clearRootLayer() = 0;
     59 
     60 
     61     // View properties ---------------------------------------------------
     62 
     63     virtual void setViewportSize(const WebSize& layoutViewportSize, const WebSize& deviceViewportSize) = 0;
     64     // Gives the viewport size in layer space.
     65     virtual WebSize layoutViewportSize() const = 0;
     66     // Gives the viewport size in physical device pixels (may be different
     67     // from the above if there exists page scale, device scale or fixed layout
     68     // mode).
     69     virtual WebSize deviceViewportSize() const = 0;
     70 
     71     virtual void setDeviceScaleFactor(float) = 0;
     72     virtual float deviceScaleFactor() const = 0;
     73 
     74     // Sets the background color for the viewport.
     75     virtual void setBackgroundColor(WebColor) = 0;
     76 
     77     // Sets the background transparency for the viewport. The default is 'false'.
     78     virtual void setHasTransparentBackground(bool) = 0;
     79 
     80     // Sets the overhang gutter bitmap.
     81     virtual void setOverhangBitmap(const SkBitmap&) { }
     82 
     83     // Sets whether this view is visible. In threaded mode, a view that is not visible will not
     84     // composite or trigger updateAnimations() or layout() calls until it becomes visible.
     85     virtual void setVisible(bool) = 0;
     86 
     87     // Sets the current page scale factor and minimum / maximum limits. Both limits are initially 1 (no page scale allowed).
     88     virtual void setPageScaleFactorAndLimits(float pageScaleFactor, float minimum, float maximum) = 0;
     89 
     90     // Starts an animation of the page scale to a target scale factor and scroll offset.
     91     // If useAnchor is true, destination is a point on the screen that will remain fixed for the duration of the animation.
     92     // If useAnchor is false, destination is the final top-left scroll position.
     93     virtual void startPageScaleAnimation(const WebPoint& destination, bool useAnchor, float newPageScale, double durationSec) = 0;
     94 
     95 
     96     // Flow control and scheduling ---------------------------------------
     97 
     98     // Indicates that an animation needs to be updated.
     99     virtual void setNeedsAnimate() = 0;
    100 
    101     // Indicates whether a commit is pending.
    102     virtual bool commitRequested() const = 0;
    103 
    104     // Relays the end of a fling animation.
    105     virtual void didStopFlinging() { }
    106 
    107     // Composites and attempts to read back the result into the provided
    108     // buffer. If it wasn't possible, e.g. due to context lost, will return
    109     // false. Pixel format is 32bit (RGBA), and the provided buffer must be
    110     // large enough contain viewportSize().width() * viewportSize().height()
    111     // pixels. The WebLayerTreeView does not assume ownership of the buffer.
    112     // The buffer is not modified if the false is returned.
    113     virtual bool compositeAndReadback(void *pixels, const WebRect&) = 0;
    114 
    115     // Blocks until the most recently composited frame has finished rendering on the GPU.
    116     // This can have a significant performance impact and should be used with care.
    117     virtual void finishAllRendering() = 0;
    118 
    119     // Prevents updates to layer tree from becoming visible.
    120     virtual void setDeferCommits(bool deferCommits) { }
    121 
    122     // Take responsiblity for this layer's animations, even if this layer hasn't yet
    123     // been added to the tree.
    124     virtual void registerForAnimations(WebLayer* layer) { }
    125 
    126     // Identify key layers to the compositor when using the pinch virtual viewport.
    127     virtual void registerViewportLayers(
    128         const WebLayer* pageScaleLayerLayer,
    129         const WebLayer* innerViewportScrollLayer,
    130         const WebLayer* outerViewportScrollLayer) { }
    131     virtual void clearViewportLayers() { }
    132 
    133     // Debugging / dangerous ---------------------------------------------
    134 
    135     // Toggles the FPS counter in the HUD layer
    136     virtual void setShowFPSCounter(bool) { }
    137 
    138     // Toggles the paint rects in the HUD layer
    139     virtual void setShowPaintRects(bool) { }
    140 
    141     // Toggles the debug borders on layers
    142     virtual void setShowDebugBorders(bool) { }
    143 
    144     // Toggles continuous painting
    145     virtual void setContinuousPaintingEnabled(bool) { }
    146 
    147     // Toggles scroll bottleneck rects on the HUD layer
    148     virtual void setShowScrollBottleneckRects(bool) { }
    149 };
    150 
    151 } // namespace blink
    152 
    153 #endif // WebLayerTreeView_h
    154