Source/Platform/chromium/public/WebCompositorSupport.h

   1 /*
   2  * Copyright (C) 2012 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 WebCompositorSupport_h
  27 #define WebCompositorSupport_h
  28
  29 #include "WebAnimation.h"
  30 #include "WebCommon.h"
  31 #include "WebLayerTreeView.h"
  32 #include "WebScrollbarThemePainter.h"
  33
  34 namespace WebKit {
  35
  36 class WebAnimationCurve;
  37 class WebCompositorOutputSurface;
  38 class WebContentLayer;
  39 class WebContentLayerClient;
  40 class WebExternalTextureLayer;
  41 class WebExternalTextureLayerClient;
  42 class WebFloatAnimationCurve;
  43 class WebGraphicsContext3D;
  44 class WebIOSurfaceLayer;
  45 class WebImageLayer;
  46 class WebLayer;
  47 class WebScrollbar;
  48 class WebScrollbarLayer;
  49 class WebScrollbarThemeGeometry;
  50 class WebSolidColorLayer;
  51 class WebThread;
  52 class WebTransformAnimationCurve;
  53 class WebTransformOperations;
  54 class WebVideoFrameProvider;
  55 class WebVideoLayer;
  56
  57 class WebCompositorSupport {
  58 public:
  59     // Initializes the compositor. Threaded compositing is enabled by passing in
  60     // a non-null WebThread. No compositor classes or methods should be used
  61     // prior to calling initialize.
  62     virtual void initialize(WebThread*) { }
  63
  64     // Returns whether the compositor was initialized with threading enabled.
  65     virtual bool isThreadingEnabled() { return false; }
  66
  67     // Shuts down the compositor. This must be called when all compositor data
  68     // types have been deleted. No compositor classes or methods should be used
  69     // after shutdown.
  70     virtual void shutdown() { }
  71
  72     // Creates an output surface for the compositor backed by a 3d context.
  73     virtual WebCompositorOutputSurface* createOutputSurfaceFor3D(WebKit::WebGraphicsContext3D*) { return 0; }
  74
  75     // Creates an output surface for the compositor backed by a software device.
  76     virtual WebCompositorOutputSurface* createOutputSurfaceForSoftware() { return 0; }
  77
  78     // Layers -------------------------------------------------------
  79
  80     virtual WebLayer* createLayer() { return 0; }
  81
  82     virtual WebContentLayer* createContentLayer(WebContentLayerClient*) { return 0; }
  83
  84     virtual WebExternalTextureLayer* createExternalTextureLayer(WebExternalTextureLayerClient* = 0) { return 0; }
  85
  86     virtual WebIOSurfaceLayer* createIOSurfaceLayer() { return 0; }
  87
  88     virtual WebImageLayer* createImageLayer() { return 0; }
  89
  90     virtual WebSolidColorLayer* createSolidColorLayer() { return 0; }
  91
  92     virtual WebVideoLayer* createVideoLayer(WebVideoFrameProvider*) { return 0; }
  93
  94     virtual WebScrollbarLayer* createScrollbarLayer(WebScrollbar*, WebScrollbarThemePainter, WebScrollbarThemeGeometry*) { return 0; }
  95
  96
  97     // Animation ----------------------------------------------------
  98
  99     virtual WebAnimation* createAnimation(const WebAnimationCurve&, WebAnimation::TargetProperty, int animationId = 0) { return 0; }
 100
 101     virtual WebFloatAnimationCurve* createFloatAnimationCurve() { return 0; }
 102
 103     virtual WebTransformAnimationCurve* createTransformAnimationCurve() { return 0; }
 104
 105     virtual WebTransformOperations* createTransformOperations() { return 0; }
 106
 107
 108     // Testing ------------------------------------------------------
 109
 110     // DEPRECATED
 111     // May return 0 if initialization fails.
 112     virtual WebLayerTreeView* createLayerTreeView(WebLayerTreeViewClient*, const WebLayer& root, const WebLayerTreeView::Settings&) { return 0; }
 113
 114 protected:
 115     virtual ~WebCompositorSupport() { }
 116 };
 117
 118 }
 119
 120 #endif // WebCompositorSupport_h