impeller::AHBSwapchainVK Class Reference

The implementation of a swapchain that uses hardware buffers presented to a given surface control on Android. More...

#include <ahb_swapchain_vk.h>

Inheritance diagram for impeller::AHBSwapchainVK:

Public Member Functions
	~AHBSwapchainVK () override
	AHBSwapchainVK (const AHBSwapchainVK &)=delete
AHBSwapchainVK &	operator= (const AHBSwapchainVK &)=delete
bool	IsValid () const override
std::unique_ptr< Surface >	AcquireNextDrawable () override
vk::Format	GetSurfaceFormat () const override
void	UpdateSurfaceSize (const ISize &size) override
	Mark the current swapchain configuration as dirty, forcing it to be recreated on the next frame.
void	AddFinalCommandBuffer (std::shared_ptr< CommandBuffer > cmd_buffer) const override
Public Member Functions inherited from impeller::SwapchainVK
virtual	~SwapchainVK ()
	SwapchainVK (const SwapchainVK &)=delete
SwapchainVK &	operator= (const SwapchainVK &)=delete

Static Public Member Functions
static bool	IsAvailableOnPlatform ()
Static Public Member Functions inherited from impeller::SwapchainVK
static std::shared_ptr< SwapchainVK >	Create (const std::shared_ptr< Context > &context, vk::UniqueSurfaceKHR surface, const ISize &size, bool enable_msaa=true)

Friends
class	SwapchainVK

Additional Inherited Members
Protected Member Functions inherited from impeller::SwapchainVK
	SwapchainVK ()

Detailed Description

The implementation of a swapchain that uses hardware buffers presented to a given surface control on Android.

Warning

This swapchain implementation is not available on all Android versions supported by Flutter. Perform the IsAvailableOnPlatform check and fallback to KHR swapchains if this type of swapchain cannot be created. The available building blocks for these kinds of swapchains are only available on Android API levels >= 29.

Definition at line 29 of file ahb_swapchain_vk.h.

Constructor & Destructor Documentation

~AHBSwapchainVK()

impeller::AHBSwapchainVK::~AHBSwapchainVK ( )

overridedefault

AHBSwapchainVK()

impeller::AHBSwapchainVK::AHBSwapchainVK ( const AHBSwapchainVK &  )

delete

Member Function Documentation

AcquireNextDrawable()

std::unique_ptr< Surface > impeller::AHBSwapchainVK::AcquireNextDrawable ( )

overridevirtual

Implements impeller::SwapchainVK.

Definition at line 41 of file ahb_swapchain_vk.cc.

                                                           {
  if (!IsValid()) {
    return nullptr;
  }
 
  TRACE_EVENT0("impeller", __FUNCTION__);
  return impl_->AcquireNextDrawable();
}

References IsValid(), and TRACE_EVENT0.

AddFinalCommandBuffer()

void impeller::AHBSwapchainVK::AddFinalCommandBuffer ( std::shared_ptr< CommandBuffer >  cmd_buffer ) const

overridevirtual

Implements impeller::SwapchainVK.

Definition at line 58 of file ahb_swapchain_vk.cc.

                                                   {
  return impl_->AddFinalCommandBuffer(cmd_buffer);
}

GetSurfaceFormat()

vk::Format impeller::AHBSwapchainVK::GetSurfaceFormat ( ) const

overridevirtual

Implements impeller::SwapchainVK.

Definition at line 51 of file ahb_swapchain_vk.cc.

                                                {
  return IsValid()
             ? ToVKImageFormat(ToPixelFormat(impl_->GetDescriptor().format))
             : vk::Format::eUndefined;
}

References IsValid(), impeller::ToPixelFormat(), and impeller::ToVKImageFormat().

IsAvailableOnPlatform()

bool impeller::AHBSwapchainVK::IsAvailableOnPlatform ( )

static

Definition at line 15 of file ahb_swapchain_vk.cc.

                                           {
  return android::SurfaceControl::IsAvailableOnPlatform() &&
         android::HardwareBuffer::IsAvailableOnPlatform();
}

References impeller::android::HardwareBuffer::IsAvailableOnPlatform(), and impeller::android::SurfaceControl::IsAvailableOnPlatform().

IsValid()

bool impeller::AHBSwapchainVK::IsValid ( ) const

overridevirtual

Implements impeller::SwapchainVK.

Definition at line 36 of file ahb_swapchain_vk.cc.

                                   {
  return impl_ ? impl_->IsValid() : false;
}

Referenced by AcquireNextDrawable(), and GetSurfaceFormat().

operator=()

AHBSwapchainVK & impeller::AHBSwapchainVK::operator= ( const AHBSwapchainVK &  )

delete

UpdateSurfaceSize()

void impeller::AHBSwapchainVK::UpdateSurfaceSize ( const ISize &  size )

overridevirtual

Mark the current swapchain configuration as dirty, forcing it to be recreated on the next frame.

Implements impeller::SwapchainVK.

Definition at line 64 of file ahb_swapchain_vk.cc.

                                                        {
  if (impl_ && impl_->GetSize() == size) {
    return;
  }
  TRACE_EVENT0("impeller", __FUNCTION__);
  auto impl = AHBSwapchainImplVK::Create(context_,          //
                                         surface_control_,  //
                                         cb_,               //
                                         size,              //
                                         enable_msaa_       //
  );
  if (!impl || !impl->IsValid()) {
    VALIDATION_LOG << "Could not resize swapchain to size: " << size;
    return;
  }
  impl_ = std::move(impl);
}

References impeller::AHBSwapchainImplVK::Create(), TRACE_EVENT0, and VALIDATION_LOG.

Friends And Related Symbol Documentation

SwapchainVK

friend class SwapchainVK

friend

Definition at line 57 of file ahb_swapchain_vk.h.

---

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

• impeller/renderer/backend/vulkan/swapchain/ahb/ahb_swapchain_vk.h
• impeller/renderer/backend/vulkan/swapchain/ahb/ahb_swapchain_vk.cc