#include <context_vk.h>

Inheritance diagram for impeller::ContextVK:

Classes
struct	EmbedderData
	Embedder Stuff. More...

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

virtual bool	SubmitOnscreen (std::shared_ptr< CommandBuffer > cmd_buffer) override
	Submit the command buffer that renders to the onscreen surface. More...

const std::shared_ptr< YUVConversionLibraryVK > &	GetYUVConversionLibrary () const

void	Shutdown () override
	Force all pending asynchronous work to finish. This is achieved by deleting all owned concurrent message loops. More...

const WorkaroundsVK &	GetWorkarounds () const

void	SetOffscreenFormat (PixelFormat pixel_format)

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

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

std::shared_ptr< DeviceHolderVK >	GetDeviceHolder () const

vk::Instance	GetInstance () const

const vk::Device &	GetDevice () const

const std::unique_ptr< DriverInfoVK > &	GetDriverInfo () const

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

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< CommandQueue >	GetCommandQueue () const override
	Return the graphics queue for submitting command buffers. More...

std::shared_ptr< GPUTracerVK >	GetGPUTracer () const

void	RecordFrameEndTime () const

void	InitializeCommonlyUsedShadersIfNeeded () const override

void	DisposeThreadLocalCachedResources () override

bool	GetShouldEnableSurfaceControlSwapchain () const
	Whether the Android Surface control based swapchain should be enabled. More...

bool	EnqueueCommandBuffer (std::shared_ptr< CommandBuffer > command_buffer) override
	Enqueue command_buffer for submission by the end of the frame. More...

bool	FlushCommandBuffers () override
	Flush all pending command buffers. More...

bool	FinishQueue () override
	Wait until all previously submitted command buffers are processed and displayed by the GPU. More...

RuntimeStageBackend	GetRuntimeStageBackend () const override
	Retrieve the runtime stage for this context type. More...

std::shared_ptr< const IdleWaiter >	GetIdleWaiter () const override

Public Member Functions inherited from impeller::Context
virtual	~Context ()
	Destroys an Impeller context. More...

virtual bool	UpdateOffscreenLayerPixelFormat (PixelFormat format)

virtual void	StoreTaskForGPU (const fml::closure &task, const fml::closure &failure)

virtual bool	AddTrackingFence (const std::shared_ptr< Texture > &texture) const

virtual void	ResetThreadLocalState () const

const Flags &	GetFlags () const

Static Public Member Functions
static size_t	ChooseThreadCountForWorkers (size_t hardware_concurrency)

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 class	BackendType { kMetal , kOpenGLES , kVulkan }

Static Public Attributes inherited from impeller::Context
static constexpr int32_t	kMaxTasksAwaitingGPU = 1024

Protected Member Functions inherited from impeller::Context
	Context (const Flags &flags)

Protected Attributes inherited from impeller::Context
Flags	flags_

std::vector< std::function< void()> >	per_frame_task_

Detailed Description

Definition at line 64 of file context_vk.h.

Constructor & Destructor Documentation

◆ ~ContextVK()

impeller::ContextVK::~ContextVK ( )

override

Definition at line 131 of file context_vk.cc.

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

Member Function Documentation

◆ ChooseThreadCountForWorkers()

size_t impeller::ContextVK::ChooseThreadCountForWorkers ( size_t hardware_concurrency )

static

Choose the number of worker threads the context_vk will create.

Visible for testing.

Definition at line 115 of file context_vk.cc.

                                                                          {
   // Never create more than 4 worker threads. Attempt to use up to
   // half of the available concurrency.
   return std::clamp(hardware_concurrency / 2ull, /*lo=*/1ull, /*hi=*/4ull);
 }

Referenced by impeller::testing::TEST().

◆ Create()

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

static

Definition at line 105 of file context_vk.cc.

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

References context, and impeller::ContextVK::Settings::flags.

