Flutter Engine
The Flutter Engine
Classes | Public Member Functions | List of all members
flutter::EmbedderSurfaceVulkan Class Referencefinal

#include <embedder_surface_vulkan.h>

Inheritance diagram for flutter::EmbedderSurfaceVulkan:
flutter::EmbedderSurface flutter::GPUSurfaceVulkanDelegate

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. More...
 
FlutterVulkanImage AcquireImage (const SkISize &size) override
 Called by the engine to fetch a VkImage for writing the next frame. More...
 
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. More...
 
- Public Member Functions inherited from flutter::EmbedderSurface
 EmbedderSurface ()
 
virtual ~EmbedderSurface ()
 
virtual bool IsValid () const =0
 
virtual std::unique_ptr< Surface > CreateGPUSurface ()=0
 
virtual std::shared_ptr< impeller::Context > CreateImpellerContext () const
 
virtual sk_sp< GrDirectContext > CreateResourceContext () const
 
- Public Member Functions inherited from flutter::GPUSurfaceVulkanDelegate
virtual ~GPUSurfaceVulkanDelegate ()
 
virtual const vulkan::VulkanProcTable & vk ()=0
 Obtain a reference to the Vulkan implementation's proc table. More...
 
virtual FlutterVulkanImage AcquireImage (const SkISize &size)=0
 Called by the engine to fetch a VkImage for writing the next frame. More...
 
virtual bool PresentImage (VkImage image, VkFormat format)=0
 Called by the engine once a frame has been rendered to the image and it's ready to be bound for further reading/writing. More...
 

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.

34 : vk_(fml::MakeRefCounted<vulkan::VulkanProcTable>(
35 vulkan_dispatch_table.get_instance_proc_address)),
36 device_(*vk_,
37 vulkan::VulkanHandle<VkPhysicalDevice>{physical_device},
38 vulkan::VulkanHandle<VkDevice>{device},
39 queue_family_index,
40 vulkan::VulkanHandle<VkQueue>{queue}),
41 vulkan_dispatch_table_(vulkan_dispatch_table),
42 external_view_embedder_(std::move(external_view_embedder)) {
43 // Make sure all required members of the dispatch table are checked.
44 if (!vulkan_dispatch_table_.get_instance_proc_address ||
45 !vulkan_dispatch_table_.get_next_image ||
46 !vulkan_dispatch_table_.present_image) {
47 return;
48 }
49
50 bool success = vk_->SetupInstanceProcAddresses(
51 vulkan::VulkanHandle<VkInstance>{instance});
52 if (!success) {
53 FML_LOG(ERROR) << "Could not setup instance proc addresses.";
54 return;
55 }
56 success =
57 vk_->SetupDeviceProcAddresses(vulkan::VulkanHandle<VkDevice>{device});
58 if (!success) {
59 FML_LOG(ERROR) << "Could not setup device proc addresses.";
60 return;
61 }
62 if (!vk_->IsValid()) {
63 FML_LOG(ERROR) << "VulkanProcTable invalid.";
64 return;
65 }
66
67 main_context_ = CreateGrContext(instance, version, instance_extension_count,
68 instance_extensions, device_extension_count,
69 device_extensions, ContextType::kRender);
70 // TODO(96954): Add a second (optional) queue+family index to the Embedder API
71 // to allow embedders to specify a dedicated transfer queue for
72 // use by the resource context. Queue families with graphics
73 // capability can always be used for memory transferring, but it
74 // would be advantageous to use a dedicated transter queue here.
75 resource_context_ = CreateGrContext(
76 instance, version, instance_extension_count, instance_extensions,
77 device_extension_count, device_extensions, ContextType::kResource);
78
79 valid_ = main_context_ && resource_context_;
80}
vulkan::VulkanProcTable::SetupInstanceProcAddresses
bool SetupInstanceProcAddresses(const VulkanHandle< VkInstance > &instance)
Definition: vulkan_proc_table.cc:94
vulkan::VulkanProcTable::SetupDeviceProcAddresses
bool SetupDeviceProcAddresses(const VulkanHandle< VkDevice > &device)
Definition: vulkan_proc_table.cc:133
physical_device
VkPhysicalDevice physical_device
Definition: main.cc:51
device
VkDevice device
Definition: main.cc:53
instance
VkInstance instance
Definition: main.cc:48
queue
VkQueue queue
Definition: main.cc:55
queue_family_index
uint32_t queue_family_index
Definition: main.cc:54
FML_LOG
#define FML_LOG(severity)
Definition: logging.h:82
flutter::ContextType::kRender
@ kRender
The context is used to render to a texture or renderbuffer.
mskp_parser.version
version
Definition: mskp_parser.py:30
flutter::EmbedderSurfaceVulkan::VulkanDispatchTable::present_image
std::function< bool(VkImage image, VkFormat format)> present_image
Definition: embedder_surface_vulkan.h:27
flutter::EmbedderSurfaceVulkan::VulkanDispatchTable::get_next_image
std::function< FlutterVulkanImage(const SkISize &frame_size)> get_next_image
Definition: embedder_surface_vulkan.h:25
ERROR
#define ERROR(message)
Definition: elf_loader.cc:260

