impeller::KHRSwapchainVK Class Reference

A swapchain implemented backed by VK_KHR_swapchain and VK_KHR_surface. More...

#include <khr_swapchain_vk.h>

Inheritance diagram for impeller::KHRSwapchainVK:

Public Member Functions
	~KHRSwapchainVK ()
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. More...
Public Member Functions inherited from impeller::SwapchainVK
virtual	~SwapchainVK ()
	SwapchainVK (const SwapchainVK &)=delete
SwapchainVK &	operator= (const SwapchainVK &)=delete
virtual bool	IsValid () const =0
virtual std::unique_ptr< Surface >	AcquireNextDrawable ()=0
virtual vk::Format	GetSurfaceFormat () const =0
virtual void	UpdateSurfaceSize (const ISize &size)=0
	Mark the current swapchain configuration as dirty, forcing it to be recreated on the next frame. More...

Friends
class	SwapchainVK

Additional Inherited Members
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)
Protected Member Functions inherited from impeller::SwapchainVK
	SwapchainVK ()

Detailed Description

A swapchain implemented backed by VK_KHR_swapchain and VK_KHR_surface.

Definition at line 24 of file khr_swapchain_vk.h.

Constructor & Destructor Documentation

~KHRSwapchainVK()

impeller::KHRSwapchainVK::~KHRSwapchainVK ( )

default

Member Function Documentation

AcquireNextDrawable()

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

overridevirtual

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

Implements impeller::SwapchainVK.

Definition at line 42 of file khr_swapchain_vk.cc.

                                                           {
  if (!IsValid()) {
    return nullptr;
  }
 
  TRACE_EVENT0("impeller", __FUNCTION__);
 
  auto result = impl_->AcquireNextDrawable();
  if (!result.out_of_date && size_ == impl_->GetSize()) {
    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 = KHRSwapchainImplVK::Create(context,             //
                                             std::move(surface),  //
                                             size_,               //
                                             enable_msaa_,        //
                                             *old_swapchain       //
  );
  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();
}

GetSurfaceFormat()

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

overridevirtual

Implements impeller::SwapchainVK.

Definition at line 82 of file khr_swapchain_vk.cc.

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

IsValid()

bool impeller::KHRSwapchainVK::IsValid ( ) const

overridevirtual

Implements impeller::SwapchainVK.

Definition at line 32 of file khr_swapchain_vk.cc.

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

UpdateSurfaceSize()

void impeller::KHRSwapchainVK::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 36 of file khr_swapchain_vk.cc.

                                                        {
  // Update the size of the swapchain. On the next acquired drawable,
  // the sizes may no longer match, forcing the swapchain to be recreated.
  size_ = size;
}

Friends And Related Function Documentation

SwapchainVK

friend class SwapchainVK

friend

Definition at line 41 of file khr_swapchain_vk.h.

---

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

• impeller/renderer/backend/vulkan/swapchain/khr/khr_swapchain_vk.h
• impeller/renderer/backend/vulkan/swapchain/khr/khr_swapchain_vk.cc