cc/layers/recording_source.h

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

#ifndef CC_LAYERS_RECORDING_SOURCE_H_
#define CC_LAYERS_RECORDING_SOURCE_H_

#include <optional>

#include "base/memory/scoped_refptr.h"
#include "cc/base/invalidation_region.h"
#include "cc/cc_export.h"
#include "cc/paint/directly_composited_image_info.h"
#include "third_party/skia/include/core/SkColor.h"
#include "ui/gfx/geometry/rect.h"
#include "ui/gfx/geometry/size.h"

namespace cc {

class ContentLayerClient;
class DisplayItemList;
class RasterSource;
class Region;

class CC_EXPORT RecordingSource {
 public:
  RecordingSource();
  RecordingSource(const RecordingSource&) = delete;
  ~RecordingSource();

  RecordingSource& operator=(const RecordingSource&) = delete;

  bool Update(const gfx::Size& layer_size,
              float recording_scale_factor,
              ContentLayerClient& content_layer_client,
              Region& invalidation);
  gfx::Size size() const { return size_; }
  const DisplayItemList* display_list() const { return display_list_.get(); }
  void SetEmptyBounds();
  void SetSlowdownRasterScaleFactor(int factor);
  void SetBackgroundColor(SkColor4f background_color);
  void SetRequiresClear(bool requires_clear);
  void SetCanUseRecordedBounds(bool can_use_recorded_bounds);

  void SetNeedsDisplayRect(const gfx::Rect& layer_rect);

  // Forces an update even without invalidation.
  void set_force_update() { force_update_ = true; }

  scoped_refptr<RasterSource> CreateRasterSource() const;

  const gfx::Rect& recorded_bounds() const { return recorded_bounds_; }
  bool is_solid_color() const { return is_solid_color_; }

  const std::optional<DirectlyCompositedImageInfo>&
  directly_composited_image_info() const {
    return directly_composited_image_info_;
  }

 protected:
  gfx::Rect recorded_bounds_;
  gfx::Size size_;
  int slow_down_raster_scale_factor_for_debug_ = 0;
  bool requires_clear_ = false;
  bool is_solid_color_ = false;
  bool can_use_recorded_bounds_ = false;
  bool force_update_ = false;
  SkColor4f solid_color_ = SkColors::kTransparent;
  SkColor4f background_color_ = SkColors::kTransparent;
  scoped_refptr<DisplayItemList> display_list_;
  float recording_scale_factor_ = 1.0f;
  std::optional<DirectlyCompositedImageInfo> directly_composited_image_info_;

 private:
  void UpdateInvalidationForRecordedBounds(const gfx::Rect& old_recorded_bounds,
                                           const gfx::Rect& new_recorded_bounds,
                                           Region& invalidation);
  void FinishDisplayItemListUpdate();

  friend class RasterSource;

  void DetermineIfSolidColor();

  InvalidationRegion invalidation_;
};

}  // namespace cc

#endif  // CC_LAYERS_RECORDING_SOURCE_H_