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

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.

std::shared_ptr< Allocator >	GetResourceAllocator () const override
	Returns the allocator used to create textures and buffers on the device.

std::shared_ptr< ShaderLibrary >	GetShaderLibrary () const override
	Returns the library of shaders used to specify the programmable stages of a pipeline.

std::shared_ptr< SamplerLibrary >	GetSamplerLibrary () const override
	Returns the library of combined image samplers used in shaders.

std::shared_ptr< PipelineLibrary >	GetPipelineLibrary () const override
	Returns the library of pipelines used by render or compute commands.

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.

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

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.

void	SetOffscreenFormat (PixelFormat pixel_format)

template<typename T >
bool	SetDebugName (T handle, std::string_view label) 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.

std::shared_ptr< GPUTracerVK >	GetGPUTracer () const

void	RecordFrameEndTime () const

void	InitializeCommonlyUsedShadersIfNeeded () const override

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

virtual bool	UpdateOffscreenLayerPixelFormat (PixelFormat format)

virtual void	StoreTaskForGPU (const std::function< void()> &task)

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 }

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 ()

Protected Attributes inherited from impeller::Context
std::vector< std::function< void()> >	per_frame_task_

Detailed Description

Definition at line 42 of file context_vk.h.

Constructor & Destructor Documentation

◆ ~ContextVK()

impeller::ContextVK::~ContextVK ( )

override

Definition at line 127 of file context_vk.cc.

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

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 110 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);
}

◆ Create()

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

static

Definition at line 100 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;
}

◆ 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 503 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 535 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 479 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 134 of file context_vk.cc.

                                                   {
  return Context::BackendType::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 539 of file context_vk.cc.

                                                                          {
  return device_capabilities_;
}

◆ GetCommandPoolRecycler()

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

Definition at line 559 of file context_vk.cc.

          {
  return command_pool_recycler_;
}

◆ GetCommandQueue()

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

overridevirtual

Return the graphics queue for submitting command buffers.

Implements impeller::Context.

Definition at line 578 of file context_vk.cc.

                                                             {
  return command_queue_vk_;
}

◆ GetConcurrentWorkerTaskRunner()

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

Definition at line 519 of file context_vk.cc.

                                               {
  return raster_message_loop_->GetTaskRunner();
}

◆ GetDescriptorPoolRecycler()

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

Definition at line 573 of file context_vk.cc.

          {
  return descriptor_pool_recycler_;
}

◆ GetDevice()

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

Definition at line 514 of file context_vk.cc.

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

◆ GetDeviceHolder()

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

inline

Definition at line 136 of file context_vk.h.

                                                        {
    return device_holder_;
  }

◆ GetDriverInfo()

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

Definition at line 626 of file context_vk.cc.

                                                                  {
  return driver_info_;
}

◆ GetFenceWaiter()

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

Definition at line 551 of file context_vk.cc.

                                                             {
  return fence_waiter_;
}

◆ GetGPUTracer()

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

Definition at line 569 of file context_vk.cc.

                                                         {
  return gpu_tracer_;
}

◆ GetGraphicsQueue()

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

Definition at line 543 of file context_vk.cc.

                                                                {
  return queues_.graphics_queue;
}

◆ GetHash()

uint64_t impeller::ContextVK::GetHash ( ) const

inline

Definition at line 67 of file context_vk.h.

67{ return hash_; }

◆ GetInstance()

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

Definition at line 510 of file context_vk.cc.

                                        {
  return *device_holder_->instance;
}

◆ GetPhysicalDevice()

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

Definition at line 547 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 499 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 487 of file context_vk.cc.

                                                               {
  return allocator_;
}

◆ GetResourceManager()

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

Definition at line 555 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 495 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 491 of file context_vk.cc.

                                                               {
  return shader_library_;
}

◆ GetYUVConversionLibrary()

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

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

                                                            {
  RenderTargetAllocator rt_allocator(GetResourceAllocator());
  RenderTarget render_target =
      rt_allocator.CreateOffscreenMSAA(*this, {1, 1}, 1);
 
  RenderPassBuilderVK builder;
  for (const auto& [bind_point, color] : render_target.GetColorAttachments()) {
    builder.SetColorAttachment(
        bind_point,                                          //
        color.texture->GetTextureDescriptor().format,        //
        color.texture->GetTextureDescriptor().sample_count,  //
        color.load_action,                                   //
        color.store_action                                   //
    );
  }
 
  if (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 (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());
}

◆ 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 483 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 113 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;
  }

◆ SetDebugName() [2/2]

template<typename T >

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

inline

Definition at line 108 of file context_vk.h.

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

◆ SetOffscreenFormat()

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

Definition at line 474 of file context_vk.cc.

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

◆ 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 523 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();
 
  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

◆ ChooseThreadCountForWorkers()

◆ Create()

◆ CreateCommandBuffer()

◆ CreateSurfaceContext()

◆ DescribeGpuModel()

◆ GetBackendType()

◆ GetCapabilities()

◆ GetCommandPoolRecycler()

◆ GetCommandQueue()

◆ GetConcurrentWorkerTaskRunner()

◆ GetDescriptorPoolRecycler()

◆ GetDevice()

◆ GetDeviceHolder()

◆ GetDriverInfo()

◆ GetFenceWaiter()

◆ GetGPUTracer()

◆ GetGraphicsQueue()

◆ GetHash()

◆ GetInstance()

◆ GetPhysicalDevice()

◆ GetPipelineLibrary()

◆ GetResourceAllocator()

◆ GetResourceManager()

◆ GetSamplerLibrary()

◆ GetShaderLibrary()

◆ GetYUVConversionLibrary()

◆ InitializeCommonlyUsedShadersIfNeeded()

◆ IsValid()

◆ RecordFrameEndTime()

◆ SetDebugName() [1/2]

◆ SetDebugName() [2/2]

◆ SetOffscreenFormat()

◆ Shutdown()