impeller::SwapchainVK Class Reference

A swapchain that adapts to the underlying surface going out of date. If the caller cannot acquire the next drawable, it is due to an unrecoverable error and the swapchain must be recreated with a new surface. More...

#include <swapchain_vk.h>

Public Member Functions
	~SwapchainVK ()
bool	IsValid () const
std::unique_ptr< Surface >	AcquireNextDrawable ()
vk::Format	GetSurfaceFormat () const

Static Public Member Functions
static std::shared_ptr< SwapchainVK >	Create (const std::shared_ptr< Context > &context, vk::UniqueSurfaceKHR surface)

Detailed Description

A swapchain that adapts to the underlying surface going out of date. If the caller cannot acquire the next drawable, it is due to an unrecoverable error and the swapchain must be recreated with a new surface.

Definition at line 25 of file swapchain_vk.h.

Constructor & Destructor Documentation

~SwapchainVK()

impeller::SwapchainVK::~SwapchainVK ( )

default

Member Function Documentation

AcquireNextDrawable()

std::unique_ptr< Surface > impeller::SwapchainVK::AcquireNextDrawable

(

)

We managed to recreate the swapchain in the new configuration. Try again.

Definition at line 33 of file swapchain_vk.cc.

                                                        {
  if (!IsValid()) {
    return nullptr;
  }
 
  TRACE_EVENT0("impeller", __FUNCTION__);
 
  auto result = impl_->AcquireNextDrawable();
  if (!result.out_of_date) {
    return std::move(result.surface);
  }
 
  TRACE_EVENT0("impeller", "RecreateSwapchain");
 
  // This swapchain implementation indicates that it is out of date. Tear it
  // down and make a new one.
  auto context = impl_->GetContext();
  auto [surface, old_swapchain] = impl_->DestroySwapchain();
 
  auto new_impl = SwapchainImplVK::Create(context,                   //
                                          std::move(surface),        //
                                          *old_swapchain,            //
                                          impl_->GetLastTransform()  //
  );
  if (!new_impl || !new_impl->IsValid()) {
    VALIDATION_LOG << "Could not update swapchain.";
    // The old swapchain is dead because we took its surface. This is
    // unrecoverable.
    impl_.reset();
    return nullptr;
  }
  impl_ = std::move(new_impl);
 
  //----------------------------------------------------------------------------
  /// We managed to recreate the swapchain in the new configuration. Try again.
  ///
  return AcquireNextDrawable();
}

References impeller::SwapchainImplVK::Create(), IsValid(), and VALIDATION_LOG.

Create()

std::shared_ptr< SwapchainVK > impeller::SwapchainVK::Create ( const std::shared_ptr< Context > &  context, vk::UniqueSurfaceKHR  surface  )

static

Definition at line 13 of file swapchain_vk.cc.

                                {
  auto impl = SwapchainImplVK::Create(context, std::move(surface));
  if (!impl || !impl->IsValid()) {
    VALIDATION_LOG << "Failed to create SwapchainVK implementation.";
    return nullptr;
  }
  return std::shared_ptr<SwapchainVK>(new SwapchainVK(std::move(impl)));
}

References impeller::SwapchainImplVK::Create(), and VALIDATION_LOG.

Referenced by impeller::SurfaceContextVK::SetWindowSurface().

GetSurfaceFormat()

vk::Format impeller::SwapchainVK::GetSurfaceFormat

(

)

const

Definition at line 72 of file swapchain_vk.cc.

                                             {
  return IsValid() ? impl_->GetSurfaceFormat() : vk::Format::eUndefined;
}

References IsValid().

IsValid()

bool impeller::SwapchainVK::IsValid

(

)

const

Definition at line 29 of file swapchain_vk.cc.

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

Referenced by AcquireNextDrawable(), and GetSurfaceFormat().

---

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

• impeller/renderer/backend/vulkan/swapchain_vk.h
• impeller/renderer/backend/vulkan/swapchain_vk.cc