impeller::android::SurfaceTransaction Class Reference

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

#include <surface_transaction.h>

Public Types
using	OnCompleteCallback = std::function< void(ASurfaceTransactionStats *)>

Public Member Functions
	SurfaceTransaction ()
	~SurfaceTransaction ()
	SurfaceTransaction (const SurfaceTransaction &)=delete
SurfaceTransaction &	operator= (const SurfaceTransaction &)=delete
	SurfaceTransaction (ASurfaceTransaction *transaction)
bool	IsValid () const
bool	SetContents (const SurfaceControl *control, const HardwareBuffer *buffer, fml::UniqueFD acquire_fence={})
	Encodes that the updated contents of a surface control are specified by the given hardware buffer. The update will not be committed till the call to Apply however.
bool	SetBackgroundColor (const SurfaceControl &control, const Color &color)
	Encodes the updated background color of the surface control. The update will not be committed till the call to Apply however.
bool	Apply (OnCompleteCallback callback=nullptr)
	Applies the updated encoded in the transaction and invokes the callback when the updated are complete.
bool	SetParent (const SurfaceControl &control, const SurfaceControl *new_parent=nullptr)
	Set the new parent control of the given control. If the new parent is null, it is removed from the control hierarchy.

Static Public Member Functions
static bool	IsAvailableOnPlatform ()

Detailed Description

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

A surface transaction is a collection of updates to the hierarchy of surfaces (represented by ASurfaceControl instances) that are applied atomically in the compositor.

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

Note

Transactions should be short lived objects (create, apply, collect). But, if these are used on multiple threads, they must be externally synchronized.

Definition at line 50 of file surface_transaction.h.

Member Typedef Documentation

OnCompleteCallback

using impeller::android::SurfaceTransaction::OnCompleteCallback = std::function<void(ASurfaceTransactionStats*)>

Definition at line 104 of file surface_transaction.h.

Constructor & Destructor Documentation

SurfaceTransaction() [1/3]

impeller::android::SurfaceTransaction::SurfaceTransaction

(

)

Definition at line 13 of file surface_transaction.cc.

    : transaction_(
          WrappedSurfaceTransaction{GetProcTable().ASurfaceTransaction_create(),
                                    /*owned=*/true}) {}

~SurfaceTransaction()

impeller::android::SurfaceTransaction::~SurfaceTransaction ( )

default

SurfaceTransaction() [2/3]

impeller::android::SurfaceTransaction::SurfaceTransaction ( const SurfaceTransaction &  )

delete

SurfaceTransaction() [3/3]

impeller::android::SurfaceTransaction::SurfaceTransaction ( ASurfaceTransaction *  transaction )

explicit

Definition at line 18 of file surface_transaction.cc.

    : transaction_(WrappedSurfaceTransaction{transaction, /*owned=*/false}) {}

Member Function Documentation

Apply()

bool impeller::android::SurfaceTransaction::Apply

(

OnCompleteCallback

callback = nullptr

)

Applies the updated encoded in the transaction and invokes the callback when the updated are complete.

Warning

The callback will be invoked on a system managed thread.

Note

It is fine to immediately destroy the transaction after the call to apply. It is not necessary to wait for transaction completion to collect the transaction handle.

Parameters

[in]

callback

The callback

Returns

true if the surface transaction was applied. true does not indicate the application was completed however. Only the invocation of the callback denotes transaction completion.

Definition at line 31 of file surface_transaction.cc.

                                                          {
  if (!IsValid()) {
    return false;
  }
 
  if (!callback) {
    callback = [](auto) {};
  }
 
  const auto& proc_table = GetProcTable();
 
  auto data = std::make_unique<TransactionInFlightData>();
  data->callback = callback;
  proc_table.ASurfaceTransaction_setOnComplete(
      transaction_.get().tx,  //
      data.release(),         //
      [](void* context, ASurfaceTransactionStats* stats) -> void {
        auto data = reinterpret_cast<TransactionInFlightData*>(context);
        data->callback(stats);
        delete data;
      });
  // If the transaction was created in Java, then it must be applied in
  // the Java PlatformViewController and not as a part of the engine render
  // loop.
  if (!transaction_.get().owned) {
    transaction_.reset();
    return true;
  }
 
  proc_table.ASurfaceTransaction_apply(transaction_.get().tx);
 
  // Transactions may not be applied over and over.
  transaction_.reset();
  return true;
}

