Inheritance diagram for impeller::TestImpellerContext:

Public Member Functions
	TestImpellerContext ()

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.

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

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< CommandQueue >	GetCommandQueue () const override
	Return the graphics queue for submitting command buffers.

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.

void	StoreTaskForGPU (const std::function< void()> &task, const std::function< void()> &failure) override

void	FlushTasks (bool fail=false)

void	DisposeThreadLocalCachedResources () override

void	Shutdown () override
	Force all pending asynchronous work to finish. This is achieved by deleting all owned concurrent message loops.

RuntimeStageBackend	GetRuntimeStageBackend () const override
	Retrieve the runtime stage for this context type.

bool	DidDisposeResources () const

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

virtual bool	UpdateOffscreenLayerPixelFormat (PixelFormat format)

virtual void	InitializeCommonlyUsedShadersIfNeeded () const

virtual bool	EnqueueCommandBuffer (std::shared_ptr< CommandBuffer > command_buffer)
	Enqueue command_buffer for submission by the end of the frame.

virtual bool	FlushCommandBuffers ()
	Flush all pending command buffers.

virtual bool	AddTrackingFence (const std::shared_ptr< Texture > &texture) const

virtual std::shared_ptr< const IdleWaiter >	GetIdleWaiter () const

virtual void	ResetThreadLocalState () const

virtual bool	SubmitOnscreen (std::shared_ptr< CommandBuffer > cmd_buffer)
	Submit the command buffer that renders to the onscreen surface.

const Flags &	GetFlags () const

Public Attributes
size_t	command_buffer_count_ = 0

Additional Inherited Members
Public Types inherited from impeller::Context
enum class	BackendType { kMetal , kOpenGLES , kVulkan }

Static Public Attributes inherited from impeller::Context
static constexpr int32_t	kMaxTasksAwaitingGPU = 1024

Protected Member Functions inherited from impeller::Context
	Context (const Flags &flags)

Protected Attributes inherited from impeller::Context
Flags	flags_

std::vector< std::function< void()> >	per_frame_task_

Detailed Description

Definition at line 42 of file image_decoder_unittests.cc.

Constructor & Destructor Documentation

◆ TestImpellerContext()

impeller::TestImpellerContext::TestImpellerContext ( )

inline

Definition at line 44 of file image_decoder_unittests.cc.

44: impeller::Context(impeller::Flags{}) {}

impeller::Context

To do anything rendering related with Impeller, you need a context.

Definition context.h:65

impeller::Flags

Definition flags.h:9

Member Function Documentation

◆ CreateCommandBuffer()

std::shared_ptr< CommandBuffer > impeller::TestImpellerContext::CreateCommandBuffer ( ) const

inlineoverridevirtual

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 76 of file image_decoder_unittests.cc.

                                                                    {
    command_buffer_count_ += 1;
    return nullptr;
  }

References command_buffer_count_.

◆ DescribeGpuModel()

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

inlineoverridevirtual

Implements impeller::Context.

Definition at line 48 of file image_decoder_unittests.cc.

48{ return "TestGpu"; }

◆ DidDisposeResources()

bool impeller::TestImpellerContext::DidDisposeResources ( ) const

inline

Definition at line 105 of file image_decoder_unittests.cc.

105{ return did_dispose_; }

◆ DisposeThreadLocalCachedResources()

void impeller::TestImpellerContext::DisposeThreadLocalCachedResources ( )

inlineoverridevirtual

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 97 of file image_decoder_unittests.cc.

97{ did_dispose_ = true; }

◆ FlushTasks()

void impeller::TestImpellerContext::FlushTasks ( bool fail = false )

inline

Definition at line 86 of file image_decoder_unittests.cc.

                                     {
    for (auto& task : tasks_) {
      if (fail) {
        task.task();
      } else {
        task.failure();
      }
    }
    tasks_.clear();
  }

◆ GetBackendType()

BackendType impeller::TestImpellerContext::GetBackendType ( ) const

inlineoverridevirtual

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 46 of file image_decoder_unittests.cc.

46{ return BackendType::kMetal; }

