content/browser/renderer_host/begin_frame_observer_proxy.h

   1 // Copyright 2015 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 CONTENT_BROWSER_RENDERER_HOST_BEGIN_FRAME_OBSERVER_PROXY_H_
   6 #define CONTENT_BROWSER_RENDERER_HOST_BEGIN_FRAME_OBSERVER_PROXY_H_
   7
   8 #include "content/common/content_export.h"
   9 #include "ui/compositor/compositor.h"
  10 #include "ui/compositor/compositor_observer.h"
  11
  12 namespace cc {
  13 struct BeginFrameArgs;
  14 }
  15
  16 namespace content {
  17
  18 // This is the interface from the BeginFrameObserverProxy which manages sending
  19 // BeginFrame messages.
  20 class BeginFrameObserverProxyClient {
  21  public:
  22   virtual void SendBeginFrame(const cc::BeginFrameArgs& args) = 0;
  23 };
  24
  25 // This class is used to manage all of the RenderWidgetHostView state and
  26 // functionality that is associated with BeginFrame message handling.
  27 class CONTENT_EXPORT BeginFrameObserverProxy
  28     : public ui::CompositorBeginFrameObserver,
  29       public ui::CompositorObserver {
  30  public:
  31   explicit BeginFrameObserverProxy(BeginFrameObserverProxyClient* client);
  32   ~BeginFrameObserverProxy() override;
  33
  34   void SetNeedsBeginFrames(bool needs_begin_frames);
  35
  36   void SetCompositor(ui::Compositor* compositor);
  37   void ResetCompositor();
  38
  39   // Overridden from ui::CompositorBeginFrameObserver:
  40   void OnSendBeginFrame(const cc::BeginFrameArgs& args) override;
  41
  42   // Overridden from ui::CompositorObserver:
  43   // TODO(simonhong): Stop overriding ui::CompositorObserver. We need to make
  44   // sure that this class should be destroyed before ui::Compositor.
  45   void OnCompositingDidCommit(ui::Compositor* compositor) override {}
  46   void OnCompositingStarted(ui::Compositor* compositor,
  47                             base::TimeTicks start_time) override {}
  48   void OnCompositingEnded(ui::Compositor* compositor) override {}
  49   void OnCompositingAborted(ui::Compositor* compositor) override {}
  50   void OnCompositingLockStateChanged(ui::Compositor* compositor) override {}
  51   void OnCompositingShuttingDown(ui::Compositor* compositor) override;
  52
  53  private:
  54   void StartObservingBeginFrames();
  55   void StopObservingBeginFrames();
  56
  57   // True when RenderWidget needs a BeginFrame message.
  58   bool needs_begin_frames_;
  59
  60   // Used whether to send begin frame to client or not. When |args| from
  61   // Compositor is different from this, send to client.
  62   cc::BeginFrameArgs last_sent_begin_frame_args_;
  63
  64   BeginFrameObserverProxyClient* client_;
  65   ui::Compositor* compositor_;
  66
  67   DISALLOW_COPY_AND_ASSIGN(BeginFrameObserverProxy);
  68 };
  69
  70 }  // namespace content
  71
  72 #endif  // CONTENT_BROWSER_RENDERER_HOST_BEGIN_FRAME_OBSERVER_PROXY_H_