| Flutter Impeller |

Public Member Functions | List of all members
impeller::SurfaceContextVK Class Reference

`#include <surface_context_vk.h>`

Inheritance diagram for impeller::SurfaceContextVK:

## Public Member Functions
| SurfaceContextVK (const std::shared_ptr< ContextVK > &parent)
| ~SurfaceContextVK () override
BackendType | GetBackendType () const override
| Get the graphics backend of an Impeller context. More...
std::string | DescribeGpuModel () const override
bool | IsValid () const override
| Determines if a context is valid. If the caller ever receives an invalid context, they must discard it and construct a new context. There is no recovery mechanism to repair a bad context. More...
std::shared_ptr< Allocator > | GetResourceAllocator () const override
| Returns the allocator used to create textures and buffers on the device. More...
std::shared_ptr< ShaderLibrary > | GetShaderLibrary () const override
| Returns the library of shaders used to specify the programmable stages of a pipeline. More...
std::shared_ptr< SamplerLibrary > | GetSamplerLibrary () const override
| Returns the library of combined image samplers used in shaders. More...
std::shared_ptr< PipelineLibrary > | GetPipelineLibrary () const override
| Returns the library of pipelines used by render or compute commands. More...
std::shared_ptr< CommandBuffer > | CreateCommandBuffer () const override
| Create a new command buffer. Command buffers can be used to encode graphics, blit, or compute commands to be submitted to the device. More...
const std::shared_ptr< const Capabilities > & | GetCapabilities () const override
| Get the capabilities of Impeller context. All optionally supported feature of the platform, client-rendering API, and device can be queried using the `Capabilities`. More...
void | Shutdown () override
| Force all pending asynchronous work to finish. This is achieved by deleting all owned concurrent message loops. More...
void | SetSyncPresentation (bool value) override
| Force the Vulkan presentation (submitKHR) to be performed on the raster task runner. More...
bool | SetWindowSurface (vk::UniqueSurfaceKHR surface)
std::unique_ptr< Surface > | AcquireNextSurface ()
Public Member Functions inherited from impeller::Context
virtual | ~Context ()
| Destroys an Impeller context. More...
virtual bool | UpdateOffscreenLayerPixelFormat (PixelFormat format)
Pool< HostBuffer > & | GetHostBufferPool () const
| Accessor for a pool of HostBuffers. More...
virtual void | StoreTaskForGPU (const std::function< void()> &task)

## Additional Inherited Members
Public Types inherited from impeller::Context
enum | BackendType { BackendType::kMetal, BackendType::kOpenGLES, BackendType::kVulkan }
Static Public Member Functions inherited from impeller::BackendCast< SurfaceContextVK, Context >
static SurfaceContextVK & | Cast (Context &base)
static const SurfaceContextVK & | Cast (const Context &base)
static SurfaceContextVK * | Cast (Context *base)
static const SurfaceContextVK * | Cast (const Context *base)
Public Attributes inherited from impeller::Context
CaptureContext | capture
Static Public Attributes inherited from impeller::Context
static constexpr int32_t | kMaxTasksAwaitingGPU = 10
Protected Member Functions inherited from impeller::Context
| Context ()

## Detailed Description

Definition at line 20 of file surface_context_vk.h.

## Constructor & Destructor Documentation

## ◆ SurfaceContextVK()

impeller::SurfaceContextVK::SurfaceContextVK | ( | const std::shared_ptr< ContextVK > & | parent | ) |
| explicit

Definition at line 14 of file surface_context_vk.cc.

15 : parent_(parent) {}

## ◆ ~SurfaceContextVK()

impeller::SurfaceContextVK::~SurfaceContextVK | ( |  | ) |
| override default

## Member Function Documentation

## ◆ AcquireNextSurface()

std::unique_ptr< Surface > impeller::SurfaceContextVK::AcquireNextSurface | ( |  | ) |

Definition at line 74 of file surface_context_vk.cc.

