Inheritance diagram for flutter::testing::android::TestImpellerContext:

Public Member Functions
	TestImpellerContext ()

	~TestImpellerContext ()

impeller::Context::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 impeller::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`.

bool	UpdateOffscreenLayerPixelFormat (impeller::PixelFormat format) override

std::shared_ptr< impeller::Allocator >	GetResourceAllocator () const override
	Returns the allocator used to create textures and buffers on the device.

std::shared_ptr< impeller::ShaderLibrary >	GetShaderLibrary () const override
	Returns the library of shaders used to specify the programmable stages of a pipeline.

std::shared_ptr< impeller::SamplerLibrary >	GetSamplerLibrary () const override
	Returns the library of combined image samplers used in shaders.

std::shared_ptr< impeller::PipelineLibrary >	GetPipelineLibrary () const override
	Returns the library of pipelines used by render or compute commands.

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

std::shared_ptr< impeller::CommandQueue >	GetCommandQueue () const override
	Return the graphics queue for submitting command buffers.

bool	FinishQueue () override
	Wait until all previously submitted command buffers are processed and displayed by the GPU.

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

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

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

virtual void	StoreTaskForGPU (const fml::closure &task, const fml::closure &failure)

virtual void	InitializeCommonlyUsedShadersIfNeeded () const

virtual void	DisposeThreadLocalCachedResources ()

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
bool	did_shutdown = false

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 38 of file android_context_gl_unittests.cc.

Constructor & Destructor Documentation

◆ TestImpellerContext()

flutter::testing::android::TestImpellerContext::TestImpellerContext ( )

inline

Definition at line 40 of file android_context_gl_unittests.cc.

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

impeller::Context::Context

Context(const Flags &flags)

Definition context.cc:27

impeller::Flags

Definition flags.h:9

◆ ~TestImpellerContext()

flutter::testing::android::TestImpellerContext::~TestImpellerContext ( )

inline

Definition at line 42 of file android_context_gl_unittests.cc.

42{}

Member Function Documentation

◆ CreateCommandBuffer()

std::shared_ptr< impeller::CommandBuffer > flutter::testing::android::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 78 of file android_context_gl_unittests.cc.

                     {
    FML_UNREACHABLE();
  }

References FML_UNREACHABLE.

◆ DescribeGpuModel()

std::string flutter::testing::android::TestImpellerContext::DescribeGpuModel ( ) const

inlineoverridevirtual

Implements impeller::Context.

Definition at line 48 of file android_context_gl_unittests.cc.

48{ return ""; }

◆ FinishQueue()

bool flutter::testing::android::TestImpellerContext::FinishQueue ( )

inlineoverridevirtual

Wait until all previously submitted command buffers are processed and displayed by the GPU.

WARNING: This method call is unnecessary for nearly all use cases since asynchronous workloads are the expected norm and calling this method can negatively affect application performance. Its only use is for cases like benchmarking where proper performance metrics can only be collected by including all background processing of the GPU.

Outstanding unflushed command buffers are not committed, submitted, or enqueued by this method and such buffers should have already been flushed before this method is called. The method will only wait for work to be done that has already been submitted to the GPU.

Returns: True if the queue was successfully processed, otherwise false if there was an error or if the backend does not support synchronous reporting of completion. Implementations intended entirely for testing might simply return false, but they would not be used for benchmarking or other situations where we might measure GPU performance.

Implements impeller::Context.

Definition at line 89 of file android_context_gl_unittests.cc.

89{ return false; }

◆ GetBackendType()

impeller::Context::BackendType flutter::testing::android::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 44 of file android_context_gl_unittests.cc.

                                                             {
    return impeller::Context::BackendType::kOpenGLES;
  }

References impeller::Context::kOpenGLES.

◆ GetCapabilities()

const std::shared_ptr< const impeller::Capabilities > & flutter::testing::android::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 android_context_gl_unittests.cc.

                     {
    FML_UNREACHABLE();
  }

References FML_UNREACHABLE.

◆ GetCommandQueue()

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

inlineoverridevirtual

Return the graphics queue for submitting command buffers.

Implements impeller::Context.

Definition at line 83 of file android_context_gl_unittests.cc.

                                                                       {
    FML_UNREACHABLE();
  }

References FML_UNREACHABLE.

◆ GetPipelineLibrary()

std::shared_ptr< impeller::PipelineLibrary > flutter::testing::android::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 73 of file android_context_gl_unittests.cc.

                     {
    FML_UNREACHABLE();
  }

References FML_UNREACHABLE.

◆ GetResourceAllocator()

std::shared_ptr< impeller::Allocator > flutter::testing::android::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 61 of file android_context_gl_unittests.cc.

                                                                         {
    FML_UNREACHABLE();
  }

References FML_UNREACHABLE.

◆ GetRuntimeStageBackend()

impeller::RuntimeStageBackend flutter::testing::android::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 93 of file android_context_gl_unittests.cc.

                                                                      {
    return impeller::RuntimeStageBackend::kVulkan;
  }

References impeller::kVulkan.

◆ GetSamplerLibrary()

std::shared_ptr< impeller::SamplerLibrary > flutter::testing::android::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 69 of file android_context_gl_unittests.cc.

                                                                           {
    FML_UNREACHABLE();
  }

References FML_UNREACHABLE.

◆ GetShaderLibrary()

std::shared_ptr< impeller::ShaderLibrary > flutter::testing::android::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 65 of file android_context_gl_unittests.cc.

                                                                         {
    FML_UNREACHABLE();
  }

References FML_UNREACHABLE.

◆ IsValid()

bool flutter::testing::android::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 android_context_gl_unittests.cc.

50{ return true; }

◆ Shutdown()

void flutter::testing::android::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 91 of file android_context_gl_unittests.cc.

91{ did_shutdown = true; }

flutter::testing::android::TestImpellerContext::did_shutdown

bool did_shutdown

Definition android_context_gl_unittests.cc:97

References did_shutdown.

◆ UpdateOffscreenLayerPixelFormat()

bool flutter::testing::android::TestImpellerContext::UpdateOffscreenLayerPixelFormat ( impeller::PixelFormat format )

inlineoverridevirtual

Reimplemented from impeller::Context.

Definition at line 57 of file android_context_gl_unittests.cc.

                                                                            {
    FML_UNREACHABLE();
  }

References FML_UNREACHABLE.

Member Data Documentation

◆ did_shutdown

bool flutter::testing::android::TestImpellerContext::did_shutdown = false

Definition at line 97 of file android_context_gl_unittests.cc.

Referenced by Shutdown().

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

shell/platform/android/android_context_gl_unittests.cc

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TestImpellerContext()

◆ ~TestImpellerContext()

Member Function Documentation

◆ CreateCommandBuffer()

◆ DescribeGpuModel()

◆ FinishQueue()

◆ GetBackendType()

◆ GetCapabilities()

◆ GetCommandQueue()

◆ GetPipelineLibrary()

◆ GetResourceAllocator()

◆ GetRuntimeStageBackend()

◆ GetSamplerLibrary()

◆ GetShaderLibrary()

◆ IsValid()

◆ Shutdown()

◆ UpdateOffscreenLayerPixelFormat()

Member Data Documentation

◆ did_shutdown