◆ ~EmbedderSurfaceVulkan()

flutter::EmbedderSurfaceVulkan::~EmbedderSurfaceVulkan ( )
override

Definition at line 82 of file embedder_surface_vulkan.cc.

82 {
83 if (main_context_) {
84 main_context_->releaseResourcesAndAbandonContext();
85 }
86 if (resource_context_) {
87 resource_context_->releaseResourcesAndAbandonContext();
88 }
89}
GrDirectContext::releaseResourcesAndAbandonContext
void releaseResourcesAndAbandonContext()
Definition: GrDirectContext.cpp:193

Member Function Documentation

◆ AcquireImage()

FlutterVulkanImage flutter::EmbedderSurfaceVulkan::AcquireImage ( const SkISize &  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.

97 {
98 return vulkan_dispatch_table_.get_next_image(size);
99}
flutter::size
it will be possible to load the file into Perfetto s trace viewer disable asset Prevents usage of any non test fonts unless they were explicitly Loaded via prefetched default font Indicates whether the embedding started a prefetch of the default font manager before creating the engine run In non interactive keep the shell running after the Dart script has completed enable serial On low power devices with low core running concurrent GC tasks on threads can cause them to contend with the UI thread which could potentially lead to jank This option turns off all concurrent GC activities domain network JSON encoded network policy per domain This overrides the DisallowInsecureConnections switch Embedder can specify whether to allow or disallow insecure connections at a domain level old gen heap size
Definition: switches.h:259

◆ 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.

102 {
103 return vulkan_dispatch_table_.present_image(image, format);
104}
SkRecords::image
sk_sp< const SkImage > image
Definition: SkRecords.h:269
flutter::format
DEF_SWITCHES_START aot vmservice shared library Name of the *so containing AOT compiled Dart assets for launching the service isolate vm snapshot The VM snapshot data that will be memory mapped as read only SnapshotAssetPath must be present isolate snapshot The isolate snapshot data that will be memory mapped as read only SnapshotAssetPath must be present cache dir Path to the cache directory This is different from the persistent_cache_path in embedder which is used for Skia shader cache icu native lib Path to the library file that exports the ICU data vm service The hostname IP address on which the Dart VM Service should be served If not defaults to or::depending on whether ipv6 is specified vm service A custom Dart VM Service port The default is to pick a randomly available open port disable vm Disable the Dart VM Service The Dart VM Service is never available in release mode disable vm service Disable mDNS Dart VM Service publication Bind to the IPv6 localhost address for the Dart VM Service Ignored if vm service host is set endless trace Enable an endless trace buffer The default is a ring buffer This is useful when very old events need to viewed For during application launch Memory usage will continue to grow indefinitely however Start app with an specific route defined on the framework flutter assets Path to the Flutter assets directory enable service port Allow the VM service to fallback to automatic port selection if binding to a specified port fails trace Trace early application lifecycle Automatically switches to an endless trace buffer trace skia Filters out all Skia trace event categories except those that are specified in this comma separated list dump skp on shader Automatically dump the skp that triggers new shader compilations This is useful for writing custom ShaderWarmUp to reduce jank By this is not enabled to reduce the overhead purge persistent Remove all existing persistent cache This is mainly for debugging purposes such as reproducing the shader compilation jank trace to Write the timeline trace to a file at the specified path The file will be in Perfetto s proto format
Definition: switches.h:203

◆ 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.

92 {
93 return *vk_;
94}
The documentation for this class was generated from the following files:
Generated on Sun Jun 23 2024 22:00:00 for Flutter Engine by doxygen 1.9.4