cc/raster/tile_task.h

// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CC_RASTER_TILE_TASK_H_
#define CC_RASTER_TILE_TASK_H_

#include <vector>

#include "cc/raster/task.h"

namespace cc {

class CC_EXPORT TileTask : public Task {
 public:
  typedef std::vector<scoped_refptr<TileTask>> Vector;

  const TileTask::Vector& dependencies() const { return dependencies_; }

  // Indicates whether this TileTask can be run at the same time as other tasks
  // in the task graph. If false, this task will be scheduled with
  // TASK_CATEGORY_NONCONCURRENT_FOREGROUND. See comments in task_category.h.
  bool supports_concurrent_execution() const {
    return supports_concurrent_execution_ == SupportsConcurrentExecution::kYes;
  }

  // Indicates whether this TileTask can run at background thread priority. See
  // comments in task_category.h.
  bool supports_background_thread_priority() const {
    return supports_background_thread_priority_ ==
           SupportsBackgroundThreadPriority::kYes;
  }

  // This function should be called from origin thread to process the completion
  // of the task.
  virtual void OnTaskCompleted() = 0;

  void DidComplete();
  bool HasCompleted() const;

 protected:
  enum class SupportsConcurrentExecution { kYes, kNo };
  enum class SupportsBackgroundThreadPriority { kYes, kNo };

  TileTask(SupportsConcurrentExecution supports_concurrent_execution,
           SupportsBackgroundThreadPriority supports_background_thread_priority,
           TileTask::Vector* dependencies = nullptr);
  ~TileTask() override;

  const SupportsConcurrentExecution supports_concurrent_execution_;
  const SupportsBackgroundThreadPriority supports_background_thread_priority_;
  TileTask::Vector dependencies_;
  bool did_complete_;
};

}  // namespace cc

#endif  // CC_RASTER_TILE_TASK_H_