State holder for a Flutter overlay layer. More...

#include <overlay_layer_pool.h>

Public Member Functions
	OverlayLayer (UIView overlay_view, UIView overlay_view_wrapper, std::unique_ptr< IOSSurface > ios_surface, std::unique_ptr< Surface > surface)

	~OverlayLayer ()=default

void	UpdateViewState (UIView *flutter_view, SkRect rect, int64_t view_id, int64_t overlay_id)

Public Attributes
UIView *	overlay_view

UIView *	overlay_view_wrapper

std::unique_ptr< IOSSurface >	ios_surface

std::unique_ptr< Surface >	surface

bool	did_submit_last_frame

Detailed Description

State holder for a Flutter overlay layer.

Definition at line 22 of file overlay_layer_pool.h.

Constructor & Destructor Documentation

◆ OverlayLayer()

flutter::OverlayLayer::OverlayLayer	(	UIView *	overlay_view,
		UIView *	overlay_view_wrapper,
		std::unique_ptr< IOSSurface >	ios_surface,
		std::unique_ptr< Surface >	surface
	)

Definition at line 12 of file overlay_layer_pool.mm.

     : overlay_view(overlay_view),
       overlay_view_wrapper(overlay_view_wrapper),
       ios_surface(std::move(ios_surface)),
       surface(std::move(surface)){};

◆ ~OverlayLayer()

flutter::OverlayLayer::~OverlayLayer ( )

default

Member Function Documentation

◆ UpdateViewState()

void flutter::OverlayLayer::UpdateViewState	(	UIView *	flutter_view,
		SkRect	rect,
		int64_t	view_id,
		int64_t	overlay_id
	)

Definition at line 21 of file overlay_layer_pool.mm.

                                                        {
   auto screenScale = [UIScreen mainScreen].scale;
   // Set the size of the overlay view wrapper.
   // This wrapper view masks the overlay view.
   overlay_view_wrapper.frame = CGRectMake(rect.x() / screenScale, rect.y() / screenScale,
                                           rect.width() / screenScale, rect.height() / screenScale);
   // Set a unique view identifier, so the overlay_view_wrapper can be identified in XCUITests.
   overlay_view_wrapper.accessibilityIdentifier =
       [NSString stringWithFormat:@"platform_view[%lld].overlay[%lld]", view_id, overlay_id];
  
   // Set the size of the overlay view.
   // This size is equal to the device screen size.
   overlay_view.frame = [flutter_view convertRect:flutter_view.bounds toView:overlay_view_wrapper];
   // Set a unique view identifier, so the overlay_view can be identified in XCUITests.
   overlay_view.accessibilityIdentifier =
       [NSString stringWithFormat:@"platform_view[%lld].overlay_view[%lld]", view_id, overlay_id];
 }

References overlay_view, and overlay_view_wrapper.

Member Data Documentation

◆ did_submit_last_frame

bool flutter::OverlayLayer::did_submit_last_frame

Definition at line 36 of file overlay_layer_pool.h.

◆ ios_surface

std::unique_ptr<IOSSurface> flutter::OverlayLayer::ios_surface

Definition at line 32 of file overlay_layer_pool.h.

◆ overlay_view

UIView* flutter::OverlayLayer::overlay_view

Definition at line 30 of file overlay_layer_pool.h.

Referenced by UpdateViewState().

◆ overlay_view_wrapper

UIView* flutter::OverlayLayer::overlay_view_wrapper

Definition at line 31 of file overlay_layer_pool.h.

Referenced by UpdateViewState().

◆ surface

std::unique_ptr<Surface> flutter::OverlayLayer::surface

Definition at line 33 of file overlay_layer_pool.h.

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

shell/platform/darwin/ios/framework/Source/overlay_layer_pool.h
shell/platform/darwin/ios/framework/Source/overlay_layer_pool.mm

Public Member Functions

Public Attributes