Flutter Engine
flutter::testing::ShellTestPlatformView Class Referenceabstract

#include <shell_test_platform_view.h>

Inheritance diagram for flutter::testing::ShellTestPlatformView:
flutter::PlatformView flutter::testing::ShellTestPlatformViewGL flutter::testing::ShellTestPlatformViewVulkan

Public Types

enum  BackendType {
  BackendType::kGLBackend,
  BackendType::kVulkanBackend,
  BackendType::kDefaultBackend
}
 

Public Member Functions

virtual void SimulateVSync ()=0
 
- Public Member Functions inherited from flutter::PlatformView
 PlatformView (Delegate &delegate, TaskRunners task_runners)
 Creates a platform view with the specified delegate and task runner. The base class by itself does not do much but is suitable for use in test environments where full platform integration may not be necessary. The platform view may only be created, accessed and destroyed on the platform task runner. More...
 
virtual ~PlatformView ()
 Destroys the platform view. The platform view is owned by the shell and will be destroyed by the same on the platform tasks runner. More...
 
virtual std::unique_ptr< VsyncWaiterCreateVSyncWaiter ()
 Invoked by the shell to obtain a platform specific vsync waiter. It is optional for platforms to override this method and provide a custom vsync waiter because a timer based fall-back waiter is used by default. However, it is highly recommended that platform provide their own Vsync waiter as the timer based fall-back will not render frames aligned with vsync boundaries. More...
 
void DispatchPlatformMessage (fml::RefPtr< PlatformMessage > message)
 Used by embedders to dispatch a platform message to a running root isolate hosted by the engine. If an isolate is not running, the message is dropped. If there is no one on the other side listening on the channel, the message is dropped. When a platform message is dropped, any response handles associated with that message will be dropped as well. All users of platform messages must assume that message may not be delivered and/or their response handles may not be invoked. Platform messages are not buffered. More...
 
virtual void HandlePlatformMessage (fml::RefPtr< PlatformMessage > message)
 Overridden by embedders to perform actions in response to platform messages sent from the framework to the embedder. Default implementation of this method simply returns an empty response. More...
 
void DispatchSemanticsAction (int32_t id, SemanticsAction action, std::vector< uint8_t > args)
 Used by embedders to dispatch an accessibility action to a running isolate hosted by the engine. More...
 
virtual void SetSemanticsEnabled (bool enabled)
 Used by embedder to notify the running isolate hosted by the engine on the UI thread that the accessibility tree needs to be generated. More...
 
virtual void SetAccessibilityFeatures (int32_t flags)
 Used by the embedder to specify the features to enable in the accessibility tree generated by the isolate. This information is forwarded to the root isolate hosted by the engine on the UI thread. More...
 
virtual void UpdateSemantics (SemanticsNodeUpdates updates, CustomAccessibilityActionUpdates actions)
 Used by the framework to tell the embedder to apply the specified semantics node updates. The default implementation of this method does nothing. More...
 
void SetViewportMetrics (const ViewportMetrics &metrics)
 Used by embedders to specify the updated viewport metrics. In response to this call, on the raster thread, the rasterizer may need to be reconfigured to the updated viewport dimensions. On the UI thread, the framework may need to start generating a new frame for the updated viewport metrics as well. More...
 
void NotifyCreated ()
 Used by embedders to notify the shell that a platform view has been created. This notification is used to create a rendering surface and pick the client rendering API to use to render into this surface. No frames will be scheduled or rendered before this call. The surface must remain valid till the corresponding call to NotifyDestroyed. More...
 
virtual void NotifyDestroyed ()
 Used by embedders to notify the shell that the platform view has been destroyed. This notification used to collect the rendering surface and all associated resources. Frame scheduling is also suspended. More...
 
virtual sk_sp< GrDirectContext > CreateResourceContext () const
 Used by the shell to obtain a Skia GPU context that is capable of operating on the IO thread. The context must be in the same share-group as the Skia GPU context used on the render thread. This context will always be used on the IO thread. Because it is in the same share-group as the separate render thread context, any GPU resources uploaded in this context will be visible to the render thread context (synchronization of GPU resources is managed by Skia). More...
 
virtual void ReleaseResourceContext () const
 Used by the shell to notify the embedder that the resource context previously obtained via a call to CreateResourceContext() is being collected. The embedder is free to collect an platform specific resources associated with this context. More...
 
virtual PointerDataDispatcherMaker GetDispatcherMaker ()
 Returns a platform-specific PointerDataDispatcherMaker so the Engine can construct the PointerDataPacketDispatcher based on platforms. More...
 
fml::WeakPtr< PlatformViewGetWeakPtr () const
 Returns a weak pointer to the platform view. Since the platform view may only be created, accessed and destroyed on the platform thread, any access to the platform view from a non-platform task runner needs a weak pointer to the platform view along with a reference to the platform task runner. A task must be posted to the platform task runner with the weak pointer captured in the same. The platform view method may only be called in the posted task once the weak pointer validity has been checked. This method is used by callers to obtain that weak pointer. More...
 
virtual void OnPreEngineRestart () const
 Gives embedders a chance to react to a "cold restart" of the running isolate. The default implementation of this method does nothing. More...
 
void SetNextFrameCallback (const fml::closure &closure)
 Sets a callback that gets executed when the rasterizer renders the next frame. Due to the asynchronous nature of rendering in Flutter, embedders usually add a placeholder over the contents in which Flutter is going to render when Flutter is first initialized. This callback may be used as a signal to remove that placeholder. The callback is executed on the render task runner and not the platform task runner. It is the embedder's responsibility to re-thread as necessary. More...
 
