cc/scheduler.h

   1 // Copyright 2011 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_SCHEDULER_H_
   6 #define CC_SCHEDULER_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/memory/scoped_ptr.h"
  10 #include "base/time.h"
  11 #include "cc/cc_export.h"
  12 #include "cc/frame_rate_controller.h"
  13 #include "cc/layer_tree_host.h"
  14 #include "cc/scheduler_state_machine.h"
  15
  16 namespace cc {
  17
  18 class Thread;
  19
  20 struct ScheduledActionDrawAndSwapResult {
  21     ScheduledActionDrawAndSwapResult()
  22             : didDraw(false)
  23             , didSwap(false)
  24     {
  25     }
  26     ScheduledActionDrawAndSwapResult(bool didDraw, bool didSwap)
  27             : didDraw(didDraw)
  28             , didSwap(didSwap)
  29     {
  30     }
  31     bool didDraw;
  32     bool didSwap;
  33 };
  34
  35 class SchedulerClient {
  36 public:
  37     virtual void scheduledActionBeginFrame() = 0;
  38     virtual ScheduledActionDrawAndSwapResult scheduledActionDrawAndSwapIfPossible() = 0;
  39     virtual ScheduledActionDrawAndSwapResult scheduledActionDrawAndSwapForced() = 0;
  40     virtual void scheduledActionCommit() = 0;
  41     virtual void scheduledActionActivatePendingTreeIfNeeded() = 0;
  42     virtual void scheduledActionBeginContextRecreation() = 0;
  43     virtual void scheduledActionAcquireLayerTexturesForMainThread() = 0;
  44     virtual void didAnticipatedDrawTimeChange(base::TimeTicks) = 0;
  45
  46 protected:
  47     virtual ~SchedulerClient() { }
  48 };
  49
  50 class CC_EXPORT Scheduler : FrameRateControllerClient {
  51 public:
  52     static scoped_ptr<Scheduler> create(SchedulerClient* client, scoped_ptr<FrameRateController> frameRateController)
  53     {
  54         return make_scoped_ptr(new Scheduler(client, frameRateController.Pass()));
  55     }
  56
  57     virtual ~Scheduler();
  58
  59     void setCanBeginFrame(bool);
  60
  61     void setVisible(bool);
  62     void setCanDraw(bool);
  63     void setHasPendingTree(bool);
  64
  65     void setNeedsCommit();
  66
  67     // Like setNeedsCommit(), but ensures a commit will definitely happen even if we are not visible.
  68     void setNeedsForcedCommit();
  69
  70     void setNeedsRedraw();
  71
  72     void setMainThreadNeedsLayerTextures();
  73
  74     // Like setNeedsRedraw(), but ensures the draw will definitely happen even if we are not visible.
  75     void setNeedsForcedRedraw();
  76
  77     void beginFrameComplete();
  78     void beginFrameAborted();
  79
  80     void setMaxFramesPending(int);
  81     void setSwapBuffersCompleteSupported(bool);
  82     void didSwapBuffersComplete();
  83
  84     void didLoseOutputSurface();
  85     void didRecreateOutputSurface();
  86
  87     bool commitPending() const { return m_stateMachine.commitPending(); }
  88     bool redrawPending() const { return m_stateMachine.redrawPending(); }
  89
  90     void setTimebaseAndInterval(base::TimeTicks timebase, base::TimeDelta interval);
  91
  92     base::TimeTicks anticipatedDrawTime();
  93
  94     // FrameRateControllerClient implementation
  95     virtual void vsyncTick(bool throttled) OVERRIDE;
  96
  97 private:
  98     Scheduler(SchedulerClient*, scoped_ptr<FrameRateController>);
  99
 100     void processScheduledActions();
 101
 102     SchedulerClient* m_client;
 103     scoped_ptr<FrameRateController> m_frameRateController;
 104     SchedulerStateMachine m_stateMachine;
 105     bool m_insideProcessScheduledActions;
 106
 107     DISALLOW_COPY_AND_ASSIGN(Scheduler);
 108 };
 109
 110 }  // namespace cc
 111
 112 #endif  // CC_SCHEDULER_H_