src/third_party/WebKit/public/platform/WebExternalTextureLayer.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 WebExternalTextureLayer_h
  27 #define WebExternalTextureLayer_h
  28
  29 #include "WebCommon.h"
  30 #include "WebFloatRect.h"
  31 #include "WebLayer.h"
  32
  33 namespace blink {
  34
  35 class WebExternalTextureLayerClient;
  36
  37 // This class represents a layer that renders a texture that is generated
  38 // externally (not managed by the WebLayerTreeView).
  39 // The texture will be used by the WebLayerTreeView during compositing passes.
  40 // When in single-thread mode, this means during WebLayerTreeView::composite().
  41 // When using the threaded compositor, this can mean at an arbitrary time until
  42 // the WebLayerTreeView is destroyed.
  43 class WebExternalTextureLayer {
  44 public:
  45     virtual ~WebExternalTextureLayer() { }
  46
  47     virtual WebLayer* layer() = 0;
  48
  49     // Clears texture from the layer.
  50     virtual void clearTexture() = 0;
  51
  52     // Sets whether every pixel in this layer is opaque. Defaults to false.
  53     virtual void setOpaque(bool) = 0;
  54
  55     // Sets whether this layer's texture has premultiplied alpha or not. Defaults to true.
  56     virtual void setPremultipliedAlpha(bool) = 0;
  57
  58     // Sets whether the texture should be blended with the background color
  59     // at draw time. Defaults to false.
  60     virtual void setBlendBackgroundColor(bool) = 0;
  61
  62     // Sets whether this context should be rate limited by the compositor. Rate limiting works by blocking
  63     // invalidate() and invalidateRect() calls if the compositor is too many frames behind.
  64     virtual void setRateLimitContext(bool) = 0;
  65 };
  66
  67 } // namespace blink
  68
  69 #endif // WebExternalTextureLayer_h