void DispatchPointerDataPacket (std::unique_ptr< PointerDataPacket > packet)
 Dispatches pointer events from the embedder to the framework. Each pointer data packet may contain multiple pointer input events. Each call to this method wakes up the UI thread. More...
 
void RegisterTexture (std::shared_ptr< flutter::Texture > texture)
 Used by the embedder to specify a texture that it wants the rasterizer to composite within the Flutter layer tree. All textures must have a unique identifier. When the rasterizer encounters an external texture within its hierarchy, it gives the embedder a chance to update that texture on the raster thread before it composites the same on-screen. More...
 
void UnregisterTexture (int64_t texture_id)
 Used by the embedder to notify the rasterizer that it will no longer attempt to composite the specified texture within the layer tree. This allows the rasterizer to collect associated resources. More...
 
void MarkTextureFrameAvailable (int64_t texture_id)
 Used by the embedder to notify the rasterizer that the context of the previously registered texture have been updated. Typically, Flutter will only render a frame if there is an updated layer tree. However, in cases where the layer tree is static but one of the externally composited textures has been updated by the embedder, the embedder needs to notify the rasterizer to render a new frame. In such cases, the existing layer tree may be reused with the frame re-composited with all updated external textures. Unlike the calls to register and unregister the texture, this call must be made each time a new texture frame is available. More...
 
virtual std::unique_ptr< std::vector< std::string > > ComputePlatformResolvedLocales (const std::vector< std::string > &supported_locale_data)
 Directly invokes platform-specific APIs to compute the locale the platform would have natively resolved to. More...
 

Static Public Member Functions

static std::unique_ptr< ShellTestPlatformViewCreate (PlatformView::Delegate &delegate, TaskRunners task_runners, std::shared_ptr< ShellTestVsyncClock > vsync_clock, CreateVsyncWaiter create_vsync_waiter, BackendType backend, std::shared_ptr< ShellTestExternalViewEmbedder > shell_test_external_view_embedder)
 

Protected Member Functions

 ShellTestPlatformView (PlatformView::Delegate &delegate, TaskRunners task_runners)
 
 FML_DISALLOW_COPY_AND_ASSIGN (ShellTestPlatformView)
 
- Protected Member Functions inherited from flutter::PlatformView
virtual std::unique_ptr< SurfaceCreateRenderingSurface ()
 

Additional Inherited Members

- Protected Attributes inherited from flutter::PlatformView
PlatformView::Delegatedelegate_
 
const TaskRunners task_runners_
 
PointerDataPacketConverter pointer_data_packet_converter_
 
SkISize size_
 
fml::WeakPtrFactory< PlatformViewweak_factory_
 

Detailed Description

Definition at line 15 of file shell_test_platform_view.h.

Member Enumeration Documentation

◆ BackendType

Enumerator
kGLBackend 
kVulkanBackend 
kDefaultBackend 

Definition at line 17 of file shell_test_platform_view.h.

17  {
18  kGLBackend,
19  kVulkanBackend,
20  kDefaultBackend,
21  };

Constructor & Destructor Documentation

◆ ShellTestPlatformView()

flutter::testing::ShellTestPlatformView::ShellTestPlatformView ( PlatformView::Delegate delegate,
TaskRunners  task_runners 
)
inlineprotected

Definition at line 35 of file shell_test_platform_view.h.

References FML_DISALLOW_COPY_AND_ASSIGN().

37  : PlatformView(delegate, task_runners) {}
PlatformView(Delegate &delegate, TaskRunners task_runners)
Creates a platform view with the specified delegate and task runner. The base class by itself does no...

Member Function Documentation

◆ Create()

std::unique_ptr< ShellTestPlatformView > flutter::testing::ShellTestPlatformView::Create ( PlatformView::Delegate delegate,
TaskRunners  task_runners,
std::shared_ptr< ShellTestVsyncClock vsync_clock,
CreateVsyncWaiter  create_vsync_waiter,
BackendType  backend,
std::shared_ptr< ShellTestExternalViewEmbedder shell_test_external_view_embedder 
)
static

Definition at line 17 of file shell_test_platform_view.cc.

References FML_LOG, kDefaultBackend, kGLBackend, and kVulkanBackend.

Referenced by flutter::testing::ShellTest::CreateShell(), and flutter::testing::TEST_F().

24  {
25  // TODO(gw280): https://github.com/flutter/flutter/issues/50298
26  // Make this fully runtime configurable
27  switch (backend) {
29 #ifdef SHELL_ENABLE_GL
31  return std::make_unique<ShellTestPlatformViewGL>(
32  delegate, task_runners, vsync_clock, create_vsync_waiter,
33  shell_test_external_view_embedder);
34 #endif // SHELL_ENABLE_GL
35 #ifdef SHELL_ENABLE_VULKAN
37  return std::make_unique<ShellTestPlatformViewVulkan>(
38  delegate, task_runners, vsync_clock, create_vsync_waiter,
39  shell_test_external_view_embedder);
40 #endif // SHELL_ENABLE_VULKAN
41  default:
42  FML_LOG(FATAL) << "No backends supported for ShellTestPlatformView";
43  return nullptr;
44  }
45 }
#define FML_LOG(severity)
Definition: logging.h:65

◆ FML_DISALLOW_COPY_AND_ASSIGN()

flutter::testing::ShellTestPlatformView::FML_DISALLOW_COPY_AND_ASSIGN ( ShellTestPlatformView  )
protected

Referenced by ShellTestPlatformView().

◆ SimulateVSync()

virtual void flutter::testing::ShellTestPlatformView::SimulateVSync ( )
pure virtual

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