| Flutter Impeller |

Classes | Public Member Functions | Static Public Member Functions | List of all members
impeller::AHBSwapchainImplVK Class Referencefinal

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. More...
std::unique_ptr< Surface > | AcquireNextDrawable ()
| Acquire the next surface that can be used to present to the swapchain. More...
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 ISize &size, bool enable_msaa, size_t swapchain_image_count)
| Create a swapchain of a specific size whose images will be presented to the provided surface control. More...

## 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 30 of file ahb_swapchain_impl_vk.h.

## Constructor & Destructor Documentation

## ◆ ~AHBSwapchainImplVK()

impeller::AHBSwapchainImplVK::~AHBSwapchainImplVK | ( |  | ) |
| default

## ◆ AHBSwapchainImplVK()

impeller::AHBSwapchainImplVK::AHBSwapchainImplVK | ( | const AHBSwapchainImplVK & |  | ) |
| delete

Referenced by Create().

## 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 87 of file ahb_swapchain_impl_vk.cc.

87 {
88 {
89 TRACE_EVENT0("impeller", "CompositorPendingWait");
90 if (!pending_presents_->Wait()) {
91 return nullptr;
92 }
93 }
94
95 frame_index_ = (frame_index_ + 1) % kMaxPendingPresents;
96 AutoSemaSignaler auto_sema_signaler =
97 std::make_shared<fml::ScopedCleanupClosure>(
98 [sema = pending_presents_]() { sema->Signal(); });
99
100 if (!is_valid_) {
101 return nullptr;
102 }
103
104 auto pool_entry = pool_->Pop();
105
106 if (!pool_entry.IsValid()) {
107 VALIDATION_LOG << "Could not create AHB texture source.";
108 return nullptr;
109 }
110
111 // Import the render ready semaphore that will block onscreen rendering until
112 // it is ready.
113 if (!SubmitWaitForRenderReady(pool_entry.render_ready_fence,
114 pool_entry.texture)) {
115 VALIDATION_LOG << "Could wait on render ready fence.";
116 return nullptr;
117 }
118
119 #if IMPELLER_DEBUG
120 auto context = transients_->GetContext().lock();
121 if (context) {
122 ContextVK::Cast(*context).GetGPUTracer()->MarkFrameStart();
123 }
124 #endif // IMPELLER_DEBUG
125
126 auto surface = SurfaceVK::WrapSwapchainImage(
127 transients_, pool_entry.texture,
128 [signaler = auto_sema_signaler, weak = weak_from_this(),
129 texture = pool_entry.texture]() {
130 auto thiz = weak.lock();
131 if (!thiz) {
132 VALIDATION_LOG << "Swapchain died before image could be presented.";
133 return false;
134 }
135 return thiz->Present(signaler, texture);
136 });
137
138 if (!surface) {
139 return nullptr;
140 }
141
142 return surface;
143 }

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

## ◆ AddFinalCommandBuffer()

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

Definition at line 192 of file ahb_swapchain_impl_vk.cc.

193 {
194 frame_data_[frame_index_].command_buffer = std::move(cmd_buffer);
195 }

## ◆ Create()

std::shared_ptr< AHBSwapchainImplVK > impeller::AHBSwapchainImplVK::Create | ( | const std::weak_ptr< Context > & | context,
|  | std::weak_ptr< android::SurfaceControl > | surface_control,
|  | const ISize & | size,
|  | bool | enable_msaa,
|  | size_t | swapchain_image_count
| ) |  |
| 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 39 of file ahb_swapchain_impl_vk.cc.

44 {
45 auto impl = std::shared_ptr<AHBSwapchainImplVK>(
46 new AHBSwapchainImplVK(context, std::move(surface_control), size,
47 enable_msaa, swapchain_image_count));
48 return impl->IsValid() ? impl : nullptr;
49 }

References AHBSwapchainImplVK().

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 82 of file ahb_swapchain_impl_vk.cc.

83 {
84 return desc_;
85 }

## ◆ 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 74 of file ahb_swapchain_impl_vk.cc.

74 {
75 return desc_.size;
76 }

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 78 of file ahb_swapchain_impl_vk.cc.

78 {
79 return is_valid_;
80 }

## ◆ operator=()

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

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

- impeller/renderer/backend/vulkan/swapchain/ahb/ahb_swapchain_impl_vk.h
- impeller/renderer/backend/vulkan/swapchain/ahb/ahb_swapchain_impl_vk.cc

impeller::SurfaceVK::WrapSwapchainImage
static std::unique_ptr< SurfaceVK > WrapSwapchainImage(const std::shared_ptr< SwapchainTransientsVK > &transients, const std::shared_ptr< TextureSourceVK > &swapchain_image, SwapCallback swap_callback)
Wrap the swapchain image in a Surface, which provides the additional configuration required for usage...
Definition: surface_vk.cc:13
impeller::kMaxPendingPresents
static constexpr const size_t kMaxPendingPresents
Definition: ahb_swapchain_impl_vk.cc:23
impeller::AHBSwapchainImplVK::AHBSwapchainImplVK
AHBSwapchainImplVK(const AHBSwapchainImplVK &)=delete
impeller::ContextVK::GetGPUTracer
std::shared_ptr< GPUTracerVK > GetGPUTracer() const
Definition: context_vk.cc:637
impeller::android::HardwareBufferDescriptor::size
ISize size
Definition: hardware_buffer.h:49
VALIDATION_LOG
#define VALIDATION_LOG
Definition: validation.h:91
impeller::BackendCast< ContextVK, Context >::Cast
static ContextVK & Cast(Context &base)
Definition: backend_cast.h:13