#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...

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

Protected Member Functions inherited from impeller::Context
	Context ()

Detailed Description

Definition at line 19 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 ( )

overridedefault

Member Function Documentation

◆ AcquireNextSurface()

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

Definition at line 70 of file surface_context_vk.cc.

                                                             {
   TRACE_EVENT0("impeller", __FUNCTION__);
   auto surface = swapchain_ ? swapchain_->AcquireNextDrawable() : nullptr;
   if (!surface) {
     return nullptr;
   }
   if (auto pipeline_library = parent_->GetPipelineLibrary()) {
     impeller::PipelineLibraryVK::Cast(*pipeline_library)
         .DidAcquireSurfaceFrame();
   }
   if (auto allocator = parent_->GetResourceAllocator()) {
     allocator->DidAcquireSurfaceFrame();
   }
   parent_->GetCommandPoolRecycler()->Dispose();
   return surface;
 }

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

◆ CreateCommandBuffer()

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

overridevirtual

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.

                                                                          {
   return parent_->CreateCommandBuffer();
 }

◆ DescribeGpuModel()

std::string impeller::SurfaceContextVK::DescribeGpuModel ( ) const

overridevirtual

Implements impeller::Context.

Definition at line 23 of file surface_context_vk.cc.

                                                    {
   return parent_->DescribeGpuModel();
 }

◆ GetBackendType()

Context::BackendType impeller::SurfaceContextVK::GetBackendType ( ) const

overridevirtual

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.

                                                           {
   return parent_->GetBackendType();
 }

◆ GetCapabilities()

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

overridevirtual

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.

           {
   return parent_->GetCapabilities();
 }

◆ GetPipelineLibrary()

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

overridevirtual

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.

                                                                           {
   return parent_->GetPipelineLibrary();
 }

◆ GetResourceAllocator()

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

overridevirtual

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.

                                                                       {
   return parent_->GetResourceAllocator();
 }

◆ GetSamplerLibrary()

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

overridevirtual

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.

                                                                         {
   return parent_->GetSamplerLibrary();
 }

◆ GetShaderLibrary()

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

overridevirtual

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.

                                                                       {
   return parent_->GetShaderLibrary();
 }

◆ IsValid()

bool impeller::SurfaceContextVK::IsValid ( ) const

overridevirtual

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.

                                      {
   return parent_->IsValid();
 }

◆ SetSyncPresentation()

void impeller::SurfaceContextVK::SetSyncPresentation ( bool value )

overridevirtual

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.

Reimplemented from impeller::Context.

Definition at line 87 of file surface_context_vk.cc.

                                                      {
   parent_->SetSyncPresentation(value);
 }

◆ SetWindowSurface()

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

Definition at line 60 of file surface_context_vk.cc.

                                                                   {
   auto swapchain = SwapchainVK::Create(parent_, std::move(surface));
   if (!swapchain) {
     VALIDATION_LOG << "Could not create swapchain.";
     return false;
   }
   swapchain_ = std::move(swapchain);
   return true;
 }

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

◆ Shutdown()

void impeller::SurfaceContextVK::Shutdown ( )

overridevirtual

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.

                                 {
   parent_->Shutdown();
 }

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SurfaceContextVK()

◆ ~SurfaceContextVK()

Member Function Documentation

◆ AcquireNextSurface()

◆ CreateCommandBuffer()

◆ DescribeGpuModel()

◆ GetBackendType()

◆ GetCapabilities()

◆ GetPipelineLibrary()

◆ GetResourceAllocator()

◆ GetSamplerLibrary()

◆ GetShaderLibrary()

◆ IsValid()

◆ SetSyncPresentation()

◆ SetWindowSurface()

◆ Shutdown()