Flutter Engine
The Flutter Engine
Public Member Functions | Public Attributes | List of all members
impeller::TestImpellerContext Class Reference
Inheritance diagram for impeller::TestImpellerContext:
impeller::Context

Public Member Functions

 TestImpellerContext ()=default
 
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...
 
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< AllocatorGetResourceAllocator () const override
 Returns the allocator used to create textures and buffers on the device. More...
 
std::shared_ptr< ShaderLibraryGetShaderLibrary () const override
 Returns the library of shaders used to specify the programmable stages of a pipeline. More...
 
std::shared_ptr< SamplerLibraryGetSamplerLibrary () const override
 Returns the library of combined image samplers used in shaders. More...
 
std::shared_ptr< PipelineLibraryGetPipelineLibrary () const override
 Returns the library of pipelines used by render or compute commands. More...
 
std::shared_ptr< CommandQueueGetCommandQueue () const override
 Return the graphics queue for submitting command buffers. More...
 
std::shared_ptr< CommandBufferCreateCommandBuffer () 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...
 
void Shutdown () override
 Force all pending asynchronous work to finish. This is achieved by deleting all owned concurrent message loops. More...
 
- Public Member Functions inherited from impeller::Context
virtual ~Context ()
 Destroys an Impeller context. More...
 
virtual BackendType GetBackendType () const =0
 Get the graphics backend of an Impeller context. More...
 
virtual std::string DescribeGpuModel () const =0
 
virtual bool IsValid () const =0
 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...
 
virtual const std::shared_ptr< const Capabilities > & GetCapabilities () const =0
 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...
 
virtual bool UpdateOffscreenLayerPixelFormat (PixelFormat format)
 
virtual std::shared_ptr< AllocatorGetResourceAllocator () const =0
 Returns the allocator used to create textures and buffers on the device. More...
 
virtual std::shared_ptr< ShaderLibraryGetShaderLibrary () const =0
 Returns the library of shaders used to specify the programmable stages of a pipeline. More...
 
virtual std::shared_ptr< SamplerLibraryGetSamplerLibrary () const =0
 Returns the library of combined image samplers used in shaders. More...
 
virtual std::shared_ptr< PipelineLibraryGetPipelineLibrary () const =0
 Returns the library of pipelines used by render or compute commands. More...
 
virtual std::shared_ptr< CommandBufferCreateCommandBuffer () const =0
 Create a new command buffer. Command buffers can be used to encode graphics, blit, or compute commands to be submitted to the device. More...
 
virtual std::shared_ptr< CommandQueueGetCommandQueue () const =0
 Return the graphics queue for submitting command buffers. More...
 
virtual void Shutdown ()=0
 Force all pending asynchronous work to finish. This is achieved by deleting all owned concurrent message loops. More...
 
virtual void StoreTaskForGPU (const std::function< void()> &task)
 
virtual void InitializeCommonlyUsedShadersIfNeeded () 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 = 10
 
- Protected Member Functions inherited from impeller::Context
 Context ()
 
- Protected Attributes inherited from impeller::Context
std::vector< std::function< void()> > per_frame_task_
 

Detailed Description

Definition at line 40 of file image_decoder_unittests.cc.

Constructor & Destructor Documentation

◆ TestImpellerContext()

impeller::TestImpellerContext::TestImpellerContext ( )
default

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

74 {
76 return nullptr;
77 }

◆ DescribeGpuModel()

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

Implements impeller::Context.

Definition at line 46 of file image_decoder_unittests.cc.

46{ return "TestGpu"; }

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

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

50 {
51 return capabilities_;
52 }

◆ GetCommandQueue()

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

Return the graphics queue for submitting command buffers.

Implements impeller::Context.

Definition at line 70 of file image_decoder_unittests.cc.

70 {
72 }
#define FML_UNREACHABLE()
Definition: logging.h:109

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

66 {
67 return nullptr;
68 }

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

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

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

62 {
63 return nullptr;
64 }

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

58 {
59 return nullptr;
60 }

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

48{ 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 79 of file image_decoder_unittests.cc.

79{}

Member Data Documentation

◆ command_buffer_count_

size_t impeller::TestImpellerContext::command_buffer_count_ = 0
mutable

Definition at line 81 of file image_decoder_unittests.cc.


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