#include <context_vk.h>
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... | |
RuntimeStageBackend | GetRuntimeStageBackend () const override |
Retrieve the runtime stage for this context type. More... | |
std::shared_ptr< const IdleWaiter > | GetIdleWaiter () const override |
![]() | |
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 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 | |
![]() | |
enum class | BackendType { kMetal , kOpenGLES , kVulkan } |
![]() | |
static constexpr int32_t | kMaxTasksAwaitingGPU = 1024 |
![]() | |
Context (const Flags &flags) | |
![]() | |
Flags | flags_ |
std::vector< std::function< void()> > | per_frame_task_ |
Definition at line 64 of file context_vk.h.
|
override |
Definition at line 131 of file context_vk.cc.
|
static |
Choose the number of worker threads the context_vk will create.
Visible for testing.
Definition at line 115 of file context_vk.cc.
Referenced by impeller::testing::TEST().
Definition at line 105 of file context_vk.cc.
References impeller::ContextVK::Settings::flags.
Referenced by impeller::interop::ContextVK::Create(), impeller::android::testing::CreateContext(), and impeller::PlaygroundImplVK::PlaygroundImplVK().
|
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.
Implements impeller::Context.
Definition at line 536 of file context_vk.cc.
References GetCommandPoolRecycler(), GetDeviceHolder(), GetGPUTracer(), GetGraphicsQueue(), and VALIDATION_LOG.
Referenced by impeller::GPUTracerVK::InitializeQueryPool().
std::shared_ptr< SurfaceContextVK > impeller::ContextVK::CreateSurfaceContext | ( | ) |
Definition at line 610 of file context_vk.cc.
|
overridevirtual |
Implements impeller::Context.
Definition at line 512 of file context_vk.cc.
|
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 718 of file context_vk.cc.
|
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 652 of file context_vk.cc.
References GetCommandQueue().
Referenced by SubmitOnscreen().
|
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 662 of file context_vk.cc.
References GetCommandQueue().
|
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()`.
Context
. Implements impeller::Context.
Definition at line 140 of file context_vk.cc.
References impeller::Context::kVulkan.
|
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
.
nullptr
for a valid context. Implements impeller::Context.
Definition at line 614 of file context_vk.cc.
Referenced by impeller::AllocatedTextureSourceVK::AllocatedTextureSourceVK().
std::shared_ptr< CommandPoolRecyclerVK > impeller::ContextVK::GetCommandPoolRecycler | ( | ) | const |
Definition at line 634 of file context_vk.cc.
Referenced by CreateCommandBuffer().
|
overridevirtual |
Return the graphics queue for submitting command buffers.
Implements impeller::Context.
Definition at line 648 of file context_vk.cc.
Referenced by EnqueueCommandBuffer(), FlushCommandBuffers(), and impeller::GPUTracerVK::InitializeQueryPool().
const std::shared_ptr< fml::ConcurrentTaskRunner > impeller::ContextVK::GetConcurrentWorkerTaskRunner | ( | ) | const |
Definition at line 594 of file context_vk.cc.
std::shared_ptr< DescriptorPoolRecyclerVK > impeller::ContextVK::GetDescriptorPoolRecycler | ( | ) | const |
Definition at line 643 of file context_vk.cc.
const vk::Device & impeller::ContextVK::GetDevice | ( | ) | const |
Definition at line 589 of file context_vk.cc.
Referenced by impeller::AHBSwapchainImplVK::AcquireNextDrawable(), impeller::DescriptorPoolVK::AllocateDescriptorSets(), InitializeCommonlyUsedShadersIfNeeded(), impeller::GPUTracerVK::InitializeQueryPool(), and SetDebugName().
|
inline |
Definition at line 191 of file context_vk.h.
Referenced by impeller::AllocatedTextureSourceVK::AllocatedTextureSourceVK(), and CreateCommandBuffer().
const std::unique_ptr< DriverInfoVK > & impeller::ContextVK::GetDriverInfo | ( | ) | const |
Definition at line 731 of file context_vk.cc.
std::shared_ptr< FenceWaiterVK > impeller::ContextVK::GetFenceWaiter | ( | ) | const |
Definition at line 626 of file context_vk.cc.
std::shared_ptr< GPUTracerVK > impeller::ContextVK::GetGPUTracer | ( | ) | const |
Definition at line 639 of file context_vk.cc.
Referenced by impeller::AHBSwapchainImplVK::AcquireNextDrawable(), and CreateCommandBuffer().
const std::shared_ptr< QueueVK > & impeller::ContextVK::GetGraphicsQueue | ( | ) | const |
Definition at line 618 of file context_vk.cc.
References impeller::QueuesVK::graphics_queue.
Referenced by CreateCommandBuffer().
|
inline |
Definition at line 104 of file context_vk.h.
Referenced by impeller::CommandPoolRecyclerVK::GetGlobalPoolCount().
|
inlineoverridevirtual |
Reimplemented from impeller::Context.
Definition at line 243 of file context_vk.h.
vk::Instance impeller::ContextVK::GetInstance | ( | ) | const |
Definition at line 585 of file context_vk.cc.
Referenced by impeller::interop::SwapchainVK::SwapchainVK().
vk::PhysicalDevice impeller::ContextVK::GetPhysicalDevice | ( | ) | const |
Definition at line 622 of file context_vk.cc.
|
overridevirtual |
Returns the library of pipelines used by render or compute commands.
nullptr
for a valid context. Implements impeller::Context.
Definition at line 532 of file context_vk.cc.
|
overridevirtual |
Returns the allocator used to create textures and buffers on the device.
nullptr
for a valid context. Implements impeller::Context.
Definition at line 520 of file context_vk.cc.
Referenced by impeller::AllocatedTextureSourceVK::AllocatedTextureSourceVK(), and InitializeCommonlyUsedShadersIfNeeded().
std::shared_ptr< ResourceManagerVK > impeller::ContextVK::GetResourceManager | ( | ) | const |
Definition at line 630 of file context_vk.cc.
|
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 741 of file context_vk.cc.
References impeller::kVulkan.
|
overridevirtual |
Returns the library of combined image samplers used in shaders.
nullptr
for a valid context. Implements impeller::Context.
Definition at line 528 of file context_vk.cc.
|
overridevirtual |
Returns the library of shaders used to specify the programmable stages of a pipeline.
nullptr
for a valid context. Implements impeller::Context.
Definition at line 524 of file context_vk.cc.
bool impeller::ContextVK::GetShouldEnableSurfaceControlSwapchain | ( | ) | const |
Whether the Android Surface control based swapchain should be enabled.
Definition at line 735 of file context_vk.cc.
References impeller::BackendCast< CapabilitiesVK, Capabilities >::Cast(), and impeller::CapabilitiesVK::SupportsExternalSemaphoreExtensions().
const WorkaroundsVK & impeller::ContextVK::GetWorkarounds | ( | ) | const |
Definition at line 749 of file context_vk.cc.
const std::shared_ptr< YUVConversionLibraryVK > & impeller::ContextVK::GetYUVConversionLibrary | ( | ) | const |
Definition at line 727 of file context_vk.cc.
|
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 679 of file context_vk.cc.
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.
|
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.
Implements impeller::Context.
Definition at line 516 of file context_vk.cc.
void impeller::ContextVK::RecordFrameEndTime | ( | ) | const |
|
inlinestatic |
Definition at line 168 of file context_vk.h.
References impeller::HasValidationLayers(), and VALIDATION_LOG.
|
inline |
Definition at line 151 of file context_vk.h.
References GetDevice().
Referenced by impeller::CreateCompatRenderPassForPipeline(), impeller::CreateSampler(), impeller::QueuesVK::FromQueueIndices(), and SetDebugName().
|
inline |
Definition at line 156 of file context_vk.h.
References GetDevice(), impeller::HasValidationLayers(), SetDebugName(), and impeller::SPrintF().
void impeller::ContextVK::SetOffscreenFormat | ( | PixelFormat | pixel_format | ) |
Definition at line 507 of file context_vk.cc.
References impeller::BackendCast< CapabilitiesVK, Capabilities >::Cast(), and impeller::CapabilitiesVK::SetOffscreenFormat().
|
overridevirtual |
Force all pending asynchronous work to finish. This is achieved by deleting all owned concurrent message loops.
Implements impeller::Context.
Definition at line 598 of file context_vk.cc.
|
overridevirtual |
Submit the command buffer that renders to the onscreen surface.
Reimplemented from impeller::Context.
Definition at line 745 of file context_vk.cc.
References EnqueueCommandBuffer().