impeller::android::HardwareBuffer Class Reference

A wrapper for AHardwareBuffer https://developer.android.com/ndk/reference/group/a-hardware-buffer. More...

#include <hardware_buffer.h>

Public Member Functions
	HardwareBuffer (HardwareBufferDescriptor descriptor)
	~HardwareBuffer ()
	HardwareBuffer (const HardwareBuffer &)=delete
HardwareBuffer &	operator= (const HardwareBuffer &)=delete
bool	IsValid () const
AHardwareBuffer *	GetHandle () const
const HardwareBufferDescriptor &	GetDescriptor () const
const AHardwareBuffer_Desc &	GetAndroidDescriptor () const
std::optional< uint64_t >	GetSystemUniqueID () const
	Get the system wide unique ID of the hardware buffer if possible. This is only available on Android API 31 and above. Within the process, the handle are unique.

Static Public Member Functions
static bool	IsAvailableOnPlatform ()
static std::optional< AHardwareBuffer_Desc >	Describe (AHardwareBuffer *buffer)
static std::optional< uint64_t >	GetSystemUniqueID (AHardwareBuffer *buffer)
	Get the system wide unique ID of the hardware buffer if possible. This is only available on Android API 31 and above. Within the process, the handle are unique.

Detailed Description

A wrapper for AHardwareBuffer https://developer.android.com/ndk/reference/group/a-hardware-buffer.

This wrapper creates and owns a handle to a managed hardware buffer. That is, there is no ability to take a reference to an externally created hardware buffer.

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

Definition at line 90 of file hardware_buffer.h.

Constructor & Destructor Documentation

HardwareBuffer() [1/2]

impeller::android::HardwareBuffer::HardwareBuffer ( HardwareBufferDescriptor  descriptor )

explicit

Definition at line 44 of file hardware_buffer.cc.

    : descriptor_(descriptor),
      android_descriptor_(ToAHardwareBufferDesc(descriptor_)) {
  if (!descriptor_.IsAllocatable()) {
    VALIDATION_LOG << "The hardware buffer descriptor is not allocatable.";
    return;
  }
  const auto& proc_table = GetProcTable();
 
  AHardwareBuffer* buffer = nullptr;
  if (auto result =
          proc_table.AHardwareBuffer_allocate(&android_descriptor_, &buffer);
      result != 0 || buffer == nullptr) {
    VALIDATION_LOG << "Could not allocate hardware buffer. Error: " << result;
    return;
  }
  buffer_.reset(buffer);
  is_valid_ = true;
}

~HardwareBuffer()

impeller::android::HardwareBuffer::~HardwareBuffer ( )

default

HardwareBuffer() [2/2]

impeller::android::HardwareBuffer::HardwareBuffer ( const HardwareBuffer &  )

delete

Member Function Documentation

Describe()

std::optional< AHardwareBuffer_Desc > impeller::android::HardwareBuffer::Describe ( AHardwareBuffer *  buffer )

static

Definition at line 114 of file hardware_buffer.cc.

                             {
  if (!buffer || !GetProcTable().AHardwareBuffer_describe) {
    return std::nullopt;
  }
  AHardwareBuffer_Desc desc = {};
  GetProcTable().AHardwareBuffer_describe(buffer, &desc);
  return desc;
}

GetAndroidDescriptor()

const AHardwareBuffer_Desc & impeller::android::HardwareBuffer::GetAndroidDescriptor

(

)

const

Definition at line 90 of file hardware_buffer.cc.

                                                                       {
  return android_descriptor_;
}

GetDescriptor()

const HardwareBufferDescriptor & impeller::android::HardwareBuffer::GetDescriptor

(

)

const

Definition at line 86 of file hardware_buffer.cc.

                                                                    {
  return descriptor_;
}

GetHandle()

AHardwareBuffer * impeller::android::HardwareBuffer::GetHandle

(

)

const

Definition at line 70 of file hardware_buffer.cc.

                                                 {
  return buffer_.get();
}

GetSystemUniqueID() [1/2]

std::optional< uint64_t > impeller::android::HardwareBuffer::GetSystemUniqueID

(

)

const

Get the system wide unique ID of the hardware buffer if possible. This is only available on Android API 31 and above. Within the process, the handle are unique.

Returns

The system unique id if one can be obtained.

Definition at line 98 of file hardware_buffer.cc.

                                                              {
  return GetSystemUniqueID(GetHandle());
}

GetSystemUniqueID() [2/2]

std::optional< uint64_t > impeller::android::HardwareBuffer::GetSystemUniqueID ( AHardwareBuffer *  buffer )

static

Get the system wide unique ID of the hardware buffer if possible. This is only available on Android API 31 and above. Within the process, the handle are unique.

Returns

The system unique id if one can be obtained.

Definition at line 102 of file hardware_buffer.cc.

                             {
  if (!GetProcTable().AHardwareBuffer_getId) {
    return std::nullopt;
  }
  uint64_t out_id = 0u;
  if (GetProcTable().AHardwareBuffer_getId(buffer, &out_id) != 0) {
    return std::nullopt;
  }
  return out_id;
}

IsAvailableOnPlatform()

bool impeller::android::HardwareBuffer::IsAvailableOnPlatform ( )

static

Definition at line 94 of file hardware_buffer.cc.

                                           {
  return GetProcTable().IsValid() && GetProcTable().AHardwareBuffer_isSupported;
}

IsValid()

bool impeller::android::HardwareBuffer::IsValid

(

)

const

Definition at line 66 of file hardware_buffer.cc.

                                   {
  return is_valid_;
}

operator=()

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

delete

---

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

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