cc/trees/layer_tree_host_client.h

   1 // Copyright 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CC_TREES_LAYER_TREE_HOST_CLIENT_H_
   6 #define CC_TREES_LAYER_TREE_HOST_CLIENT_H_
   7
   8 #include "base/memory/ref_counted.h"
   9 #include "base/memory/scoped_ptr.h"
  10 #include "base/time/time.h"
  11
  12 namespace gfx {
  13 class Vector2d;
  14 }
  15
  16 namespace cc {
  17 class ContextProvider;
  18 class InputHandlerClient;
  19 class OutputSurface;
  20
  21 class LayerTreeHostClient {
  22  public:
  23   virtual void WillBeginMainFrame(int frame_id) = 0;
  24   // Marks finishing compositing-related tasks on the main thread. In threaded
  25   // mode, this corresponds to DidCommit().
  26   virtual void DidBeginMainFrame() = 0;
  27   virtual void Animate(base::TimeTicks frame_begin_time) = 0;
  28   virtual void Layout() = 0;
  29   virtual void ApplyScrollAndScale(const gfx::Vector2d& scroll_delta,
  30                                    float page_scale) = 0;
  31   // Creates an OutputSurface. If fallback is true, it should attempt to
  32   // create an OutputSurface that is guaranteed to initialize correctly.
  33   virtual scoped_ptr<OutputSurface> CreateOutputSurface(bool fallback) = 0;
  34   virtual void DidInitializeOutputSurface(bool success) = 0;
  35   virtual void WillCommit() = 0;
  36   virtual void DidCommit() = 0;
  37   virtual void DidCommitAndDrawFrame() = 0;
  38   virtual void DidCompleteSwapBuffers() = 0;
  39
  40   // If the client provides an OutputSurface bound to a 3d context for direct
  41   // rendering, this must return a provider that provides contexts usable from
  42   // the same thread as the OutputSurface's context.
  43   virtual scoped_refptr<ContextProvider> OffscreenContextProvider() = 0;
  44
  45   // Requests that the client insert a rate limiting token in the shared main
  46   // thread context's command stream that will block if the context gets too far
  47   // ahead of the compositor's command stream. Only needed if the tree contains
  48   // a TextureLayer that calls SetRateLimitContext(true).
  49   virtual void RateLimitSharedMainThreadContext() {}
  50
  51   // This hook is for testing.
  52   virtual void DidFailToInitializeOutputSurface() {}
  53
  54  protected:
  55   virtual ~LayerTreeHostClient() {}
  56 };
  57
  58 }  // namespace cc
  59
  60 #endif  // CC_TREES_LAYER_TREE_HOST_CLIENT_H_