#include <context_gles.h>

Inheritance diagram for impeller::ContextGLES:

Public Member Functions
	~ContextGLES () override

BackendType	GetBackendType () const override
	Get the graphics backend of an Impeller context.

const ReactorGLES::Ref &	GetReactor () const

std::optional< ReactorGLES::WorkerID >	AddReactorWorker (const std::shared_ptr< ReactorGLES::Worker > &worker)

bool	RemoveReactorWorker (ReactorGLES::WorkerID id)

std::shared_ptr< GPUTracerGLES >	GetGPUTracer () const

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

virtual bool	UpdateOffscreenLayerPixelFormat (PixelFormat format)

virtual void	StoreTaskForGPU (const std::function< void()> &task)

virtual void	InitializeCommonlyUsedShadersIfNeeded () const

Static Public Member Functions
static std::shared_ptr< ContextGLES >	Create (std::unique_ptr< ProcTableGLES > gl, const std::vector< std::shared_ptr< fml::Mapping > > &shader_libraries, bool enable_gpu_tracing)

Static Public Member Functions inherited from impeller::BackendCast< ContextGLES, Context >
static ContextGLES &	Cast (Context &base)

static const ContextGLES &	Cast (const Context &base)

static ContextGLES *	Cast (Context *base)

static const ContextGLES *	Cast (const Context *base)

Private Member Functions
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.

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

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

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

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

Public Attributes inherited from impeller::Context
CaptureContext	capture

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 22 of file context_gles.h.

Constructor & Destructor Documentation

◆ ~ContextGLES()

impeller::ContextGLES::~ContextGLES ( )

overridedefault

Member Function Documentation

◆ AddReactorWorker()

std::optional< ReactorGLES::WorkerID > impeller::ContextGLES::AddReactorWorker ( const std::shared_ptr< ReactorGLES::Worker > & worker )

Definition at line 85 of file context_gles.cc.

                                                    {
  if (!IsValid()) {
    return std::nullopt;
  }
  return reactor_->AddWorker(worker);
}

◆ Create()

std::shared_ptr< ContextGLES > impeller::ContextGLES::Create	(	std::unique_ptr< ProcTableGLES >	gl,
		const std::vector< std::shared_ptr< fml::Mapping > > &	shader_libraries,
		bool	enable_gpu_tracing
	)

static

Definition at line 16 of file context_gles.cc.

                             {
  return std::shared_ptr<ContextGLES>(
      new ContextGLES(std::move(gl), shader_libraries, enable_gpu_tracing));
}

◆ CreateCommandBuffer()

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

overrideprivatevirtual

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 132 of file context_gles.cc.

                                                                    {
  return std::shared_ptr<CommandBufferGLES>(
      new CommandBufferGLES(weak_from_this(), reactor_));
}

◆ DescribeGpuModel()

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

overrideprivatevirtual

Implements impeller::Context.

Definition at line 107 of file context_gles.cc.

                                              {
  return reactor_->GetProcTable().GetDescription()->GetString();
}

◆ GetBackendType()

Context::BackendType impeller::ContextGLES::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 77 of file context_gles.cc.

                                                     {
  return Context::BackendType::kOpenGLES;
}

◆ GetCapabilities()

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

overrideprivatevirtual

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 138 of file context_gles.cc.

          {
  return device_capabilities_;
}

◆ GetCommandQueue()

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

overrideprivatevirtual

Return the graphics queue for submitting command buffers.

Implements impeller::Context.

Definition at line 144 of file context_gles.cc.

                                                               {
  return command_queue_;
}

◆ GetGPUTracer()

std::shared_ptr< GPUTracerGLES > impeller::ContextGLES::GetGPUTracer ( ) const

inline

Definition at line 44 of file context_gles.h.

44{ return gpu_tracer_; }

◆ GetPipelineLibrary()

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

overrideprivatevirtual

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 127 of file context_gles.cc.

                                                                     {
  return pipeline_library_;
}

◆ GetReactor()

const ReactorGLES::Ref & impeller::ContextGLES::GetReactor ( ) const

Definition at line 81 of file context_gles.cc.

                                                    {
  return reactor_;
}

◆ GetResourceAllocator()

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

overrideprivatevirtual

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 112 of file context_gles.cc.

                                                                 {
  return resource_allocator_;
}

◆ GetSamplerLibrary()

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

overrideprivatevirtual

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 122 of file context_gles.cc.

                                                                   {
  return sampler_library_;
}

◆ GetShaderLibrary()

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

overrideprivatevirtual

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 117 of file context_gles.cc.

                                                                 {
  return shader_library_;
}

◆ IsValid()

bool impeller::ContextGLES::IsValid ( ) const

overrideprivatevirtual

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 100 of file context_gles.cc.

                                {
  return is_valid_;
}

◆ RemoveReactorWorker()

bool impeller::ContextGLES::RemoveReactorWorker ( ReactorGLES::WorkerID id )

Definition at line 93 of file context_gles.cc.

                                                            {
  if (!IsValid()) {
    return false;
  }
  return reactor_->RemoveWorker(id);
}

◆ Shutdown()

void impeller::ContextGLES::Shutdown ( )

overrideprivatevirtual

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

Implements impeller::Context.

Definition at line 104 of file context_gles.cc.

104{}

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

impeller/renderer/backend/gles/context_gles.h
impeller/renderer/backend/gles/context_gles.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~ContextGLES()

Member Function Documentation

◆ AddReactorWorker()

◆ Create()

◆ CreateCommandBuffer()

◆ DescribeGpuModel()

◆ GetBackendType()

◆ GetCapabilities()

◆ GetCommandQueue()

◆ GetGPUTracer()

◆ GetPipelineLibrary()

◆ GetReactor()

◆ GetResourceAllocator()

◆ GetSamplerLibrary()

◆ GetShaderLibrary()

◆ IsValid()

◆ RemoveReactorWorker()

◆ Shutdown()