A wrapper for ASurfaceControl. https://developer.android.com/ndk/reference/group/native-activity#asurfacecontrol. More...

#include <surface_control.h>

Inheritance diagram for impeller::android::SurfaceControl:

Public Member Functions
virtual	~SurfaceControl ()=default
	Removes the surface control from the presentation hierarchy managed by the system compositor and release the client side reference to the control. At this point, it may be collected when the compositor is also done using it.

virtual bool	IsValid () const =0

virtual ASurfaceControl *	GetHandle () const =0

virtual bool	RemoveFromParent () const =0
	Remove the surface control from the hierarchy of nodes presented by the system compositor.

Static Public Member Functions
static bool	IsAvailableOnPlatform ()

static std::unique_ptr< SurfaceControl >	Create (ANativeWindow window, const char debug_name=nullptr)
	Creates a new surface control and adds it as a child of the given window.

Detailed Description

A wrapper for ASurfaceControl. https://developer.android.com/ndk/reference/group/native-activity#asurfacecontrol.

Instances of this class represent a node in the hierarchy of surfaces sent to the system compositor for final composition.

This wrapper is only available on Android API 29 and above.

Definition at line 23 of file surface_control.h.

Constructor & Destructor Documentation

◆ ~SurfaceControl()

virtual impeller::android::SurfaceControl::~SurfaceControl ( )

virtualdefault

Removes the surface control from the presentation hierarchy managed by the system compositor and release the client side reference to the control. At this point, it may be collected when the compositor is also done using it.

Member Function Documentation

◆ Create()

std::unique_ptr< SurfaceControl > impeller::android::SurfaceControl::Create	(	ANativeWindow *	window,
		const char *	debug_name = `nullptr`
	)

static

Creates a new surface control and adds it as a child of the given window.

Parameters

	window	The window
[in]	debug_name	A debug name. See it using `adb shell dumpsys SurfaceFlinger` along with other control properties. If no debug name is specified, the value "Impeller Layer" is used.

Definition at line 13 of file surface_control.cc.

                                                                               {
  return std::unique_ptr<SurfaceControl>(
      new SurfaceControlImpl(window, debug_name));
}

References window.

◆ GetHandle()

virtual ASurfaceControl * impeller::android::SurfaceControl::GetHandle ( ) const

pure virtual

Implemented in impeller::android::testing::FakeSurfaceControl, and impeller::android::SurfaceControlImpl.

Referenced by impeller::android::CreatePreviousReleaseFence(), impeller::android::SurfaceTransaction::SetBackgroundColor(), impeller::android::SurfaceTransaction::SetContents(), and impeller::android::SurfaceTransaction::SetParent().

◆ IsAvailableOnPlatform()

bool impeller::android::SurfaceControl::IsAvailableOnPlatform ( )

static

Returns: true if any surface controls can be created on this platform.

Definition at line 19 of file surface_control.cc.

                                           {
  auto api_level = android_get_device_api_level();
 
  // Technically SurfaceControl is supported on API 29 but I've observed
  // enough reported bugs that I'm bumping the constraint to 30. If
  // we had more time to test all of these older devices maybe we could
  // figure out what the problem is.
  // https://github.com/flutter/flutter/issues/155877
  return api_level >= 29 && GetProcTable().IsValid() &&
         GetProcTable().ASurfaceControl_createFromWindow.IsAvailable();
}