#include <context_vk.h>

Inheritance diagram for impeller::ContextVK:

Classes
struct	Settings

Public Member Functions
uint64_t	GetHash () const

	~ContextVK () 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	GetSyncPresentation () const

void	SetOffscreenFormat (PixelFormat pixel_format)

template<typename T >
bool	SetDebugName (T handle, std::string_view label) const

std::shared_ptr< DeviceHolder >	GetDeviceHolder () const

vk::Instance	GetInstance () const

const vk::Device &	GetDevice () const

const std::shared_ptr< fml::ConcurrentTaskRunner >	GetConcurrentWorkerTaskRunner () const

const fml::RefPtr< fml::TaskRunner >	GetQueueSubmitRunner () const
	A single-threaded task runner that should only be used for submitKHR. More...

std::shared_ptr< SurfaceContextVK >	CreateSurfaceContext ()

const std::shared_ptr< QueueVK > &	GetGraphicsQueue () const

vk::PhysicalDevice	GetPhysicalDevice () const

std::shared_ptr< FenceWaiterVK >	GetFenceWaiter () const

std::shared_ptr< ResourceManagerVK >	GetResourceManager () const

std::shared_ptr< CommandPoolRecyclerVK >	GetCommandPoolRecycler () const

std::shared_ptr< DescriptorPoolRecyclerVK >	GetDescriptorPoolRecycler () const

std::shared_ptr< GPUTracerVK >	GetGPUTracer () const

void	RecordFrameEndTime () const

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)

Static Public Member Functions
static std::shared_ptr< ContextVK >	Create (Settings settings)

template<typename T >
static bool	SetDebugName (const vk::Device &device, T handle, std::string_view label)

Static Public Member Functions inherited from impeller::BackendCast< ContextVK, Context >
static ContextVK &	Cast (Context &base)

static const ContextVK &	Cast (const Context &base)

static ContextVK *	Cast (Context *base)

static const ContextVK *	Cast (const Context *base)

Additional Inherited Members
Public Types inherited from impeller::Context
enum	BackendType { BackendType::kMetal, BackendType::kOpenGLES, BackendType::kVulkan }

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 40 of file context_vk.h.

Constructor & Destructor Documentation

◆ ~ContextVK()

impeller::ContextVK::~ContextVK ( )

override

Definition at line 115 of file context_vk.cc.

                       {
   if (device_holder_ && device_holder_->device) {
     [[maybe_unused]] auto result = device_holder_->device->waitIdle();
   }
   CommandPoolRecyclerVK::DestroyThreadLocalPools(this);
 }

References impeller::CommandPoolRecyclerVK::DestroyThreadLocalPools().

Member Function Documentation

◆ Create()

std::shared_ptr< ContextVK > impeller::ContextVK::Create ( Settings settings )

static

Definition at line 95 of file context_vk.cc.

                                                             {
   auto context = std::shared_ptr<ContextVK>(new ContextVK());
   context->Setup(std::move(settings));
   if (!context->IsValid()) {
     return nullptr;
   }
   return context;
 }

Referenced by impeller::PlaygroundImplVK::PlaygroundImplVK().

◆ CreateCommandBuffer()

std::shared_ptr< CommandBuffer > impeller::ContextVK::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 490 of file context_vk.cc.

                                                                   {
   return std::shared_ptr<CommandBufferVK>(
       new CommandBufferVK(shared_from_this(),                     //
                           CreateGraphicsCommandEncoderFactory())  //
   );
 }

◆ CreateSurfaceContext()

std::shared_ptr< SurfaceContextVK > impeller::ContextVK::CreateSurfaceContext ( )

Definition at line 527 of file context_vk.cc.

                                                                 {
   return std::make_shared<SurfaceContextVK>(shared_from_this());
 }

◆ DescribeGpuModel()

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

overridevirtual

Implements impeller::Context.

Definition at line 466 of file context_vk.cc.

                                             {
   return device_name_;
 }

◆ GetBackendType()

Context::BackendType impeller::ContextVK::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 122 of file context_vk.cc.

                                                    {
   return Context::BackendType::kVulkan;
 }

References impeller::Context::kVulkan.

◆ GetCapabilities()

const std::shared_ptr< const Capabilities > & impeller::ContextVK::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 531 of file context_vk.cc.

                                                                           {
   return device_capabilities_;
 }

◆ GetCommandPoolRecycler()

