flutter::EmbedderSurfaceVulkan Class Reference

#include <embedder_surface_vulkan.h>

Inheritance diagram for flutter::EmbedderSurfaceVulkan:

Classes
struct	VulkanDispatchTable

Public Member Functions
	EmbedderSurfaceVulkan (uint32_t version, VkInstance instance, size_t instance_extension_count, const char **instance_extensions, size_t device_extension_count, const char **device_extensions, VkPhysicalDevice physical_device, VkDevice device, uint32_t queue_family_index, VkQueue queue, const VulkanDispatchTable &vulkan_dispatch_table, std::shared_ptr< EmbedderExternalViewEmbedder > external_view_embedder)
	~EmbedderSurfaceVulkan () override
const vulkan::VulkanProcTable &	vk () override
	Obtain a reference to the Vulkan implementation's proc table.
FlutterVulkanImage	AcquireImage (const DlISize &size) override
	Called by the engine to fetch a VkImage for writing the next frame.
bool	PresentImage (VkImage image, VkFormat format) override
	Called by the engine once a frame has been rendered to the image and it's ready to be bound for further reading/writing.
Public Member Functions inherited from flutter::EmbedderSurface
	EmbedderSurface ()
virtual	~EmbedderSurface ()
virtual std::shared_ptr< impeller::Context >	CreateImpellerContext () const
Public Member Functions inherited from flutter::GPUSurfaceVulkanDelegate
virtual	~GPUSurfaceVulkanDelegate ()

Detailed Description

Definition at line 19 of file embedder_surface_vulkan.h.

Constructor & Destructor Documentation

EmbedderSurfaceVulkan()

flutter::EmbedderSurfaceVulkan::EmbedderSurfaceVulkan	(	uint32_t	version,
		VkInstance	instance,
		size_t	instance_extension_count,
		const char **	instance_extensions,
		size_t	device_extension_count,
		const char **	device_extensions,
		VkPhysicalDevice	physical_device,
		VkDevice	device,
		uint32_t	queue_family_index,
		VkQueue	queue,
		const VulkanDispatchTable &	vulkan_dispatch_table,
		std::shared_ptr< EmbedderExternalViewEmbedder >	external_view_embedder
	)

Definition at line 21 of file embedder_surface_vulkan.cc.

    : vk_(fml::MakeRefCounted<vulkan::VulkanProcTable>(
          vulkan_dispatch_table.get_instance_proc_address)),
      device_(*vk_,
              vulkan::VulkanHandle<VkPhysicalDevice>{physical_device},
              vulkan::VulkanHandle<VkDevice>{device},
              queue_family_index,
              vulkan::VulkanHandle<VkQueue>{queue}),
      vulkan_dispatch_table_(vulkan_dispatch_table),
      external_view_embedder_(std::move(external_view_embedder)) {
  // Make sure all required members of the dispatch table are checked.
  if (!vulkan_dispatch_table_.get_instance_proc_address ||
      !vulkan_dispatch_table_.get_next_image ||
      !vulkan_dispatch_table_.present_image) {
    return;
  }
 
  bool success = vk_->SetupInstanceProcAddresses(
      vulkan::VulkanHandle<VkInstance>{instance});
  if (!success) {
    FML_LOG(ERROR) << "Could not setup instance proc addresses.";
    return;
  }
  success =
      vk_->SetupDeviceProcAddresses(vulkan::VulkanHandle<VkDevice>{device});
  if (!success) {
    FML_LOG(ERROR) << "Could not setup device proc addresses.";
    return;
  }
  if (!vk_->IsValid()) {
    FML_LOG(ERROR) << "VulkanProcTable invalid.";
    return;
  }
 
  main_context_ = CreateGrContext(instance, version, instance_extension_count,
                                  instance_extensions, device_extension_count,
                                  device_extensions, ContextType::kRender);
  // TODO(96954): Add a second (optional) queue+family index to the Embedder API
  //              to allow embedders to specify a dedicated transfer queue for
  //              use by the resource context. Queue families with graphics
  //              capability can always be used for memory transferring, but it
  //              would be advantageous to use a dedicated transter queue here.
  resource_context_ = CreateGrContext(
      instance, version, instance_extension_count, instance_extensions,
      device_extension_count, device_extensions, ContextType::kResource);
 
  valid_ = main_context_ && resource_context_;
}

References physical_device.

~EmbedderSurfaceVulkan()

flutter::EmbedderSurfaceVulkan::~EmbedderSurfaceVulkan ( )

override

Definition at line 82 of file embedder_surface_vulkan.cc.

                                              {
  if (main_context_) {
    main_context_->releaseResourcesAndAbandonContext();
  }
  if (resource_context_) {
    resource_context_->releaseResourcesAndAbandonContext();
  }
}

Member Function Documentation

AcquireImage()

FlutterVulkanImage flutter::EmbedderSurfaceVulkan::AcquireImage ( const DlISize &  size )

overridevirtual

Called by the engine to fetch a VkImage for writing the next frame.

Implements flutter::GPUSurfaceVulkanDelegate.

Definition at line 97 of file embedder_surface_vulkan.cc.

                                                                          {
  return vulkan_dispatch_table_.get_next_image(size);
}

References flutter::EmbedderSurfaceVulkan::VulkanDispatchTable::get_next_image, and flutter::size.

PresentImage()

bool flutter::EmbedderSurfaceVulkan::PresentImage ( VkImage  image, VkFormat  format  )

overridevirtual

Called by the engine once a frame has been rendered to the image and it's ready to be bound for further reading/writing.

Implements flutter::GPUSurfaceVulkanDelegate.

Definition at line 102 of file embedder_surface_vulkan.cc.

                                                                       {
  return vulkan_dispatch_table_.present_image(image, format);
}

References format, image, and flutter::EmbedderSurfaceVulkan::VulkanDispatchTable::present_image.

vk()

const vulkan::VulkanProcTable & flutter::EmbedderSurfaceVulkan::vk ( )

overridevirtual

Obtain a reference to the Vulkan implementation's proc table.

Implements flutter::GPUSurfaceVulkanDelegate.

Definition at line 92 of file embedder_surface_vulkan.cc.

                                                       {
  return *vk_;
}

---

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

• shell/platform/embedder/embedder_surface_vulkan.h
• shell/platform/embedder/embedder_surface_vulkan.cc