display_list_deferred_image_gpu_impeller.h

Go to the documentation of this file.

// Copyright 2013 The Flutter 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 FLUTTER_LIB_UI_PAINTING_DISPLAY_LIST_DEFERRED_IMAGE_GPU_IMPELLER_H_
#define FLUTTER_LIB_UI_PAINTING_DISPLAY_LIST_DEFERRED_IMAGE_GPU_IMPELLER_H_
 
#include <variant>
#include "flutter/common/graphics/texture.h"
#include "flutter/display_list/image/dl_image.h"
#include "flutter/flow/layers/layer_tree.h"
#include "flutter/fml/macros.h"
#include "flutter/fml/memory/weak_ptr.h"
#include "flutter/fml/task_runner.h"
#include "flutter/lib/ui/snapshot_delegate.h"
#include "flutter/shell/common/snapshot_pixel_format.h"
#include "impeller/core/texture.h"
 
namespace flutter {
 
namespace testing {
FML_TEST_CLASS(DlDeferredImageGPUImpeller, TrashesDisplayList);
}  // namespace testing
 
class DlDeferredImageGPUImpeller final : public DlImage {
 public:
  static sk_sp<DlDeferredImageGPUImpeller> Make(
      std::unique_ptr<LayerTree> layer_tree,
      fml::TaskRunnerAffineWeakPtr<SnapshotDelegate> snapshot_delegate,
      fml::RefPtr<fml::TaskRunner> raster_task_runner);
 
  static sk_sp<DlDeferredImageGPUImpeller> Make(
      sk_sp<DisplayList> display_list,
      const DlISize& size,
      SnapshotPixelFormat pixel_format,
      fml::TaskRunnerAffineWeakPtr<SnapshotDelegate> snapshot_delegate,
      fml::RefPtr<fml::TaskRunner> raster_task_runner);
 
  // |DlImage|
  ~DlDeferredImageGPUImpeller() override;
 
  // |DlImage|
  sk_sp<SkImage> skia_image() const override;
 
  // |DlImage|
  std::shared_ptr<impeller::Texture> impeller_texture() const override;
 
  // |DlImage|
  bool isOpaque() const override;
 
  // |DlImage|
  bool isTextureBacked() const override;
 
  // |DlImage|
  bool isUIThreadSafe() const override;
 
  // |DlImage|
  DlISize GetSize() const override;
 
  // |DlImage|
  size_t GetApproximateByteSize() const override;
 
  // |DlImage|
  OwningContext owning_context() const override {
    return OwningContext::kRaster;
  }
 
 private:
  FML_FRIEND_TEST(testing::DlDeferredImageGPUImpeller, TrashesDisplayList);
 
  class ImageWrapper final : public std::enable_shared_from_this<ImageWrapper>,
                             public ContextListener {
   public:
    ~ImageWrapper();
 
    static std::shared_ptr<ImageWrapper> Make(
        sk_sp<DisplayList> display_list,
        const DlISize& size,
        SnapshotPixelFormat pixel_format,
        fml::TaskRunnerAffineWeakPtr<SnapshotDelegate> snapshot_delegate,
        fml::RefPtr<fml::TaskRunner> raster_task_runner);
 
    static std::shared_ptr<ImageWrapper> Make(
        std::unique_ptr<LayerTree> layer_tree,
        fml::TaskRunnerAffineWeakPtr<SnapshotDelegate> snapshot_delegate,
        fml::RefPtr<fml::TaskRunner> raster_task_runner);
 
    bool isTextureBacked() const;
 
    const std::shared_ptr<impeller::Texture> texture() const {
      FML_DCHECK(raster_task_runner_->RunsTasksOnCurrentThread());
      return texture_;
    }
 
    const DlISize size() const { return size_; }
 
    std::optional<std::string> get_error();
 
   private:
    FML_FRIEND_TEST(testing::DlDeferredImageGPUImpeller, TrashesDisplayList);
    DlISize size_;
    SnapshotPixelFormat pixel_format_;
    std::shared_ptr<impeller::Texture> texture_;
    fml::TaskRunnerAffineWeakPtr<SnapshotDelegate> snapshot_delegate_;
    fml::RefPtr<fml::TaskRunner> raster_task_runner_;
 
    mutable std::mutex error_mutex_;
    std::optional<std::string> error_;
 
    ImageWrapper(
        const DlISize& size,
        SnapshotPixelFormat pixel_format,
        fml::TaskRunnerAffineWeakPtr<SnapshotDelegate> snapshot_delegate,
        fml::RefPtr<fml::TaskRunner> raster_task_runner);
 
    // If a layer tree is provided, it will be flattened into a display list
    // during the raster thread task spawned by this method.
    void SnapshotDisplayList(
        std::variant<sk_sp<DisplayList>, std::unique_ptr<LayerTree>> content);
 
    // |ContextListener|
    void OnGrContextCreated() override;
 
    // |ContextListener|
    void OnGrContextDestroyed() override;
 
    FML_DISALLOW_COPY_AND_ASSIGN(ImageWrapper);
  };
 
  const std::shared_ptr<ImageWrapper> wrapper_;
 
  explicit DlDeferredImageGPUImpeller(std::shared_ptr<ImageWrapper> wrapper);
 
  FML_DISALLOW_COPY_AND_ASSIGN(DlDeferredImageGPUImpeller);
};
 
}  // namespace flutter
 
#endif  // FLUTTER_LIB_UI_PAINTING_DISPLAY_LIST_DEFERRED_IMAGE_GPU_IMPELLER_H_