74 {
75 TRACE_EVENT0("impeller", __FUNCTION__);
76 auto surface = swapchain_ ? swapchain_->AcquireNextDrawable() : nullptr;
77 if (!surface) {
78 return nullptr;
79 }
80 if (auto pipeline_library = parent_->GetPipelineLibrary()) {
81 impeller::PipelineLibraryVK::Cast(*pipeline_library)
82 .DidAcquireSurfaceFrame();
83 }
84 if (auto allocator = parent_->GetResourceAllocator()) {
85 allocator->DidAcquireSurfaceFrame();
86 }
87 parent_->GetCommandPoolRecycler()->Dispose();
88 return surface;
89 }

References impeller::BackendCast< PipelineLibraryVK, PipelineLibrary >::Cast(), and impeller::PipelineLibraryVK::DidAcquireSurfaceFrame().

## ◆ CreateCommandBuffer()

std::shared_ptr< CommandBuffer > impeller::SurfaceContextVK::CreateCommandBuffer | ( |  | ) | const
| override virtual

Create a new command buffer. Command buffers can be used to encode graphics, blit, or compute commands to be submitted to the device.

A command buffer can only be used on a single thread. Multi-threaded render, blit, or compute passes must create a new command buffer on each thread.

Returns
  A new command buffer.

Implements impeller::Context.

Definition at line 47 of file surface_context_vk.cc.

47 {
48 return parent_->CreateCommandBuffer();
49 }

## ◆ DescribeGpuModel()

std::string impeller::SurfaceContextVK::DescribeGpuModel | ( |  | ) | const
| override virtual

Implements impeller::Context.

Definition at line 23 of file surface_context_vk.cc.

23 {
24 return parent_->DescribeGpuModel();
25 }

## ◆ GetBackendType()

Context::BackendType impeller::SurfaceContextVK::GetBackendType | ( |  | ) | const
| override virtual

Get the graphics backend of an Impeller context.

            This is useful for cases where a renderer needs to track and
            lookup backend-specific resources, like shaders or uniform
            layout information.

            It's not recommended to use this as a substitute for
            per-backend capability checking. Instead, check for specific
            capabilities via `GetCapabilities()`.

Returns
  The graphics backend of the `Context`.

Implements impeller::Context.

Definition at line 19 of file surface_context_vk.cc.

19 {
20 return parent_->GetBackendType();
21 }

## ◆ GetCapabilities()

const std::shared_ptr< const Capabilities > & impeller::SurfaceContextVK::GetCapabilities | ( |  | ) | const
| override virtual

Get the capabilities of Impeller context. All optionally supported feature of the platform, client-rendering API, and device can be queried using the `Capabilities`.

Returns
  The capabilities. Can never be `nullptr` for a valid context.

Implements impeller::Context.

Definition at line 51 of file surface_context_vk.cc.

52 {
53 return parent_->GetCapabilities();
54 }

## ◆ GetPipelineLibrary()

std::shared_ptr< PipelineLibrary > impeller::SurfaceContextVK::GetPipelineLibrary | ( |  | ) | const
| override virtual

Returns the library of pipelines used by render or compute commands.

Returns
  The pipeline library. Can never be `nullptr` for a valid context.

Implements impeller::Context.

Definition at line 43 of file surface_context_vk.cc.

43 {
44 return parent_->GetPipelineLibrary();
45 }

## ◆ GetResourceAllocator()

std::shared_ptr< Allocator > impeller::SurfaceContextVK::GetResourceAllocator | ( |  | ) | const
| override virtual

Returns the allocator used to create textures and buffers on the device.

Returns
  The resource allocator. Can never be `nullptr` for a valid context.

Implements impeller::Context.

Definition at line 31 of file surface_context_vk.cc.

31 {
32 return parent_->GetResourceAllocator();
33 }

## ◆ GetSamplerLibrary()

