impeller::android::SurfaceControl Class Reference

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

#include <surface_control.h>

Public Member Functions
	SurfaceControl (ANativeWindow *window, const char *debug_name=nullptr)
	Creates a new surface control and adds it as a child of the given window.
	~SurfaceControl ()
	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.
	SurfaceControl (const SurfaceControl &)=delete
SurfaceControl &	operator= (const SurfaceControl &)=delete
bool	IsValid () const
ASurfaceControl *	GetHandle () const
bool	RemoveFromParent () const
	Remove the surface control from the hierarchy of nodes presented by the system compositor.

Static Public Member Functions
static bool	IsAvailableOnPlatform ()

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 22 of file surface_control.h.

Constructor & Destructor Documentation

SurfaceControl() [1/2]

impeller::android::SurfaceControl::SurfaceControl ( ANativeWindow *  window, const char *  debug_name = nullptr  )

explicit

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 12 of file surface_control.cc.

                                                                            {
  if (window == nullptr) {
    VALIDATION_LOG << "Parent window of surface was null.";
    return;
  }
  if (debug_name == nullptr) {
    debug_name = "Impeller Layer";
  }
  control_.reset(
      GetProcTable().ASurfaceControl_createFromWindow(window, debug_name));
}

~SurfaceControl()

impeller::android::SurfaceControl::~SurfaceControl

(

)

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.

Definition at line 24 of file surface_control.cc.

                                {
  if (IsValid() && !RemoveFromParent()) {
    VALIDATION_LOG << "Surface control could not be removed from its parent. "
                      "Expect a leak.";
  }
}

SurfaceControl() [2/2]

impeller::android::SurfaceControl::SurfaceControl ( const SurfaceControl &  )

delete

Member Function Documentation

GetHandle()

ASurfaceControl * impeller::android::SurfaceControl::GetHandle

(

)

const

Definition at line 35 of file surface_control.cc.

                                                 {
  return control_.get();
}

IsAvailableOnPlatform()

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

static

Returns

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

Definition at line 50 of file surface_control.cc.

                                           {
  return GetProcTable().IsValid() &&
         GetProcTable().ASurfaceControl_createFromWindow.IsAvailable();
}

IsValid()

bool impeller::android::SurfaceControl::IsValid

(

)

const

Definition at line 31 of file surface_control.cc.

                                   {
  return control_.is_valid();
}

operator=()

SurfaceControl & impeller::android::SurfaceControl::operator= ( const SurfaceControl &  )

delete

RemoveFromParent()

bool impeller::android::SurfaceControl::RemoveFromParent

(

)

const

Remove the surface control from the hierarchy of nodes presented by the system compositor.

Returns

true If the control will be removed from the hierarchy of nodes presented by the system compositor.

Definition at line 39 of file surface_control.cc.

                                            {
  if (!IsValid()) {
    return false;
  }
  SurfaceTransaction transaction;
  if (!transaction.SetParent(*this, nullptr)) {
    return false;
  }
  return transaction.Apply();
}

---

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

• impeller/toolkit/android/surface_control.h
• impeller/toolkit/android/surface_control.cc