third_party/WebKit/Source/platform/graphics/paint/DrawingDisplayItem.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 DrawingDisplayItem_h
#define DrawingDisplayItem_h

#include "base/compiler_specific.h"
#include "platform/PlatformExport.h"
#include "platform/RuntimeEnabledFeatures.h"
#include "platform/geometry/FloatRect.h"
#include "platform/graphics/paint/DisplayItem.h"
#include "platform/graphics/paint/PaintRecord.h"
#include "third_party/skia/include/core/SkRefCnt.h"

namespace blink {

// DrawingDisplayItem contains recorded painting operations which can be
// replayed to produce a rastered output.
//
// This class has two notions of the bounds around the content that was recorded
// and will be produced by the item. The first is the |record_bounds| which
// describes the bounds of all content in the |record| in the space of the
// record. The second is the |visual_rect| which should describe the same thing,
// but takes into account transforms and clips that would apply to the
// PaintRecord, and is in the space of the DisplayItemList. This allows the
// visual_rect to be compared between DrawingDisplayItems, and to give bounds
// around what the user can actually see from the PaintRecord.
class PLATFORM_EXPORT DrawingDisplayItem final : public DisplayItem {
 public:
  DISABLE_CFI_PERF
  DrawingDisplayItem(const DisplayItemClient& client,
                     Type type,
                     sk_sp<const PaintRecord> record,
                     const FloatRect& record_bounds,
                     bool known_to_be_opaque = false)
      : DisplayItem(client, type, sizeof(*this)),
        record_(record && record->size() ? std::move(record) : nullptr),
        record_bounds_(record_bounds),
        known_to_be_opaque_(known_to_be_opaque) {
    DCHECK(IsDrawingType(type));
  }

  void Replay(GraphicsContext&) const override;
  void AppendToWebDisplayItemList(const IntRect& visual_rect,
                                  WebDisplayItemList*) const override;
  bool DrawsContent() const override;

  const sk_sp<const PaintRecord>& GetPaintRecord() const { return record_; }
  // This rect is described in the coordinate space relative to the PaintRecord
  // whose bounds it describes.
  FloatRect GetPaintRecordBounds() const { return record_bounds_; }

  bool KnownToBeOpaque() const {
    DCHECK(RuntimeEnabledFeatures::slimmingPaintV2Enabled());
    return known_to_be_opaque_;
  }

  int NumberOfSlowPaths() const override;

 private:
#ifndef NDEBUG
  void DumpPropertiesAsDebugString(WTF::StringBuilder&) const override;
#endif
  bool Equals(const DisplayItem& other) const final;

  sk_sp<const PaintRecord> record_;
  FloatRect record_bounds_;

  // True if there are no transparent areas. Only used for SlimmingPaintV2.
  const bool known_to_be_opaque_;
};

}  // namespace blink

#endif  // DrawingDisplayItem_h