std::shared_ptr< CommandPoolRecyclerVK > impeller::ContextVK::GetCommandPoolRecycler ( ) const

Definition at line 551 of file context_vk.cc.

           {
   return command_pool_recycler_;
 }

◆ GetConcurrentWorkerTaskRunner()

const std::shared_ptr< fml::ConcurrentTaskRunner > impeller::ContextVK::GetConcurrentWorkerTaskRunner ( ) const

Definition at line 510 of file context_vk.cc.

                                                {
   return raster_message_loop_->GetTaskRunner();
 }

◆ GetDescriptorPoolRecycler()

std::shared_ptr<DescriptorPoolRecyclerVK> impeller::ContextVK::GetDescriptorPoolRecycler ( ) const

inline

Definition at line 163 of file context_vk.h.

                                                                             {
     return descriptor_pool_recycler_;
   }

◆ GetDevice()

const vk::Device & impeller::ContextVK::GetDevice ( ) const

Definition at line 501 of file context_vk.cc.

                                            {
   return device_holder_->device.get();
 }

Referenced by impeller::AllocateAndBindDescriptorSets(), and SetDebugName().

◆ GetDeviceHolder()

std::shared_ptr<DeviceHolder> impeller::ContextVK::GetDeviceHolder ( ) const

inline

Definition at line 128 of file context_vk.h.

                                                       {
     return device_holder_;
   }

◆ GetFenceWaiter()

std::shared_ptr< FenceWaiterVK > impeller::ContextVK::GetFenceWaiter ( ) const

Definition at line 543 of file context_vk.cc.

                                                              {
   return fence_waiter_;
 }

◆ GetGPUTracer()

std::shared_ptr< GPUTracerVK > impeller::ContextVK::GetGPUTracer ( ) const

Definition at line 561 of file context_vk.cc.

                                                          {
   return gpu_tracer_;
 }

◆ GetGraphicsQueue()

const std::shared_ptr< QueueVK > & impeller::ContextVK::GetGraphicsQueue ( ) const

Definition at line 535 of file context_vk.cc.

                                                                 {
   return queues_.graphics_queue;
 }

References impeller::QueuesVK::graphics_queue.

◆ GetHash()

uint64_t impeller::ContextVK::GetHash ( ) const

inline

Definition at line 57 of file context_vk.h.

57 { return hash_; }

Referenced by impeller::CommandPoolRecyclerVK::DestroyThreadLocalPools().

◆ GetInstance()

vk::Instance impeller::ContextVK::GetInstance ( ) const

Definition at line 497 of file context_vk.cc.

                                         {
   return *device_holder_->instance;
 }

◆ GetPhysicalDevice()

vk::PhysicalDevice impeller::ContextVK::GetPhysicalDevice ( ) const

Definition at line 539 of file context_vk.cc.

                                                     {
   return device_holder_->physical_device;
 }

◆ GetPipelineLibrary()

std::shared_ptr< PipelineLibrary > impeller::ContextVK::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 486 of file context_vk.cc.

                                                                    {
   return pipeline_library_;
 }

◆ GetQueueSubmitRunner()

const fml::RefPtr< fml::TaskRunner > impeller::ContextVK::GetQueueSubmitRunner ( ) const

A single-threaded task runner that should only be used for submitKHR.

SubmitKHR will block until all previously submitted command buffers have been scheduled. If there are no platform views in the scene (excluding texture backed platform views). Then it is safe for SwapchainImpl::Present to return before submit has completed. To do so, we offload the submit command to a specialized single threaded task runner. The single thread ensures that we do not queue up too much work and that the submissions proceed in order.

Definition at line 505 of file context_vk.cc.

                                                                      {
   return queue_submit_thread_->GetTaskRunner();
 }

◆ GetResourceAllocator()

std::shared_ptr< Allocator > impeller::ContextVK::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 474 of file context_vk.cc.

                                                                {
   return allocator_;
 }

Referenced by impeller::AllocateAndBindDescriptorSets().

◆ GetResourceManager()

std::shared_ptr< ResourceManagerVK > impeller::ContextVK::GetResourceManager ( ) const

Definition at line 547 of file context_vk.cc.

                                                                      {
   return resource_manager_;
 }

◆ GetSamplerLibrary()

std::shared_ptr< SamplerLibrary > impeller::ContextVK::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 482 of file context_vk.cc.

                                                                  {
   return sampler_library_;
 }

