flutter::SnapshotControllerImpeller Class Reference

#include <snapshot_controller_impeller.h>

Inheritance diagram for flutter::SnapshotControllerImpeller:

Public Member Functions
	SnapshotControllerImpeller (const SnapshotController::Delegate &delegate)
void	MakeRasterSnapshot (sk_sp< DisplayList > display_list, DlISize picture_size, std::function< void(const sk_sp< DlImage > &)> callback, SnapshotPixelFormat pixel_format) override
sk_sp< DlImage >	MakeRasterSnapshotSync (sk_sp< DisplayList > display_list, DlISize picture_size, SnapshotPixelFormat pixel_format) override
sk_sp< DlImage >	MakeTextureImage (sk_sp< SkImage > image, SnapshotPixelFormat pixel_format) override
sk_sp< SkImage >	ConvertToRasterImage (sk_sp< SkImage > image) override
void	CacheRuntimeStage (const std::shared_ptr< impeller::RuntimeStage > &runtime_stage) override
virtual bool	MakeRenderContextCurrent () override
Public Member Functions inherited from flutter::SnapshotController
virtual	~SnapshotController ()=default

Additional Inherited Members
Static Public Member Functions inherited from flutter::SnapshotController
static std::unique_ptr< SnapshotController >	Make (const Delegate &delegate, const Settings &settings)
Protected Member Functions inherited from flutter::SnapshotController
	SnapshotController (const Delegate &delegate)
const Delegate &	GetDelegate ()

Detailed Description

Definition at line 13 of file snapshot_controller_impeller.h.

Constructor & Destructor Documentation

SnapshotControllerImpeller()

flutter::SnapshotControllerImpeller::SnapshotControllerImpeller ( const SnapshotController::Delegate &  delegate )

inlineexplicit

Definition at line 15 of file snapshot_controller_impeller.h.

      : SnapshotController(delegate) {}

Member Function Documentation

CacheRuntimeStage()

void flutter::SnapshotControllerImpeller::CacheRuntimeStage ( const std::shared_ptr< impeller::RuntimeStage > &  runtime_stage )

overridevirtual

Implements flutter::SnapshotController.

Definition at line 240 of file snapshot_controller_impeller.cc.

                                                              {
  if (!GetDelegate().IsAiksContextInitialized()) {
    return;
  }
  auto context = GetDelegate().GetAiksContext();
  if (!context) {
    return;
  }
  impeller::RuntimeEffectContents runtime_effect;
  runtime_effect.SetRuntimeStage(runtime_stage);
  runtime_effect.BootstrapShader(context->GetContentContext());
}

References impeller::RuntimeEffectContents::BootstrapShader(), flutter::SnapshotController::Delegate::GetAiksContext(), flutter::SnapshotController::GetDelegate(), and impeller::RuntimeEffectContents::SetRuntimeStage().

ConvertToRasterImage()

sk_sp< SkImage > flutter::SnapshotControllerImpeller::ConvertToRasterImage ( sk_sp< SkImage >  image )

overridevirtual

Implements flutter::SnapshotController.

Definition at line 254 of file snapshot_controller_impeller.cc.

                          {
  FML_UNREACHABLE();
}

References FML_UNREACHABLE.

MakeRasterSnapshot()

void flutter::SnapshotControllerImpeller::MakeRasterSnapshot ( sk_sp< DisplayList >  display_list, DlISize  picture_size, std::function< void(const sk_sp< DlImage > &)>  callback, SnapshotPixelFormat  pixel_format  )

overridevirtual

Implements flutter::SnapshotController.

Definition at line 117 of file snapshot_controller_impeller.cc.

                                      {
  std::shared_ptr<const fml::SyncSwitch> sync_switch =
      GetDelegate().GetIsGpuDisabledSyncSwitch();
  sync_switch->Execute(
      fml::SyncSwitch::Handlers()
          .SetIfTrue([&] {
            std::shared_ptr<impeller::AiksContext> context =
                GetDelegate().GetAiksContext();
            if (context) {
              context->GetContext()->StoreTaskForGPU(
                  [context, sync_switch, display_list = std::move(display_list),
                   picture_size, callback, pixel_format] {
                    callback(DoMakeRasterSnapshot(display_list, picture_size,
                                                  sync_switch, context,
                                                  pixel_format));
                  },
                  [callback]() { callback(nullptr); });
            } else {
#if FML_OS_IOS_SIMULATOR
              callback(impeller::DlImageImpeller::Make(
                  nullptr, DlImage::OwningContext::kRaster,
                  /*is_fake_image=*/true));
#else
              callback(nullptr);
 
#endif  // FML_OS_IOS_SIMULATOR
            }
          })
          .SetIfFalse([&] {
#if FML_OS_IOS_SIMULATOR
            if (!GetDelegate().GetAiksContext()) {
              callback(impeller::DlImageImpeller::Make(
                  nullptr, DlImage::OwningContext::kRaster,
                  /*is_fake_image=*/true));
              return;
            }
#endif
            callback(DoMakeRasterSnapshot(display_list, picture_size,
                                          GetDelegate(), pixel_format));
          }));
}

