#include <context_mtl.h>

Inheritance diagram for impeller::ContextMTL:

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

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

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

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

std::shared_ptr< const fml::SyncSwitch >	GetIsGpuDisabledSyncSwitch () const

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

virtual void	SetSyncPresentation (bool value)
	Force the Vulkan presentation (submitKHR) to be performed on the raster task runner. More...

Pool< HostBuffer > &	GetHostBufferPool () const
	Accessor for a pool of HostBuffers. More...

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 Public Member Functions inherited from impeller::BackendCast< ContextMTL, Context >
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
Public Types inherited from impeller::Context
enum	BackendType { BackendType::kMetal, BackendType::kOpenGLES, BackendType::kVulkan }

Public Attributes inherited from impeller::Context
CaptureContext	capture

Protected Member Functions inherited from impeller::Context
	Context ()

Detailed Description

Definition at line 32 of file context_mtl.h.

Constructor & Destructor Documentation

◆ ~ContextMTL()

impeller::ContextMTL::~ContextMTL ( )

overridedefault

Member Function Documentation

◆ Create() [1/3]

std::shared_ptr< ContextMTL > impeller::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

Definition at line 248 of file context_mtl.mm.

                                     {
   auto device = CreateMetalDevice();
   auto command_queue = CreateMetalCommandQueue(device);
   if (!command_queue) {
     return nullptr;
   }
   auto context = std::shared_ptr<ContextMTL>(
       new ContextMTL(device, command_queue,
                      MTLShaderLibraryFromFileData(device, shader_libraries_data,
                                                   library_label),
                      std::move(is_gpu_disabled_sync_switch)));
   if (!context->IsValid()) {
     FML_LOG(ERROR) << "Could not create Metal context.";
     return nullptr;
   }
   return context;
 }

References impeller::CreateMetalCommandQueue(), impeller::CreateMetalDevice(), and impeller::MTLShaderLibraryFromFileData().

◆ Create() [2/3]

std::shared_ptr< ContextMTL > impeller::ContextMTL::Create	(	const std::vector< std::string > &	shader_library_paths,
		std::shared_ptr< const fml::SyncSwitch >	is_gpu_disabled_sync_switch
	)

static

Definition at line 229 of file context_mtl.mm.

                                                                     {
   auto device = CreateMetalDevice();
   auto command_queue = CreateMetalCommandQueue(device);
   if (!command_queue) {
     return nullptr;
   }
   auto context = std::shared_ptr<ContextMTL>(new ContextMTL(
       device, command_queue,
       MTLShaderLibraryFromFilePaths(device, shader_library_paths),
       std::move(is_gpu_disabled_sync_switch)));
   if (!context->IsValid()) {
     FML_LOG(ERROR) << "Could not create Metal context.";
     return nullptr;
   }
   return context;
 }

References impeller::CreateMetalCommandQueue(), impeller::CreateMetalDevice(), and impeller::MTLShaderLibraryFromFilePaths().

Referenced by impeller::PlaygroundImplMTL::PlaygroundImplMTL().

◆ Create() [3/3]

std::shared_ptr< ContextMTL > impeller::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

Definition at line 269 of file context_mtl.mm.

                                     {
   auto context = std::shared_ptr<ContextMTL>(
       new ContextMTL(device, command_queue,
                      MTLShaderLibraryFromFileData(device, shader_libraries_data,
                                                   library_label),
                      std::move(is_gpu_disabled_sync_switch)));
   if (!context->IsValid()) {
     FML_LOG(ERROR) << "Could not create Metal context.";
     return nullptr;
   }
   return context;
 }

References impeller::MTLShaderLibraryFromFileData().

◆ CreateCommandBuffer()

std::shared_ptr< CommandBuffer > impeller::ContextMTL::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 319 of file context_mtl.mm.

                                                                    {
   return CreateCommandBufferInQueue(command_queue_);
 }

◆ CreateMTLCommandBuffer()

id< MTLCommandBuffer > impeller::ContextMTL::CreateMTLCommandBuffer ( const std::string & label ) const