Referenced by impeller::interop::ContextVK::Create(), impeller::android::testing::CreateContext(), and 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 539 of file context_vk.cc.

                                                                   {
   const auto& recycler = GetCommandPoolRecycler();
   auto tls_pool = recycler->Get();
   if (!tls_pool) {
     return nullptr;
   }
  
   // look up a cached descriptor pool for the current frame and reuse it
   // if it exists, otherwise create a new pool.
   std::shared_ptr<DescriptorPoolVK> descriptor_pool;
   {
     Lock lock(desc_pool_mutex_);
     DescriptorPoolMap::iterator current_pool =
         cached_descriptor_pool_.find(std::this_thread::get_id());
     if (current_pool == cached_descriptor_pool_.end()) {
       descriptor_pool = (cached_descriptor_pool_[std::this_thread::get_id()] =
                              descriptor_pool_recycler_->GetDescriptorPool());
     } else {
       descriptor_pool = current_pool->second;
     }
   }
  
   auto tracked_objects = std::make_shared<TrackedObjectsVK>(
       weak_from_this(), std::move(tls_pool), std::move(descriptor_pool),
       GetGPUTracer()->CreateGPUProbe());
   auto queue = GetGraphicsQueue();
  
   if (!tracked_objects || !tracked_objects->IsValid() || !queue) {
     return nullptr;
   }
  
   vk::CommandBufferBeginInfo begin_info;
   begin_info.flags = vk::CommandBufferUsageFlagBits::eOneTimeSubmit;
   if (tracked_objects->GetCommandBuffer().begin(begin_info) !=
       vk::Result::eSuccess) {
     VALIDATION_LOG << "Could not begin command buffer.";
     return nullptr;
   }
  
   tracked_objects->GetGPUProbe().RecordCmdBufferStart(
       tracked_objects->GetCommandBuffer());
  
   return std::shared_ptr<CommandBufferVK>(new CommandBufferVK(
       shared_from_this(),         //
       std::move(tracked_objects)  //
       ));
 }

References GetCommandPoolRecycler(), GetGPUTracer(), GetGraphicsQueue(), and VALIDATION_LOG.

◆ CreateSurfaceContext()

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

Definition at line 612 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 515 of file context_vk.cc.

                                             {
   return device_name_;
 }

◆ DisposeThreadLocalCachedResources()

void impeller::ContextVK::DisposeThreadLocalCachedResources ( )

overridevirtual

Dispose resources that are cached on behalf of the current thread.

Some backends such as Vulkan may cache resources that can be reused while executing a rendering operation. This API can be called after the operation completes in order to clear the cache.

Reimplemented from impeller::Context.

Definition at line 726 of file context_vk.cc.

                                                   {
   {
     Lock lock(desc_pool_mutex_);
     cached_descriptor_pool_.erase(std::this_thread::get_id());
   }
   command_pool_recycler_->Dispose();
 }

◆ EnqueueCommandBuffer()

bool impeller::ContextVK::EnqueueCommandBuffer ( std::shared_ptr< CommandBuffer > command_buffer )

overridevirtual

Enqueue command_buffer for submission by the end of the frame.

Certain backends may immediately flush the command buffer if batch submission is not supported. This functionality is not thread safe and should only be used via the ContentContext for rendering a 2D workload.

Returns true if submission has succeeded. If the buffer is enqueued then no error may be returned until FlushCommandBuffers is called.

Reimplemented from impeller::Context.

Definition at line 654 of file context_vk.cc.

                                                  {
   if (should_batch_cmd_buffers_) {
     pending_command_buffers_.push_back(std::move(command_buffer));
     return true;
   } else {
     return GetCommandQueue()->Submit({command_buffer}).ok();
   }
 }

References command_buffer, and GetCommandQueue().

Referenced by SubmitOnscreen().

◆ FinishQueue()

bool impeller::ContextVK::FinishQueue ( )

overridevirtual

Wait until all previously submitted command buffers are processed and displayed by the GPU.

WARNING: This method call is unnecessary for nearly all use cases since asynchronous workloads are the expected norm and calling this method can negatively affect application performance. Its only use is for cases like benchmarking where proper performance metrics can only be collected by including all background processing of the GPU.