References callback, flutter::SnapshotController::Delegate::GetAiksContext(), flutter::SnapshotController::GetDelegate(), flutter::SnapshotController::Delegate::GetIsGpuDisabledSyncSwitch(), flutter::DlImage::kRaster, and impeller::DlImageImpeller::Make().

MakeRasterSnapshotSync()

sk_sp< DlImage > flutter::SnapshotControllerImpeller::MakeRasterSnapshotSync ( sk_sp< DisplayList >  display_list, DlISize  picture_size, SnapshotPixelFormat  pixel_format  )

overridevirtual

Implements flutter::SnapshotController.

Definition at line 163 of file snapshot_controller_impeller.cc.

                                      {
  return DoMakeRasterSnapshot(display_list, picture_size, GetDelegate(),
                              pixel_format);
}

References flutter::SnapshotController::GetDelegate().

MakeRenderContextCurrent()

bool flutter::SnapshotControllerImpeller::MakeRenderContextCurrent ( )

overridevirtual

Implements flutter::SnapshotController.

Definition at line 259 of file snapshot_controller_impeller.cc.

                                                          {
  const std::unique_ptr<Surface>& surface = GetDelegate().GetSurface();
  if (!surface) {
    // Some backends (such as Metal) can operate without a surface and do not
    // require MakeRenderContextCurrent.
    return true;
  }
  return surface->MakeRenderContextCurrent()->GetResult();
}

References flutter::SnapshotController::GetDelegate(), flutter::SnapshotController::Delegate::GetSurface(), and surface.

MakeTextureImage()

sk_sp< DlImage > flutter::SnapshotControllerImpeller::MakeTextureImage ( sk_sp< SkImage >  image, SnapshotPixelFormat  pixel_format  )

overridevirtual

Creates a texture-backed DlImage from the provided SkImage.

This is primarily used by decodeImageFromPixelsSync to upload pixels to the GPU synchronously.

Implements flutter::SnapshotController.

Definition at line 171 of file snapshot_controller_impeller.cc.

                                      {
  auto aiks_context = GetDelegate().GetAiksContext();
  if (!aiks_context) {
    return nullptr;
  }
  auto context = aiks_context->GetContext();
  if (!context) {
    return nullptr;
  }
 
  impeller::TextureDescriptor desc;
  desc.storage_mode = impeller::StorageMode::kDevicePrivate;
  desc.format = impeller::PixelFormat::kR8G8B8A8UNormInt;
  desc.size = impeller::ISize(image->width(), image->height());
  desc.mip_count = 1;
 
  auto texture = context->GetResourceAllocator()->CreateTexture(desc);
  if (!texture) {
    return nullptr;
  }
 
  size_t byte_size = image->width() * image->height() * 4;
  auto buffer = context->GetResourceAllocator()->CreateBuffer(
      impeller::DeviceBufferDescriptor{
          .storage_mode = impeller::StorageMode::kHostVisible,
          .size = byte_size,
      });
 
  if (!buffer) {
    return nullptr;
  }
 
  {
    uint8_t* map = buffer->OnGetContents();
    if (!map) {
      return nullptr;
    }
    SkImageInfo info =
        SkImageInfo::Make(image->width(), image->height(),
                          kRGBA_8888_SkColorType, kPremul_SkAlphaType);
    if (!image->readPixels(info, map, image->width() * 4, 0, 0)) {
      return nullptr;
    }
    buffer->Flush(impeller::Range(0, byte_size));
  }
 
  auto command_buffer = context->CreateCommandBuffer();
  if (!command_buffer) {
    return nullptr;
  }
  auto blit_pass = command_buffer->CreateBlitPass();
  if (!blit_pass) {
    return nullptr;
  }
 
  blit_pass->AddCopy(
      impeller::BufferView{buffer, impeller::Range(0, byte_size)}, texture);
  blit_pass->EncodeCommands();
 
  if (!context->GetCommandQueue()->Submit({command_buffer}).ok()) {
    return nullptr;
  }
 
  return impeller::DlImageImpeller::Make(texture,
                                         DlImage::OwningContext::kRaster);
}

References flutter::buffer, impeller::TextureDescriptor::format, flutter::SnapshotController::Delegate::GetAiksContext(), flutter::SnapshotController::GetDelegate(), image, impeller::kDevicePrivate, impeller::kHostVisible, impeller::kR8G8B8A8UNormInt, flutter::DlImage::kRaster, impeller::DlImageImpeller::Make(), impeller::TextureDescriptor::mip_count, impeller::TextureDescriptor::size, impeller::DeviceBufferDescriptor::storage_mode, impeller::TextureDescriptor::storage_mode, and texture.

---

The documentation for this class was generated from the following files:

• shell/common/snapshot_controller_impeller.h
• shell/common/snapshot_controller_impeller.cc