impeller::Context::BackendType::kMetal

@ kMetal

References impeller::Context::kMetal.

◆ GetCapabilities()

const std::shared_ptr< const Capabilities > & impeller::TestImpellerContext::GetCapabilities ( ) const

inlineoverridevirtual

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 52 of file image_decoder_unittests.cc.

                                                                            {
    return capabilities_;
  }

◆ GetCommandQueue()

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

inlineoverridevirtual

Return the graphics queue for submitting command buffers.

Implements impeller::Context.

Definition at line 72 of file image_decoder_unittests.cc.

                                                               {
    FML_UNREACHABLE();
  }

References FML_UNREACHABLE.

◆ GetPipelineLibrary()

std::shared_ptr< PipelineLibrary > impeller::TestImpellerContext::GetPipelineLibrary ( ) const

inlineoverridevirtual

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 68 of file image_decoder_unittests.cc.

                                                                     {
    return nullptr;
  }

◆ GetResourceAllocator()

std::shared_ptr< Allocator > impeller::TestImpellerContext::GetResourceAllocator ( ) const

inlineoverridevirtual

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 56 of file image_decoder_unittests.cc.

                                                                 {
    return std::make_shared<TestImpellerAllocator>();
  }

◆ GetRuntimeStageBackend()

RuntimeStageBackend impeller::TestImpellerContext::GetRuntimeStageBackend ( ) const

inlineoverridevirtual

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 101 of file image_decoder_unittests.cc.

                                                              {
    return RuntimeStageBackend::kVulkan;
  }

References impeller::kVulkan.

◆ GetSamplerLibrary()

std::shared_ptr< SamplerLibrary > impeller::TestImpellerContext::GetSamplerLibrary ( ) const

inlineoverridevirtual

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 64 of file image_decoder_unittests.cc.

                                                                   {
    return nullptr;
  }

◆ GetShaderLibrary()

std::shared_ptr< ShaderLibrary > impeller::TestImpellerContext::GetShaderLibrary ( ) const

inlineoverridevirtual

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 60 of file image_decoder_unittests.cc.

                                                                 {
    return nullptr;
  }

◆ IsValid()

bool impeller::TestImpellerContext::IsValid ( ) const

inlineoverridevirtual

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 50 of file image_decoder_unittests.cc.

50{ return true; }

◆ Shutdown()

void impeller::TestImpellerContext::Shutdown ( )

inlineoverridevirtual

Force all pending asynchronous work to finish. This is achieved by deleting all owned concurrent message loops.

Implements impeller::Context.

Definition at line 99 of file image_decoder_unittests.cc.

99{}

◆ StoreTaskForGPU()

void impeller::TestImpellerContext::StoreTaskForGPU	(	const std::function< void()> &	task,
		const std::function< void()> &	failure
	)

inlineoverridevirtual

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.

If the queue of pending tasks is cleared without GPU access, then the failure callback will be invoked and the primary task function will not

Threadsafe.

task will be executed on the platform thread.

Reimplemented from impeller::Context.

Definition at line 81 of file image_decoder_unittests.cc.

                                                                    {
    tasks_.push_back(PendingTask{task, failure});
  }

Member Data Documentation

◆ command_buffer_count_

size_t impeller::TestImpellerContext::command_buffer_count_ = 0

mutable

Definition at line 107 of file image_decoder_unittests.cc.

Referenced by CreateCommandBuffer().

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

lib/ui/painting/image_decoder_unittests.cc

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TestImpellerContext()

Member Function Documentation

◆ CreateCommandBuffer()

◆ DescribeGpuModel()

◆ DidDisposeResources()

◆ DisposeThreadLocalCachedResources()

◆ FlushTasks()

◆ GetBackendType()

◆ GetCapabilities()

◆ GetCommandQueue()

◆ GetPipelineLibrary()

◆ GetResourceAllocator()

◆ GetRuntimeStageBackend()

◆ GetSamplerLibrary()

◆ GetShaderLibrary()

◆ IsValid()

◆ Shutdown()

◆ StoreTaskForGPU()

Member Data Documentation

◆ command_buffer_count_