Outstanding unflushed command buffers are not committed, submitted, or enqueued by this method and such buffers should have already been flushed before this method is called. The method will only wait for work to be done that has already been submitted to the GPU.

Returns: True if the queue was successfully processed, otherwise false if there was an error or if the backend does not support synchronous reporting of completion. Implementations intended entirely for testing might simply return false, but they would not be used for benchmarking or other situations where we might measure GPU performance.

Implements impeller::Context.

Definition at line 678 of file context_vk.cc.

                             {
   GetIdleWaiter()->WaitIdle();
   return true;
 }

References GetIdleWaiter().

◆ FlushCommandBuffers()

bool impeller::ContextVK::FlushCommandBuffers ( )

overridevirtual

Flush all pending command buffers.

Returns whether or not submission was successful. This functionality is not threadsafe and should only be used via the ContentContext for rendering a 2D workload.

Reimplemented from impeller::Context.

Definition at line 664 of file context_vk.cc.

                                     {
   if (pending_command_buffers_.empty()) {
     return true;
   }
  
   if (should_batch_cmd_buffers_) {
     bool result = GetCommandQueue()->Submit(pending_command_buffers_).ok();
     pending_command_buffers_.clear();
     return result;
   } else {
     return true;
   }
 }

References GetCommandQueue().

◆ 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 140 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 616 of file context_vk.cc.

                                                                           {
   return device_capabilities_;
 }

◆ GetCommandPoolRecycler()

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

Definition at line 636 of file context_vk.cc.

           {
   return command_pool_recycler_;
 }

Referenced by CreateCommandBuffer().

◆ GetCommandQueue()

std::shared_ptr< CommandQueue > impeller::ContextVK::GetCommandQueue ( ) const

overridevirtual

Return the graphics queue for submitting command buffers.

Implements impeller::Context.

Definition at line 650 of file context_vk.cc.

                                                              {
   return command_queue_vk_;
 }

Referenced by EnqueueCommandBuffer(), and FlushCommandBuffers().

◆ GetConcurrentWorkerTaskRunner()

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

Definition at line 596 of file context_vk.cc.

                                                {
   return raster_message_loop_->GetTaskRunner();
 }

◆ GetDescriptorPoolRecycler()

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

Definition at line 645 of file context_vk.cc.

           {
   return descriptor_pool_recycler_;
 }

◆ GetDevice()

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

Definition at line 591 of file context_vk.cc.

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

Referenced by impeller::AHBSwapchainImplVK::AcquireNextDrawable(), impeller::DescriptorPoolVK::AllocateDescriptorSets(), InitializeCommonlyUsedShadersIfNeeded(), and SetDebugName().

◆ GetDeviceHolder()

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

inline

Definition at line 191 of file context_vk.h.

                                                         {
     return device_holder_;
   }

◆ GetDriverInfo()

const std::unique_ptr< DriverInfoVK > & impeller::ContextVK::GetDriverInfo ( ) const

Definition at line 739 of file context_vk.cc.

                                                                   {
   return driver_info_;
 }

◆ GetFenceWaiter()

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

Definition at line 628 of file context_vk.cc.

                                                              {
   return fence_waiter_;
 }

◆ GetGPUTracer()

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

Definition at line 641 of file context_vk.cc.

                                                          {
   return gpu_tracer_;
 }

Referenced by impeller::AHBSwapchainImplVK::AcquireNextDrawable(), and CreateCommandBuffer().

◆ GetGraphicsQueue()

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

Definition at line 620 of file context_vk.cc.

                                                                 {
   return queues_.graphics_queue;
 }

References impeller::QueuesVK::graphics_queue.

Referenced by CreateCommandBuffer().

◆ GetHash()

uint64_t impeller::ContextVK::GetHash ( ) const

inline

Definition at line 104 of file context_vk.h.

104 { return hash_; }

◆ GetIdleWaiter()

std::shared_ptr<const IdleWaiter> impeller::ContextVK::GetIdleWaiter ( ) const

inlineoverridevirtual

Reimplemented from impeller::Context.