◆ GetShaderLibrary()

std::shared_ptr< ShaderLibrary > impeller::ContextVK::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 478 of file context_vk.cc.

                                                                {
   return shader_library_;
 }

◆ GetSyncPresentation()

bool impeller::ContextVK::GetSyncPresentation ( ) const

inline

Definition at line 95 of file context_vk.h.

95 { return sync_presentation_; }

◆ IsValid()

bool impeller::ContextVK::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 470 of file context_vk.cc.

                               {
   return is_valid_;
 }

◆ RecordFrameEndTime()

void impeller::ContextVK::RecordFrameEndTime ( ) const

◆ SetDebugName() [1/2]

template<typename T >

static bool impeller::ContextVK::SetDebugName	(	const vk::Device &	device,
		T	handle,
		std::string_view	label
	)

inlinestatic

Definition at line 105 of file context_vk.h.

                                                  {
     if (!HasValidationLayers()) {
       // No-op if validation layers are not enabled.
       return true;
     }
  
     auto c_handle = static_cast<typename T::CType>(handle);
  
     vk::DebugUtilsObjectNameInfoEXT info;
     info.objectType = T::objectType;
     info.pObjectName = label.data();
     info.objectHandle = reinterpret_cast<decltype(info.objectHandle)>(c_handle);
  
     if (device.setDebugUtilsObjectNameEXT(info) != vk::Result::eSuccess) {
       VALIDATION_LOG << "Unable to set debug name: " << label;
       return false;
     }
  
     return true;
   }

References impeller::HasValidationLayers(), and VALIDATION_LOG.

◆ SetDebugName() [2/2]

template<typename T >

bool impeller::ContextVK::SetDebugName	(	T	handle,
		std::string_view	label
	)		const

inline

Definition at line 100 of file context_vk.h.

                                                           {
     return SetDebugName(GetDevice(), handle, label);
   }

References GetDevice().

Referenced by impeller::CreateCompatRenderPassForPipeline(), and impeller::QueuesVK::QueuesVK().

◆ SetOffscreenFormat()

void impeller::ContextVK::SetOffscreenFormat ( PixelFormat pixel_format )

Definition at line 461 of file context_vk.cc.

                                                            {
   CapabilitiesVK::Cast(*device_capabilities_).SetOffscreenFormat(pixel_format);
 }

References impeller::BackendCast< CapabilitiesVK, Capabilities >::Cast(), and impeller::CapabilitiesVK::SetOffscreenFormat().

◆ SetSyncPresentation()

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

inlineoverridevirtual

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 93 of file context_vk.h.

93 { sync_presentation_ = value; }

◆ Shutdown()

void impeller::ContextVK::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 514 of file context_vk.cc.

                          {
   // There are multiple objects, for example |CommandPoolVK|, that in their
   // destructors make a strong reference to |ContextVK|. Resetting these shared
   // pointers ensures that cleanup happens in a correct order.
   //
   // tl;dr: Without it, we get thread::join failures on shutdown.
   fence_waiter_.reset();
   resource_manager_.reset();
  
   queue_submit_thread_->Join();
   raster_message_loop_->Terminate();
 }

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

impeller/renderer/backend/vulkan/context_vk.h
impeller/renderer/backend/vulkan/context_vk.cc

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~ContextVK()

Member Function Documentation

◆ Create()

◆ CreateCommandBuffer()

◆ CreateSurfaceContext()

◆ DescribeGpuModel()

◆ GetBackendType()

◆ GetCapabilities()

◆ GetCommandPoolRecycler()

◆ GetConcurrentWorkerTaskRunner()

◆ GetDescriptorPoolRecycler()

◆ GetDevice()

◆ GetDeviceHolder()

◆ GetFenceWaiter()

◆ GetGPUTracer()

◆ GetGraphicsQueue()

◆ GetHash()

◆ GetInstance()

◆ GetPhysicalDevice()

◆ GetPipelineLibrary()

◆ GetQueueSubmitRunner()

◆ GetResourceAllocator()

◆ GetResourceManager()

◆ GetSamplerLibrary()

◆ GetShaderLibrary()

◆ GetSyncPresentation()

◆ IsValid()

◆ RecordFrameEndTime()

◆ SetDebugName() [1/2]

◆ SetDebugName() [2/2]

◆ SetOffscreenFormat()

◆ SetSyncPresentation()

◆ Shutdown()