References callback, data, impeller::android::GetProcTable(), and IsValid().

Referenced by impeller::android::SurfaceControl::RemoveFromParent(), and impeller::android::testing::TEST().

IsAvailableOnPlatform()

bool impeller::android::SurfaceTransaction::IsAvailableOnPlatform ( )

static

Returns

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

Definition at line 115 of file surface_transaction.cc.

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

References impeller::android::GetProcTable(), and impeller::android::ProcTable::IsValid().

Referenced by impeller::android::testing::TEST().

IsValid()

bool impeller::android::SurfaceTransaction::IsValid

(

)

const

Definition at line 23 of file surface_transaction.cc.

                                       {
  return transaction_.is_valid();
}

Referenced by Apply(), SetBackgroundColor(), SetParent(), and impeller::android::testing::TEST().

operator=()

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

delete

SetBackgroundColor()

bool impeller::android::SurfaceTransaction::SetBackgroundColor	(	const SurfaceControl &	control,
		const Color &	color
	)

Encodes the updated background color of the surface control. The update will not be committed till the call to Apply however.

See also

SurfaceTransaction::Apply.

Parameters

[in]	control	The control
[in]	color	The color

Returns

true if the background control will be set when transaction is applied.

Definition at line 83 of file surface_transaction.cc.

                                                                {
  if (!IsValid() || !control.IsValid()) {
    return false;
  }
  GetProcTable().ASurfaceTransaction_setColor(transaction_.get().tx,  //
                                              control.GetHandle(),    //
                                              color.red,              //
                                              color.green,            //
                                              color.blue,             //
                                              color.alpha,            //
                                              ADATASPACE_SRGB_LINEAR  //
  );
  return true;
}

References impeller::Color::alpha, impeller::Color::blue, impeller::android::SurfaceControl::GetHandle(), impeller::android::GetProcTable(), impeller::Color::green, impeller::android::SurfaceControl::IsValid(), IsValid(), and impeller::Color::red.

SetContents()

bool impeller::android::SurfaceTransaction::SetContents	(	const SurfaceControl *	control,
		const HardwareBuffer *	buffer,
		fml::UniqueFD	acquire_fence = {}
	)

Encodes that the updated contents of a surface control are specified by the given hardware buffer. The update will not be committed till the call to Apply however.

See also

SurfaceTransaction::Apply.

Parameters

[in]	control	The control.
[in]	buffer	The hardware buffer.
[in]	acquire_fence	The fence to wait on before setting the contents.

Returns

If the update was encoded in the transaction.

Definition at line 67 of file surface_transaction.cc.

                                                                {
  if (control == nullptr || buffer == nullptr) {
    VALIDATION_LOG << "Invalid control or buffer.";
    return false;
  }
  GetProcTable().ASurfaceTransaction_setBuffer(
      transaction_.get().tx,                                   //
      control->GetHandle(),                                    //
      buffer->GetHandle(),                                     //
      acquire_fence.is_valid() ? acquire_fence.release() : -1  //
  );
  return true;
}

References impeller::android::SurfaceControl::GetHandle(), impeller::android::GetProcTable(), fml::UniqueObject< T, Traits >::is_valid(), fml::UniqueObject< T, Traits >::release(), and VALIDATION_LOG.

SetParent()

bool impeller::android::SurfaceTransaction::SetParent	(	const SurfaceControl &	control,
		const SurfaceControl *	new_parent = nullptr
	)

Set the new parent control of the given control. If the new parent is null, it is removed from the control hierarchy.

Parameters

[in]	control	The control
[in]	new_parent	The new parent

Returns

true if the control will be re-parented when the transaction is applied.

Definition at line 99 of file surface_transaction.cc.

                                                                     {
  if (!IsValid() || !control.IsValid()) {
    return false;
  }
  if (new_parent && !new_parent->IsValid()) {
    return false;
  }
  GetProcTable().ASurfaceTransaction_reparent(
      transaction_.get().tx,                                     //
      control.GetHandle(),                                       //
      new_parent == nullptr ? nullptr : new_parent->GetHandle()  //
  );
  return true;
}

References impeller::android::SurfaceControl::GetHandle(), impeller::android::GetProcTable(), impeller::android::SurfaceControl::IsValid(), and IsValid().

Referenced by impeller::android::SurfaceControl::RemoveFromParent().

---

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

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