The implementation of a swapchain at a specific size. Resizes to the surface will cause the instance of the swapchain impl at that size to be discarded along with all its caches and transients. More...

#include <ahb_swapchain_impl_vk.h>

Inheritance diagram for impeller::AHBSwapchainImplVK:

Public Member Functions
	~AHBSwapchainImplVK ()

	AHBSwapchainImplVK (const AHBSwapchainImplVK &)=delete

AHBSwapchainImplVK &	operator= (const AHBSwapchainImplVK &)=delete

const ISize &	GetSize () const

bool	IsValid () const

const android::HardwareBufferDescriptor &	GetDescriptor () const
	Get the descriptor used to create the hardware buffers that will be displayed on the surface control.

std::unique_ptr< Surface >	AcquireNextDrawable ()
	Acquire the next surface that can be used to present to the swapchain.

void	AddFinalCommandBuffer (std::shared_ptr< CommandBuffer > cmd_buffer)

Static Public Member Functions
static std::shared_ptr< AHBSwapchainImplVK >	Create (const std::weak_ptr< Context > &context, std::weak_ptr< android::SurfaceControl > surface_control, const CreateTransactionCB &cb, const ISize &size, bool enable_msaa)
	Create a swapchain of a specific size whose images will be presented to the provided surface control.

Detailed Description

The implementation of a swapchain at a specific size. Resizes to the surface will cause the instance of the swapchain impl at that size to be discarded along with all its caches and transients.

Definition at line 51 of file ahb_swapchain_impl_vk.h.

Constructor & Destructor Documentation

◆ ~AHBSwapchainImplVK()

impeller::AHBSwapchainImplVK::~AHBSwapchainImplVK ( )

Definition at line 108 of file ahb_swapchain_impl_vk.cc.

                                        {
  // Ensure that the Vulkan device is idle before destroying objects that the
  // device may have been using.
  WaitIdle();
}

◆ AHBSwapchainImplVK()

impeller::AHBSwapchainImplVK::AHBSwapchainImplVK ( const AHBSwapchainImplVK & )

delete

Member Function Documentation

◆ AcquireNextDrawable()

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

Acquire the next surface that can be used to present to the swapchain.

Returns: A surface if one can be created. If one cannot be created, it is likely due to resource exhaustion.

Definition at line 138 of file ahb_swapchain_impl_vk.cc.

                                                               {
  auto context = transients_->GetContext().lock();
  if (!context) {
    return nullptr;
  }
 
  frame_index_ = (frame_index_ + 1) % kMaxPendingPresents;
 
  if (!frame_data_[frame_index_]->WaitForFence(
          ContextVK::Cast(*context).GetDevice())) {
    return nullptr;
  }
 
  if (!is_valid_) {
    return nullptr;
  }
 
  auto pool_entry = pool_->Pop();
 
  if (!pool_entry.IsValid()) {
    VALIDATION_LOG << "Could not create AHB texture source.";
    return nullptr;
  }
 
  // Import the render ready semaphore that will block onscreen rendering until
  // it is ready.
  if (!ImportRenderReady(pool_entry.render_ready_fence, pool_entry.texture)) {
    VALIDATION_LOG << "Could wait on render ready fence.";
    return nullptr;
  }
 
#if IMPELLER_DEBUG
  if (context) {
    ContextVK::Cast(*context).GetGPUTracer()->MarkFrameStart();
  }
#endif  // IMPELLER_DEBUG
 
  auto surface = SurfaceVK::WrapSwapchainImage(
      transients_, pool_entry.texture,
      [weak = weak_from_this(), texture = pool_entry.texture]() {
        auto thiz = weak.lock();
        if (!thiz) {
          VALIDATION_LOG << "Swapchain died before image could be presented.";
          return false;
        }
        return thiz->Present(texture);
      });
 
  if (!surface) {
    return nullptr;
  }
 
  return surface;
}

References impeller::BackendCast< ContextVK, Context >::Cast(), context, impeller::ContextVK::GetDevice(), impeller::ContextVK::GetGPUTracer(), impeller::kMaxPendingPresents, surface, texture, VALIDATION_LOG, and impeller::SurfaceVK::WrapSwapchainImage().

◆ AddFinalCommandBuffer()

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

Definition at line 240 of file ahb_swapchain_impl_vk.cc.

                                             {
  frame_data_[frame_index_]->final_cmd_buffer = std::move(cmd_buffer);
}

◆ Create()

std::shared_ptr< AHBSwapchainImplVK > impeller::AHBSwapchainImplVK::Create	(	const std::weak_ptr< Context > &	context,
		std::weak_ptr< android::SurfaceControl >	surface_control,
		const CreateTransactionCB &	cb,
		const ISize &	size,
		bool	enable_msaa
	)

static

Create a swapchain of a specific size whose images will be presented to the provided surface control.

Parameters

[in]	context	The context whose allocators will be used to create swapchain image resources.
[in]	surface_control	The surface control to which the swapchain images will be presented.
[in]	size	The size of the swapchain images. This is constant for the lifecycle of the swapchain impl.
[in]	enable_msaa	If the swapchain images will be presented using a render target that enables MSAA. This allows for additional caching of transients.

Returns: A valid swapchain impl if one can be created. nullptr otherwise.

Definition at line 69 of file ahb_swapchain_impl_vk.cc.

                      {
  auto impl = std::shared_ptr<AHBSwapchainImplVK>(new AHBSwapchainImplVK(
      context, std::move(surface_control), cb, size, enable_msaa));
  return impl->IsValid() ? impl : nullptr;
}

References context.

Referenced by impeller::AHBSwapchainVK::UpdateSurfaceSize().

◆ GetDescriptor()

const android::HardwareBufferDescriptor & impeller::AHBSwapchainImplVK::GetDescriptor ( ) const

Get the descriptor used to create the hardware buffers that will be displayed on the surface control.

Returns: The descriptor.

Definition at line 122 of file ahb_swapchain_impl_vk.cc.

          {
  return desc_;
}

◆ GetSize()

const ISize & impeller::AHBSwapchainImplVK::GetSize ( ) const

Returns: The size of the swapchain images that will be displayed on the surface control.

Definition at line 114 of file ahb_swapchain_impl_vk.cc.

                                               {
  return desc_.size;
}

References impeller::android::HardwareBufferDescriptor::size.

◆ IsValid()

bool impeller::AHBSwapchainImplVK::IsValid ( ) const

Returns: If the swapchain impl is valid. If it is not, the instance must be discarded. There is no error recovery.

Definition at line 118 of file ahb_swapchain_impl_vk.cc.

                                       {
  return is_valid_;
}

◆ operator=()

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