#include <context_mtl.h>
Public Member Functions | |
~ContextMTL () override | |
BackendType | GetBackendType () const override |
Get the graphics backend of an Impeller context. More... | |
id< MTLDevice > | GetMTLDevice () const |
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... | |
std::shared_ptr< CommandQueue > | GetCommandQueue () const override |
Return the graphics queue for submitting command buffers. 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 | SetCapabilities (const std::shared_ptr< const Capabilities > &capabilities) |
bool | UpdateOffscreenLayerPixelFormat (PixelFormat format) override |
void | Shutdown () override |
Force all pending asynchronous work to finish. This is achieved by deleting all owned concurrent message loops. More... | |
id< MTLCommandBuffer > | CreateMTLCommandBuffer (const std::string &label) const |
std::shared_ptr< const fml::SyncSwitch > | GetIsGpuDisabledSyncSwitch () const |
void | StoreTaskForGPU (const std::function< void()> &task) override |
![]() | |
virtual | ~Context () |
Destroys an Impeller context. More... | |
virtual void | InitializeCommonlyUsedShadersIfNeeded () const |
Static Public Member Functions | |
static std::shared_ptr< ContextMTL > | Create (const std::vector< std::string > &shader_library_paths, std::shared_ptr< const fml::SyncSwitch > is_gpu_disabled_sync_switch) |
static std::shared_ptr< ContextMTL > | Create (const std::vector< std::shared_ptr< fml::Mapping >> &shader_libraries_data, std::shared_ptr< const fml::SyncSwitch > is_gpu_disabled_sync_switch, const std::string &label) |
static std::shared_ptr< ContextMTL > | Create (id< MTLDevice > device, id< MTLCommandQueue > command_queue, const std::vector< std::shared_ptr< fml::Mapping >> &shader_libraries_data, std::shared_ptr< const fml::SyncSwitch > is_gpu_disabled_sync_switch, const std::string &label) |
![]() | |
static ContextMTL & | Cast (Context &base) |
static const ContextMTL & | Cast (const Context &base) |
static ContextMTL * | Cast (Context *base) |
static const ContextMTL * | Cast (const Context *base) |
Additional Inherited Members | |
![]() | |
enum | BackendType { BackendType::kMetal, BackendType::kOpenGLES, BackendType::kVulkan } |
![]() | |
CaptureContext | capture |
![]() | |
static constexpr int32_t | kMaxTasksAwaitingGPU = 10 |
![]() | |
Context () | |
![]() | |
std::vector< std::function< void()> > | per_frame_task_ |
Definition at line 35 of file context_mtl.h.
|
override |
Definition at line 277 of file context_mtl.mm.
|
static |
Definition at line 238 of file context_mtl.mm.
References impeller::CreateMetalCommandQueue(), impeller::CreateMetalDevice(), and impeller::MTLShaderLibraryFromFileData().
|
static |
Definition at line 219 of file context_mtl.mm.
References impeller::CreateMetalCommandQueue(), impeller::CreateMetalDevice(), and impeller::MTLShaderLibraryFromFilePaths().
|
static |
|
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 311 of file context_mtl.mm.
id< MTLCommandBuffer > impeller::ContextMTL::CreateMTLCommandBuffer | ( | const std::string & | label | ) | const |
|
overridevirtual |
Implements impeller::Context.
Definition at line 286 of file context_mtl.mm.
|
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 281 of file context_mtl.mm.
|
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 351 of file context_mtl.mm.
|
overridevirtual |
Return the graphics queue for submitting command buffers.
Implements impeller::Context.
Definition at line 400 of file context_mtl.mm.
std::shared_ptr< const fml::SyncSwitch > impeller::ContextMTL::GetIsGpuDisabledSyncSwitch | ( | ) | const |
Definition at line 324 of file context_mtl.mm.
id< MTLDevice > impeller::ContextMTL::GetMTLDevice | ( | ) | const |
Definition at line 347 of file context_mtl.mm.
|
overridevirtual |
Returns the library of pipelines used by render or compute commands.
nullptr
for a valid context. Implements impeller::Context.
Definition at line 301 of file context_mtl.mm.
|
overridevirtual |
Returns the allocator used to create textures and buffers on the device.
nullptr
for a valid context. Implements impeller::Context.
Definition at line 343 of file context_mtl.mm.
|
overridevirtual |
Returns the library of combined image samplers used in shaders.
nullptr
for a valid context. Implements impeller::Context.
Definition at line 306 of file context_mtl.mm.
|
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 296 of file context_mtl.mm.
|
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 291 of file context_mtl.mm.
void impeller::ContextMTL::SetCapabilities | ( | const std::shared_ptr< const Capabilities > & | capabilities | ) |
Definition at line 355 of file context_mtl.mm.
|
overridevirtual |
Force all pending asynchronous work to finish. This is achieved by deleting all owned concurrent message loops.
Implements impeller::Context.
Definition at line 316 of file context_mtl.mm.
|
overridevirtual |
Stores a task on the ContextMTL
that is awaiting access for the GPU.
The task will be executed in the event that the GPU access has changed to being available or that the task has been canceled. The task should operate with the SyncSwitch
to make sure the GPU is accessible.
Threadsafe.
task
will be executed on the platform thread.
Reimplemented from impeller::Context.
Definition at line 375 of file context_mtl.mm.
|
overridevirtual |
Reimplemented from impeller::Context.
Definition at line 361 of file context_mtl.mm.
References impeller::InferMetalCapabilities().