Definition at line 370 of file context_mtl.mm.

                                   {
   auto buffer = [command_queue_ commandBuffer];
   if (!label.empty()) {
     [buffer setLabel:@(label.data())];
   }
   return buffer;
 }

Referenced by impeller::SurfaceMTL::Present().

◆ DescribeGpuModel()

std::string impeller::ContextMTL::DescribeGpuModel ( ) const

overridevirtual

Implements impeller::Context.

Definition at line 294 of file context_mtl.mm.

                                              {
   return std::string([[device_ name] UTF8String]);
 }

◆ GetBackendType()

Context::BackendType impeller::ContextMTL::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 289 of file context_mtl.mm.

                                                     {
   return Context::BackendType::kMetal;
 }

◆ GetCapabilities()

const std::shared_ptr< const Capabilities > & impeller::ContextMTL::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 360 of file context_mtl.mm.

                                                                            {
   return device_capabilities_;
 }

◆ GetIsGpuDisabledSyncSwitch()

std::shared_ptr< const fml::SyncSwitch > impeller::ContextMTL::GetIsGpuDisabledSyncSwitch ( ) const

Definition at line 333 of file context_mtl.mm.

           {
   return is_gpu_disabled_sync_switch_;
 }

◆ GetMTLDevice()

id< MTLDevice > impeller::ContextMTL::GetMTLDevice ( ) const

Definition at line 356 of file context_mtl.mm.

                                              {
   return device_;
 }

Referenced by impeller::PlaygroundImplMTL::PlaygroundImplMTL().

◆ GetPipelineLibrary()

std::shared_ptr< PipelineLibrary > impeller::ContextMTL::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 309 of file context_mtl.mm.

                                                                     {
   return pipeline_library_;
 }

◆ GetResourceAllocator()

std::shared_ptr< Allocator > impeller::ContextMTL::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 352 of file context_mtl.mm.

                                                                 {
   return resource_allocator_;
 }

◆ GetSamplerLibrary()

std::shared_ptr< SamplerLibrary > impeller::ContextMTL::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 314 of file context_mtl.mm.

                                                                   {
   return sampler_library_;
 }

◆ GetShaderLibrary()

std::shared_ptr< ShaderLibrary > impeller::ContextMTL::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 304 of file context_mtl.mm.

                                                                 {
   return shader_library_;
 }

◆ GetWorkerTaskRunner()

const std::shared_ptr< fml::ConcurrentTaskRunner > impeller::ContextMTL::GetWorkerTaskRunner ( ) const

Definition at line 329 of file context_mtl.mm.

                                       {
   return raster_message_loop_->GetTaskRunner();
 }

◆ IsValid()

bool impeller::ContextMTL::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 299 of file context_mtl.mm.

                                {
   return is_valid_;
 }

◆ Shutdown()

void impeller::ContextMTL::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 324 of file context_mtl.mm.

                           {
   raster_message_loop_.reset();
 }

◆ UpdateOffscreenLayerPixelFormat()

bool impeller::ContextMTL::UpdateOffscreenLayerPixelFormat ( PixelFormat format )

overridevirtual

Reimplemented from impeller::Context.

Definition at line 365 of file context_mtl.mm.

                                                                    {
   device_capabilities_ = InferMetalCapabilities(device_, format);
   return true;
 }

References impeller::InferMetalCapabilities().

The documentation for this class was generated from the following files:

impeller/renderer/backend/metal/context_mtl.h
impeller/renderer/backend/metal/context_mtl.mm

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~ContextMTL()

Member Function Documentation

◆ Create() [1/3]

◆ Create() [2/3]

◆ Create() [3/3]

◆ CreateCommandBuffer()

◆ CreateMTLCommandBuffer()

◆ DescribeGpuModel()

◆ GetBackendType()

◆ GetCapabilities()

◆ GetIsGpuDisabledSyncSwitch()

◆ GetMTLDevice()

◆ GetPipelineLibrary()

◆ GetResourceAllocator()

◆ GetSamplerLibrary()

◆ GetShaderLibrary()

◆ GetWorkerTaskRunner()

◆ IsValid()

◆ Shutdown()

◆ UpdateOffscreenLayerPixelFormat()