Definition at line 246 of file context_vk.h.

                                                                  {
     return idle_waiter_vk_;
   }

Referenced by FinishQueue().

◆ GetInstance()

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

Definition at line 587 of file context_vk.cc.

                                         {
   return *device_holder_->instance;
 }

Referenced by impeller::interop::SwapchainVK::SwapchainVK().

◆ GetPhysicalDevice()

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

Definition at line 624 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 535 of file context_vk.cc.

                                                                    {
   return pipeline_library_;
 }

◆ 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 523 of file context_vk.cc.

                                                                {
   return allocator_;
 }

Referenced by InitializeCommonlyUsedShadersIfNeeded().

◆ GetResourceManager()

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

Definition at line 632 of file context_vk.cc.

                                                                      {
   return resource_manager_;
 }

◆ GetRuntimeStageBackend()

RuntimeStageBackend impeller::ContextVK::GetRuntimeStageBackend ( ) const

overridevirtual

Retrieve the runtime stage for this context type.

This is used by the engine shell and other subsystems for loading the correct shader types.

Implements impeller::Context.

Definition at line 749 of file context_vk.cc.

                                                             {
   return RuntimeStageBackend::kVulkan;
 }

References impeller::kVulkan.

◆ 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 531 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 527 of file context_vk.cc.

                                                                {
   return shader_library_;
 }

◆ GetShouldEnableSurfaceControlSwapchain()

bool impeller::ContextVK::GetShouldEnableSurfaceControlSwapchain ( ) const

Whether the Android Surface control based swapchain should be enabled.

Definition at line 743 of file context_vk.cc.

                                                              {
   return should_enable_surface_control_ &&
          CapabilitiesVK::Cast(*device_capabilities_)
              .SupportsExternalSemaphoreExtensions();
 }

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

◆ GetWorkarounds()

const WorkaroundsVK & impeller::ContextVK::GetWorkarounds ( ) const

Definition at line 757 of file context_vk.cc.

                                                      {
   return workarounds_;
 }

◆ GetYUVConversionLibrary()

const std::shared_ptr< YUVConversionLibraryVK > & impeller::ContextVK::GetYUVConversionLibrary ( ) const

Definition at line 735 of file context_vk.cc.

                                          {
   return yuv_conversion_library_;
 }

◆ InitializeCommonlyUsedShadersIfNeeded()

void impeller::ContextVK::InitializeCommonlyUsedShadersIfNeeded ( ) const

overridevirtual

Run backend specific additional setup and create common shader variants.

This bootstrap is intended to improve the performance of several first frame benchmarks that are tracked in the flutter device lab. The workload includes initializing commonly used but not default shader variants, as well as forcing driver initialization.

Reimplemented from impeller::Context.

Definition at line 686 of file context_vk.cc.

                                                             {
   RenderTargetAllocator rt_allocator(GetResourceAllocator());
   RenderTarget render_target =
       rt_allocator.CreateOffscreenMSAA(*this, {1, 1}, 1);
  
   RenderPassBuilderVK builder;
  
   render_target.IterateAllColorAttachments(
       [&builder](size_t index, const ColorAttachment& attachment) -> bool {
         builder.SetColorAttachment(
             index,                                                    //
             attachment.texture->GetTextureDescriptor().format,        //
             attachment.texture->GetTextureDescriptor().sample_count,  //
             attachment.load_action,                                   //
             attachment.store_action                                   //
         );
         return true;
       });
  
   if (const auto& depth = render_target.GetDepthAttachment();
       depth.has_value()) {
     builder.SetDepthStencilAttachment(
         depth->texture->GetTextureDescriptor().format,        //
         depth->texture->GetTextureDescriptor().sample_count,  //
         depth->load_action,                                   //
         depth->store_action                                   //
     );
   } else if (const auto& stencil = render_target.GetStencilAttachment();
              stencil.has_value()) {
     builder.SetStencilAttachment(
         stencil->texture->GetTextureDescriptor().format,        //
         stencil->texture->GetTextureDescriptor().sample_count,  //
         stencil->load_action,                                   //
         stencil->store_action                                   //
     );
   }
  
   auto pass = builder.Build(GetDevice());
 }

