src/third_party/WebKit/public/platform/WebContentLayerClient.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 WebContentLayerClient_h
  27 #define WebContentLayerClient_h
  28
  29 #include "WebCanvas.h"
  30 #include "WebCommon.h"
  31
  32 namespace blink {
  33 struct WebRect;
  34 struct WebFloatRect;
  35
  36 class BLINK_PLATFORM_EXPORT WebContentLayerClient {
  37 public:
  38     enum GraphicsContextStatus { GraphicsContextEnabled, GraphicsContextDisabled };
  39
  40     // Paints the content area for the layer, typically dirty rects submitted
  41     // through WebContentLayer::setNeedsDisplay, submitting drawing commands
  42     // through the WebCanvas.
  43     // The canvas is already clipped to the |clip| rect.
  44     // Optionally, the implementation may set |opaque| to a rect covering pixels that
  45     // the implementation knows are opaque. This information can be used for various
  46     // optimizations.
  47     // The |disableContext| enum controls most processing in
  48     // GraphicsContext to isolate the painting code in performance tests.
  49     virtual void paintContents(WebCanvas*, const WebRect& clip, bool canPaintLCDText, WebFloatRect& opaque, GraphicsContextStatus = GraphicsContextEnabled) = 0;
  50
  51 protected:
  52     virtual ~WebContentLayerClient() { }
  53 };
  54
  55 } // namespace blink
  56
  57 #endif // WebContentLayerClient_h