std::shared_ptr< SamplerLibrary > impeller::SurfaceContextVK::GetSamplerLibrary | ( |  | ) | const
| override virtual

Returns the library of combined image samplers used in shaders.

Returns
  The sampler library. Can never be `nullptr` for a valid context.

Implements impeller::Context.

Definition at line 39 of file surface_context_vk.cc.

39 {
40 return parent_->GetSamplerLibrary();
41 }

## ◆ GetShaderLibrary()

std::shared_ptr< ShaderLibrary > impeller::SurfaceContextVK::GetShaderLibrary | ( |  | ) | const
| override virtual

Returns the library of shaders used to specify the programmable stages of a pipeline.

Returns
  The shader library. Can never be `nullptr` for a valid context.

Implements impeller::Context.

Definition at line 35 of file surface_context_vk.cc.

35 {
36 return parent_->GetShaderLibrary();
37 }

## ◆ IsValid()

bool impeller::SurfaceContextVK::IsValid | ( |  | ) | const
| override virtual

Determines if a context is valid. If the caller ever receives an invalid context, they must discard it and construct a new context. There is no recovery mechanism to repair a bad context.

It is convention in Impeller to never return an invalid context from a call that returns an pointer to a context. The call implementation performs validity checks itself and return a null context instead of a pointer to an invalid context.

How a context goes invalid is backend specific. It could happen due to device loss, or any other unrecoverable error.

Returns
  If the context is valid.

Implements impeller::Context.

Definition at line 27 of file surface_context_vk.cc.

27 {
28 return parent_->IsValid();
29 }

## ◆ SetSyncPresentation()

void impeller::SurfaceContextVK::SetSyncPresentation | ( | bool | value | ) |
| override virtual

Force the Vulkan presentation (submitKHR) to be performed on the raster task runner.

This is required for correct rendering on Android when using the hybrid composition mode. This has no effect on other backends. This is analogous to the check for isMainThread in surface_mtl.mm to block presentation on scheduling of all pending work.

Reimplemented from impeller::Context.

Definition at line 91 of file surface_context_vk.cc.

91 {
92 parent_->SetSyncPresentation(value);
93 }

## ◆ SetWindowSurface()

bool impeller::SurfaceContextVK::SetWindowSurface | ( | vk::UniqueSurfaceKHR | surface | ) |

Definition at line 60 of file surface_context_vk.cc.

60 {
61 auto swapchain = SwapchainVK::Create(parent_, std::move(surface));
62 if (!swapchain) {
63 VALIDATION_LOG << "Could not create swapchain.";
64 return false;
65 }
66 if (!swapchain->IsValid()) {
67 VALIDATION_LOG << "Could not create valid swapchain.";
68 return false;
69 }
70 swapchain_ = std::move(swapchain);
71 return true;
72 }

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

## ◆ Shutdown()

void impeller::SurfaceContextVK::Shutdown | ( |  | ) |
| override virtual

Force all pending asynchronous work to finish. This is achieved by deleting all owned concurrent message loops.

Implements impeller::Context.

Definition at line 56 of file surface_context_vk.cc.

56 {
57 parent_->Shutdown();
58 }

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

- impeller/renderer/backend/vulkan/surface_context_vk.h
- impeller/renderer/backend/vulkan/surface_context_vk.cc

impeller::SwapchainVK::Create
static std::shared_ptr< SwapchainVK > Create(const std::shared_ptr< Context > &context, vk::UniqueSurfaceKHR surface)
Definition: swapchain_vk.cc:13
impeller::PipelineLibraryVK::DidAcquireSurfaceFrame
void DidAcquireSurfaceFrame()
Definition: pipeline_library_vk.cc:727
VALIDATION_LOG
#define VALIDATION_LOG
Definition: validation.h:67
impeller::BackendCast< PipelineLibraryVK, PipelineLibrary >::Cast
static PipelineLibraryVK & Cast(PipelineLibrary &base)
Definition: backend_cast.h:15