flutter::GPUSurfaceVulkan Class Reference

A GPU surface backed by VkImages provided by a GPUSurfaceVulkanDelegate. More...

#include <gpu_surface_vulkan.h>

Inheritance diagram for flutter::GPUSurfaceVulkan:

Public Member Functions
	GPUSurfaceVulkan (GPUSurfaceVulkanDelegate *delegate, const sk_sp< GrDirectContext > &context, bool render_to_surface)
	Create a GPUSurfaceVulkan while letting it reuse an existing GrDirectContext.
	~GPUSurfaceVulkan () override
bool	IsValid () override
std::unique_ptr< SurfaceFrame >	AcquireFrame (const DlISize &size) override
DlMatrix	GetRootTransformation () const override
GrDirectContext *	GetContext () override
Public Member Functions inherited from flutter::Surface
	Surface ()
virtual	~Surface ()
virtual std::unique_ptr< GLContextResult >	MakeRenderContextCurrent ()
virtual bool	ClearRenderContext ()
virtual bool	AllowsDrawingWhenGpuDisabled () const
virtual bool	EnableRasterCache () const
virtual std::shared_ptr< impeller::AiksContext >	GetAiksContext () const
virtual SurfaceData	GetSurfaceData () const

Static Public Member Functions
static SkColorType	ColorTypeFromFormat (const VkFormat format)

Detailed Description

A GPU surface backed by VkImages provided by a GPUSurfaceVulkanDelegate.

Definition at line 26 of file gpu_surface_vulkan.h.

Constructor & Destructor Documentation

GPUSurfaceVulkan()

flutter::GPUSurfaceVulkan::GPUSurfaceVulkan	(	GPUSurfaceVulkanDelegate *	delegate,
		const sk_sp< GrDirectContext > &	context,
		bool	render_to_surface
	)

Create a GPUSurfaceVulkan while letting it reuse an existing GrDirectContext.

Definition at line 22 of file gpu_surface_vulkan.cc.

    : delegate_(delegate),
      skia_context_(skia_context),
      render_to_surface_(render_to_surface),
      weak_factory_(this) {}

~GPUSurfaceVulkan()

flutter::GPUSurfaceVulkan::~GPUSurfaceVulkan ( )

overridedefault

Member Function Documentation

AcquireFrame()

std::unique_ptr< SurfaceFrame > flutter::GPUSurfaceVulkan::AcquireFrame ( const DlISize &  size )

overridevirtual

Implements flutter::Surface.

Definition at line 36 of file gpu_surface_vulkan.cc.

                               {
  if (!IsValid()) {
    FML_LOG(ERROR) << "Vulkan surface was invalid.";
    return nullptr;
  }
 
  if (frame_size.IsEmpty()) {
    FML_LOG(ERROR) << "Vulkan surface was asked for an empty frame.";
    return nullptr;
  }
 
  if (!render_to_surface_) {
    return std::make_unique<SurfaceFrame>(
        nullptr, SurfaceFrame::FramebufferInfo(),
        [](const SurfaceFrame& surface_frame, DlCanvas* canvas) {
          return true;
        },
        [](const SurfaceFrame& surface_frame) { return true; }, frame_size);
  }
 
  FlutterVulkanImage image = delegate_->AcquireImage(frame_size);
  if (!image.image) {
    FML_LOG(ERROR) << "Invalid VkImage given by the embedder.";
    return nullptr;
  }
 
  sk_sp<SkSurface> surface = CreateSurfaceFromVulkanImage(
      reinterpret_cast<VkImage>(image.image),
      static_cast<VkFormat>(image.format), frame_size);
  if (!surface) {
    FML_LOG(ERROR) << "Could not create the SkSurface from the Vulkan image.";
    return nullptr;
  }
 
  SurfaceFrame::EncodeCallback encode_callback = [](const SurfaceFrame&,
                                                    DlCanvas* canvas) -> bool {
    if (canvas == nullptr) {
      FML_DLOG(ERROR) << "Canvas not available.";
      return false;
    }
    canvas->Flush();
    return true;
  };
 
  SurfaceFrame::SubmitCallback submit_callback =
      [image = image, delegate = delegate_](const SurfaceFrame&) -> bool {
    TRACE_EVENT0("flutter", "GPUSurfaceVulkan::PresentImage");
    return delegate->PresentImage(reinterpret_cast<VkImage>(image.image),
                                  static_cast<VkFormat>(image.format));
  };
 
  SurfaceFrame::FramebufferInfo framebuffer_info{.supports_readback = true};
 
  return std::make_unique<SurfaceFrame>(std::move(surface), framebuffer_info,
                                        std::move(encode_callback),
                                        std::move(submit_callback), frame_size);
}

References flutter::GPUSurfaceVulkanDelegate::AcquireImage(), FML_DLOG, FML_LOG, FlutterVulkanImage::format, FlutterVulkanImage::image, image, impeller::TSize< T >::IsEmpty(), IsValid(), flutter::SurfaceFrame::FramebufferInfo::supports_readback, surface, and TRACE_EVENT0.

ColorTypeFromFormat()

SkColorType flutter::GPUSurfaceVulkan::ColorTypeFromFormat ( const VkFormat  format )

static

Definition at line 141 of file gpu_surface_vulkan.cc.

                                                                       {
  switch (format) {
    case VK_FORMAT_R8G8B8A8_UNORM:
    case VK_FORMAT_R8G8B8A8_SRGB:
      return SkColorType::kRGBA_8888_SkColorType;
    case VK_FORMAT_B8G8R8A8_UNORM:
    case VK_FORMAT_B8G8R8A8_SRGB:
      return SkColorType::kBGRA_8888_SkColorType;
    default:
      return SkColorType::kUnknown_SkColorType;
  }
}

References format.

Referenced by MakeSkSurfaceFromBackingStore().

GetContext()

GrDirectContext * flutter::GPUSurfaceVulkan::GetContext ( )

overridevirtual

Implements flutter::Surface.

Definition at line 101 of file gpu_surface_vulkan.cc.

                                              {
  return skia_context_.get();
}

GetRootTransformation()

DlMatrix flutter::GPUSurfaceVulkan::GetRootTransformation ( ) const

overridevirtual

Implements flutter::Surface.

Definition at line 95 of file gpu_surface_vulkan.cc.

                                                       {
  // This backend does not support delegating to the underlying platform to
  // query for root surface transformations. Just return identity.
  return DlMatrix();
}

IsValid()

bool flutter::GPUSurfaceVulkan::IsValid ( )

overridevirtual

Implements flutter::Surface.

Definition at line 32 of file gpu_surface_vulkan.cc.

                               {
  return skia_context_ != nullptr;
}

Referenced by AcquireFrame().

---

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

• shell/gpu/gpu_surface_vulkan.h
• shell/gpu/gpu_surface_vulkan.cc