Flutter Engine
The Flutter Engine
embedder_surface_vulkan.h
Go to the documentation of this file.
1// Copyright 2013 The Flutter Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef FLUTTER_SHELL_PLATFORM_EMBEDDER_EMBEDDER_SURFACE_VULKAN_H_
6#define FLUTTER_SHELL_PLATFORM_EMBEDDER_EMBEDDER_SURFACE_VULKAN_H_
7
8#include "flutter/fml/macros.h"
9#include "flutter/shell/common/context_options.h"
10#include "flutter/shell/gpu/gpu_surface_vulkan.h"
11#include "flutter/shell/gpu/gpu_surface_vulkan_delegate.h"
12#include "flutter/shell/platform/embedder/embedder.h"
13#include "flutter/shell/platform/embedder/embedder_external_view_embedder.h"
14#include "flutter/shell/platform/embedder/embedder_surface.h"
15#include "flutter/vulkan/procs/vulkan_proc_table.h"
16
17namespace flutter {
18
21 public:
24 std::function<FlutterVulkanImage(const SkISize& frame_size)>
25 get_next_image; // required
26 std::function<bool(VkImage image, VkFormat format)>
27 present_image; // required
28 };
29
31 uint32_t version,
32 VkInstance instance,
33 size_t instance_extension_count,
34 const char** instance_extensions,
35 size_t device_extension_count,
36 const char** device_extensions,
37 VkPhysicalDevice physical_device,
38 VkDevice device,
39 uint32_t queue_family_index,
40 VkQueue queue,
41 const VulkanDispatchTable& vulkan_dispatch_table,
42 std::shared_ptr<EmbedderExternalViewEmbedder> external_view_embedder);
43
44 ~EmbedderSurfaceVulkan() override;
45
46 // |GPUSurfaceVulkanDelegate|
47 const vulkan::VulkanProcTable& vk() override;
48
49 // |GPUSurfaceVulkanDelegate|
51
52 // |GPUSurfaceVulkanDelegate|
53 bool PresentImage(VkImage image, VkFormat format) override;
54
55 private:
56 bool valid_ = false;
59 VulkanDispatchTable vulkan_dispatch_table_;
60 std::shared_ptr<EmbedderExternalViewEmbedder> external_view_embedder_;
61 sk_sp<GrDirectContext> main_context_;
62 sk_sp<GrDirectContext> resource_context_;
63
64 // |EmbedderSurface|
65 bool IsValid() const override;
66
67 // |EmbedderSurface|
68 std::unique_ptr<Surface> CreateGPUSurface() override;
69
70 // |EmbedderSurface|
71 sk_sp<GrDirectContext> CreateResourceContext() const override;
72
73 sk_sp<GrDirectContext> CreateGrContext(VkInstance instance,
74 uint32_t version,
75 size_t instance_extension_count,
76 const char** instance_extensions,
77 size_t device_extension_count,
78 const char** device_extensions,
79 ContextType context_type) const;
80
81 void* GetInstanceProcAddress(VkInstance instance, const char* proc_name);
82
83 FML_DISALLOW_COPY_AND_ASSIGN(EmbedderSurfaceVulkan);
84};
85
86} // namespace flutter
87
88#endif // FLUTTER_SHELL_PLATFORM_EMBEDDER_EMBEDDER_SURFACE_VULKAN_H_
FlutterVulkanImage AcquireImage(const SkISize &size) override
Called by the engine to fetch a VkImage for writing the next frame.
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)
const vulkan::VulkanProcTable & vk() override
Obtain a reference to the Vulkan implementation's proc table.
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 furth...
Interface implemented by all platform surfaces that can present a Vulkan backing store to the "screen...
VkPhysicalDevice physical_device
Definition: main.cc:51
VkDevice device
Definition: main.cc:53
VkInstance instance
Definition: main.cc:48
VkQueue queue
Definition: main.cc:55
uint32_t queue_family_index
Definition: main.cc:54
Dart_NativeFunction function
Definition: fuchsia.cc:51
sk_sp< const SkImage > image
Definition: SkRecords.h:269
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
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
Definition: SkSize.h:16
std::function< bool(VkImage image, VkFormat format)> present_image
std::function< FlutterVulkanImage(const SkISize &frame_size)> get_next_image
VkFormat
Definition: vulkan_core.h:1458
PFN_vkVoidFunction(VKAPI_PTR * PFN_vkGetInstanceProcAddr)(VkInstance instance, const char *pName)
Definition: vulkan_core.h:3989