References impeller::RenderPassBuilderVK::Build(), impeller::RenderTargetAllocator::CreateOffscreenMSAA(), impeller::RenderTarget::GetDepthAttachment(), GetDevice(), GetResourceAllocator(), impeller::RenderTarget::GetStencilAttachment(), impeller::RenderTarget::IterateAllColorAttachments(), impeller::Attachment::load_action, impeller::RenderPassBuilderVK::SetColorAttachment(), impeller::RenderPassBuilderVK::SetDepthStencilAttachment(), impeller::RenderPassBuilderVK::SetStencilAttachment(), impeller::Attachment::store_action, and impeller::Attachment::texture.

◆ 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 519 of file context_vk.cc.

                               {
   return is_valid_;
 }

◆ RecordFrameEndTime()

void impeller::ContextVK::RecordFrameEndTime ( ) const

◆ SetDebugName() [1/3]

template<typename T >

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

inlinestatic

Definition at line 168 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/3]

template<typename T >

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

inline

Definition at line 151 of file context_vk.h.

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

References GetDevice().

Referenced by impeller::CreateCompatRenderPassForPipeline(), impeller::CreateSampler(), impeller::QueuesVK::FromQueueIndices(), and SetDebugName().

◆ SetDebugName() [3/3]

template<typename T >

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

inline

Definition at line 156 of file context_vk.h.

                                                    {
     if (!HasValidationLayers()) {
       // No-op if validation layers are not enabled.
       return true;
     }
     std::string combined = std::format("{} {}", label, trailing);
     return SetDebugName(GetDevice(), handle, combined);
   }

References GetDevice(), impeller::HasValidationLayers(), and SetDebugName().

◆ SetOffscreenFormat()

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

Definition at line 510 of file context_vk.cc.

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

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

◆ 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 600 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_->Terminate();
   resource_manager_.reset();
  
   raster_message_loop_->Terminate();
 }

◆ SubmitOnscreen()

bool impeller::ContextVK::SubmitOnscreen ( std::shared_ptr< CommandBuffer > cmd_buffer )

overridevirtual

Submit the command buffer that renders to the onscreen surface.

Reimplemented from impeller::Context.

Definition at line 753 of file context_vk.cc.

                                                                       {
   return EnqueueCommandBuffer(std::move(cmd_buffer));
 }

References EnqueueCommandBuffer().

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

◆ ChooseThreadCountForWorkers()

◆ Create()

◆ CreateCommandBuffer()

◆ CreateSurfaceContext()

◆ DescribeGpuModel()

◆ DisposeThreadLocalCachedResources()

◆ EnqueueCommandBuffer()

◆ FinishQueue()

◆ FlushCommandBuffers()

◆ GetBackendType()

◆ GetCapabilities()

◆ GetCommandPoolRecycler()

◆ GetCommandQueue()

◆ GetConcurrentWorkerTaskRunner()

◆ GetDescriptorPoolRecycler()

◆ GetDevice()

◆ GetDeviceHolder()

◆ GetDriverInfo()

◆ GetFenceWaiter()

◆ GetGPUTracer()

◆ GetGraphicsQueue()

◆ GetHash()

◆ GetIdleWaiter()

◆ GetInstance()

◆ GetPhysicalDevice()

◆ GetPipelineLibrary()

◆ GetResourceAllocator()

◆ GetResourceManager()

◆ GetRuntimeStageBackend()

◆ GetSamplerLibrary()

◆ GetShaderLibrary()

◆ GetShouldEnableSurfaceControlSwapchain()

◆ GetWorkarounds()

◆ GetYUVConversionLibrary()

◆ InitializeCommonlyUsedShadersIfNeeded()

◆ IsValid()

◆ RecordFrameEndTime()

◆ SetDebugName() [1/3]

◆ SetDebugName() [2/3]

◆ SetDebugName() [3/3]

◆ SetOffscreenFormat()

◆ Shutdown()

◆ SubmitOnscreen()