#include <surface_context_vk.h>
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... | |
std::shared_ptr< CommandQueue > | GetCommandQueue () const override |
Return the graphics queue for submitting command buffers. More... | |
std::shared_ptr< const IdleWaiter > | GetIdleWaiter () const override |
RuntimeStageBackend | GetRuntimeStageBackend () const override |
Retrieve the runtime stage for this context type. More... | |
bool | SubmitOnscreen (std::shared_ptr< CommandBuffer > cmd_buffer) override |
Submit the command buffer that renders to the onscreen surface. More... | |
void | Shutdown () override |
Force all pending asynchronous work to finish. This is achieved by deleting all owned concurrent message loops. More... | |
bool | SetWindowSurface (vk::UniqueSurfaceKHR surface, const ISize &size) |
bool | SetSwapchain (std::shared_ptr< SwapchainVK > swapchain) |
std::unique_ptr< Surface > | AcquireNextSurface () |
void | MarkFrameEnd () |
Performs frame incrementing processes like AcquireNextSurface but without the surface. More... | |
void | UpdateSurfaceSize (const ISize &size) const |
Mark the current swapchain configuration as dirty, forcing it to be recreated on the next frame. More... | |
void | TeardownSwapchain () |
Can be called when the surface is destroyed to reduce memory usage. More... | |
void | InitializeCommonlyUsedShadersIfNeeded () const override |
void | DisposeThreadLocalCachedResources () override |
const vk::Device & | GetDevice () const |
const std::shared_ptr< ContextVK > & | GetParent () const |
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... | |
![]() | |
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 |
Additional Inherited Members | |
![]() | |
enum class | BackendType { kMetal , kOpenGLES , kVulkan } |
![]() | |
static SurfaceContextVK & | Cast (Context &base) |
static const SurfaceContextVK & | Cast (const Context &base) |
static SurfaceContextVK * | Cast (Context *base) |
static const SurfaceContextVK * | Cast (const Context *base) |
![]() | |
static constexpr int32_t | kMaxTasksAwaitingGPU = 1024 |
![]() | |
Context (const Flags &flags) | |
![]() | |
Flags | flags_ |
std::vector< std::function< void()> > | per_frame_task_ |
For Vulkan, there is both a ContextVK that implements Context and a SurfaceContextVK that also implements Context and takes a ContextVK as its parent. There is a one to many relationship between ContextVK and SurfaceContextVK.
Most operations in this class are delegated to the parent ContextVK. This class specifically manages swapchains and creation of VkSurfaces on Android. By maintaining the swapchain this way, it is possible to have multiple surfaces sharing the same ContextVK without stepping on each other's swapchains.
Definition at line 32 of file surface_context_vk.h.
|
explicit |
Definition at line 16 of file surface_context_vk.cc.
|
overridedefault |
std::unique_ptr< Surface > impeller::SurfaceContextVK::AcquireNextSurface | ( | ) |
Definition at line 91 of file surface_context_vk.cc.
References MarkFrameEnd().
Referenced by impeller::testing::TEST().
|
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 49 of file surface_context_vk.cc.
|
overridevirtual |
Implements impeller::Context.
Definition at line 25 of file surface_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 122 of file surface_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 130 of file surface_context_vk.cc.
|
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 135 of file surface_context_vk.cc.
|
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 21 of file surface_context_vk.cc.
|
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 57 of file surface_context_vk.cc.
|
overridevirtual |
Return the graphics queue for submitting command buffers.
Implements impeller::Context.
Definition at line 53 of file surface_context_vk.cc.
const vk::Device & impeller::SurfaceContextVK::GetDevice | ( | ) | const |
Definition at line 114 of file surface_context_vk.cc.
|
overridevirtual |
Reimplemented from impeller::Context.
Definition at line 62 of file surface_context_vk.cc.
const std::shared_ptr< ContextVK > & impeller::SurfaceContextVK::GetParent | ( | ) | const |
Definition at line 126 of file surface_context_vk.cc.
Referenced by impeller::testing::TEST_P().
|
overridevirtual |
Returns the library of pipelines used by render or compute commands.
nullptr
for a valid context. Implements impeller::Context.
Definition at line 45 of file surface_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 33 of file surface_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 145 of file surface_context_vk.cc.
|
overridevirtual |
Returns the library of combined image samplers used in shaders.
nullptr
for a valid context. Implements impeller::Context.
Definition at line 41 of file surface_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 37 of file surface_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 118 of file surface_context_vk.cc.
|
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 29 of file surface_context_vk.cc.
void impeller::SurfaceContextVK::MarkFrameEnd | ( | ) |
Performs frame incrementing processes like AcquireNextSurface but without the surface.
Used by the embedder.h implementations.
Definition at line 101 of file surface_context_vk.cc.
References impeller::BackendCast< PipelineLibraryVK, PipelineLibrary >::Cast(), and impeller::PipelineLibraryVK::DidAcquireSurfaceFrame().
Referenced by AcquireNextSurface().
bool impeller::SurfaceContextVK::SetSwapchain | ( | std::shared_ptr< SwapchainVK > | swapchain | ) |
Definition at line 82 of file surface_context_vk.cc.
References VALIDATION_LOG.
Referenced by SetWindowSurface().
bool impeller::SurfaceContextVK::SetWindowSurface | ( | vk::UniqueSurfaceKHR | surface, |
const ISize & | size | ||
) |
Definition at line 70 of file surface_context_vk.cc.
References impeller::SwapchainVK::Create(), and SetSwapchain().
Referenced by impeller::testing::TEST().
|
overridevirtual |
Force all pending asynchronous work to finish. This is achieved by deleting all owned concurrent message loops.
Implements impeller::Context.
Definition at line 66 of file surface_context_vk.cc.
|
overridevirtual |
Submit the command buffer that renders to the onscreen surface.
Reimplemented from impeller::Context.
Definition at line 139 of file surface_context_vk.cc.
void impeller::SurfaceContextVK::TeardownSwapchain | ( | ) |
Can be called when the surface is destroyed to reduce memory usage.
Definition at line 75 of file surface_context_vk.cc.
Referenced by impeller::testing::TEST().
void impeller::SurfaceContextVK::UpdateSurfaceSize | ( | const ISize & | size | ) | const |
Mark the current swapchain configuration as dirty, forcing it to be recreated on the next frame.
Definition at line 110 of file surface_context_vk.cc.