#include <embedder_test_context_gl.h>

Inheritance diagram for flutter::testing::EmbedderTestContextGL:

Public Types
using	GLGetFBOCallback = std::function< void(FlutterFrameInfo frame_info)>

using	GLPopulateExistingDamageCallback = std::function< void(intptr_t id, FlutterDamage *existing_damage)>

using	GLPresentCallback = std::function< void(FlutterPresentInfo present_info)>

Public Member Functions
	EmbedderTestContextGL (std::string assets_path="")

	~EmbedderTestContextGL () override

size_t	GetSurfacePresentCount () const override

EmbedderTestContextType	GetContextType () const override

void	SetOpenGLFBOCallBack ()

void	SetOpenGLPresentCallBack ()

void	SetGLGetFBOCallback (const GLGetFBOCallback &callback)
	Sets a callback that will be invoked (on the raster task runner) when the engine asks the embedder for a new FBO ID at the updated size.

void	SetGLPopulateExistingDamageCallback (GLPopulateExistingDamageCallback callback)

uint32_t	GetWindowFBOId () const

void	SetGLPresentCallback (GLPresentCallback callback)
	Sets a callback that will be invoked (on the raster task runner) when the engine presents an fbo that was given by the embedder.

void	GLPopulateExistingDamage (const intptr_t id, FlutterDamage *existing_damage)

void *	GLGetProcAddress (const char *name)

Public Member Functions inherited from flutter::testing::EmbedderTestContext
	EmbedderTestContext (std::string assets_path="")

virtual	~EmbedderTestContext ()

const std::string &	GetAssetsPath () const

const fml::Mapping *	GetVMSnapshotData () const

const fml::Mapping *	GetVMSnapshotInstructions () const

const fml::Mapping *	GetIsolateSnapshotData () const

const fml::Mapping *	GetIsolateSnapshotInstructions () const

FlutterEngineAOTData	GetAOTData () const

void	SetRootSurfaceTransformation (DlMatrix matrix)

FlutterRendererConfig &	GetRendererConfig ()

void	AddIsolateCreateCallback (const fml::closure &closure)

void	SetSemanticsUpdateCallback2 (SemanticsUpdateCallback2 update_semantics)

void	SetSemanticsUpdateCallback (SemanticsUpdateCallback update_semantics)

void	AddNativeCallback (const char *name, Dart_NativeFunction function)

void	SetSemanticsNodeCallback (SemanticsNodeCallback update_semantics_node)

void	SetSemanticsCustomActionCallback (SemanticsActionCallback semantics_custom_action)

void	SetPlatformMessageCallback (const std::function< void(const FlutterPlatformMessage *)> &callback)

void	SetLogMessageCallback (const LogMessageCallback &log_message_callback)

void	SetChannelUpdateCallback (const ChannelUpdateCallback &callback)

void	SetViewFocusChangeRequestCallback (const ViewFocusChangeRequestCallback &callback)

std::future< sk_sp< SkImage > >	GetNextSceneImage ()

EmbedderTestCompositor &	GetCompositor ()

void	SetVsyncCallback (std::function< void(intptr_t)> callback)

void	RunVsyncCallback (intptr_t baton)

Additional Inherited Members
Protected Types inherited from flutter::testing::EmbedderTestContext
using	NextSceneCallback = std::function< void(sk_sp< SkImage > image)>

Protected Member Functions inherited from flutter::testing::EmbedderTestContext
FlutterUpdateSemanticsCallback2	GetUpdateSemanticsCallback2Hook ()

FlutterUpdateSemanticsCallback	GetUpdateSemanticsCallbackHook ()

FlutterUpdateSemanticsNodeCallback	GetUpdateSemanticsNodeCallbackHook ()

FlutterUpdateSemanticsCustomActionCallback	GetUpdateSemanticsCustomActionCallbackHook ()

FlutterChannelUpdateCallback	GetChannelUpdateCallbackHook ()

FlutterViewFocusChangeRequestCallback	GetViewFocusChangeRequestCallbackHook ()

void	SetupAOTMappingsIfNecessary ()

void	SetupAOTDataIfNecessary ()

void	FireIsolateCreateCallbacks ()

void	SetNativeResolver ()

FlutterTransformation	GetRootSurfaceTransformation ()

void	PlatformMessageCallback (const FlutterPlatformMessage *message)

void	FireRootSurfacePresentCallbackIfPresent (const std::function< sk_sp< SkImage >(void)> &image_callback)

void	SetNextSceneCallback (const NextSceneCallback &next_scene_callback)

	FML_DISALLOW_COPY_AND_ASSIGN (EmbedderTestContext)

Static Protected Member Functions inherited from flutter::testing::EmbedderTestContext
static VoidCallback	GetIsolateCreateCallbackHook ()

static FlutterLogMessageCallback	GetLogMessageCallbackHook ()

static FlutterComputePlatformResolvedLocaleCallback	GetComputePlatformResolvedLocaleCallbackHook ()

Protected Attributes inherited from flutter::testing::EmbedderTestContext
std::string	assets_path_

ELFAOTSymbols	aot_symbols_

std::unique_ptr< fml::Mapping >	vm_snapshot_data_

std::unique_ptr< fml::Mapping >	vm_snapshot_instructions_

std::unique_ptr< fml::Mapping >	isolate_snapshot_data_

std::unique_ptr< fml::Mapping >	isolate_snapshot_instructions_

UniqueAOTData	aot_data_

std::vector< fml::closure >	isolate_create_callbacks_

std::shared_ptr< TestDartNativeResolver >	native_resolver_

FlutterRendererConfig	renderer_config_ = {}

SemanticsUpdateCallback2	update_semantics_callback2_

SemanticsUpdateCallback	update_semantics_callback_

SemanticsNodeCallback	update_semantics_node_callback_

SemanticsActionCallback	update_semantics_custom_action_callback_

ChannelUpdateCallback	channel_update_callback_

ViewFocusChangeRequestCallback	view_focus_change_request_callback_

std::function< void(const FlutterPlatformMessage *)>	platform_message_callback_

LogMessageCallback	log_message_callback_

std::unique_ptr< EmbedderTestCompositor >	compositor_

NextSceneCallback	next_scene_callback_

DlMatrix	root_surface_transformation_

std::function< void(intptr_t)>	vsync_callback_ = nullptr

Detailed Description

Definition at line 16 of file embedder_test_context_gl.h.

Member Typedef Documentation

◆ GLGetFBOCallback

using flutter::testing::EmbedderTestContextGL::GLGetFBOCallback = std::function<void(FlutterFrameInfo frame_info)>

Definition at line 18 of file embedder_test_context_gl.h.

◆ GLPopulateExistingDamageCallback

using flutter::testing::EmbedderTestContextGL::GLPopulateExistingDamageCallback = std::function<void(intptr_t id, FlutterDamage* existing_damage)>

Definition at line 19 of file embedder_test_context_gl.h.

◆ GLPresentCallback

using flutter::testing::EmbedderTestContextGL::GLPresentCallback = std::function<void(FlutterPresentInfo present_info)>

Definition at line 21 of file embedder_test_context_gl.h.

Constructor & Destructor Documentation

◆ EmbedderTestContextGL()

flutter::testing::EmbedderTestContextGL::EmbedderTestContextGL ( std::string assets_path = "" )

explicit

Definition at line 21 of file embedder_test_context_gl.cc.

    : EmbedderTestContext(std::move(assets_path)),
      egl_context_(std::make_shared<TestEGLContext>()) {
  renderer_config_.type = FlutterRendererType::kOpenGL;
  renderer_config_.open_gl = {
      .struct_size = sizeof(FlutterOpenGLRendererConfig),
      .make_current = [](void* context) -> bool {
        return reinterpret_cast<EmbedderTestContextGL*>(context)
            ->GLMakeCurrent();
      },
      .clear_current = [](void* context) -> bool {
        return reinterpret_cast<EmbedderTestContextGL*>(context)
            ->GLClearCurrent();
      },
      .make_resource_current = [](void* context) -> bool {
        return reinterpret_cast<EmbedderTestContextGL*>(context)
            ->GLMakeResourceCurrent();
      },
      .fbo_reset_after_present = true,
      .surface_transformation = [](void* context) -> FlutterTransformation {
        return reinterpret_cast<EmbedderTestContextGL*>(context)
            ->GetRootSurfaceTransformation();
      },
      .gl_proc_resolver = [](void* context, const char* name) -> void* {
        return reinterpret_cast<EmbedderTestContextGL*>(context)
            ->GLGetProcAddress(name);
      },
      .fbo_with_frame_info_callback =
          [](void* context, const FlutterFrameInfo* frame_info) -> uint32_t {
        return reinterpret_cast<EmbedderTestContextGL*>(context)
            ->GLGetFramebuffer(*frame_info);
      },
      .present_with_info = [](void* context,
                              const FlutterPresentInfo* present_info) -> bool {
        return reinterpret_cast<EmbedderTestContextGL*>(context)->GLPresent(
            *present_info);
      },
      .populate_existing_damage = nullptr,
  };
}

References flutter::testing::EmbedderTestContext::GetRootSurfaceTransformation(), GLGetProcAddress(), kOpenGL, flutter::name, FlutterRendererConfig::open_gl, flutter::testing::EmbedderTestContext::renderer_config_, FlutterOpenGLRendererConfig::struct_size, and FlutterRendererConfig::type.

◆ ~EmbedderTestContextGL()

flutter::testing::EmbedderTestContextGL::~EmbedderTestContextGL ( )

override

Definition at line 62 of file embedder_test_context_gl.cc.

                                              {
  SetGLGetFBOCallback(nullptr);
}

References SetGLGetFBOCallback().

Member Function Documentation

◆ GetContextType()

EmbedderTestContextType flutter::testing::EmbedderTestContextGL::GetContextType ( ) const

overridevirtual

Implements flutter::testing::EmbedderTestContext.

Definition at line 189 of file embedder_test_context_gl.cc.

                                                                    {
  return EmbedderTestContextType::kOpenGLContext;
}

References flutter::testing::kOpenGLContext.

◆ GetSurfacePresentCount()

size_t flutter::testing::EmbedderTestContextGL::GetSurfacePresentCount ( ) const

overridevirtual

Implements flutter::testing::EmbedderTestContext.

Definition at line 185 of file embedder_test_context_gl.cc.

                                                           {
  return gl_surface_present_count_;
}

◆ GetWindowFBOId()

uint32_t flutter::testing::EmbedderTestContextGL::GetWindowFBOId ( ) const

Definition at line 193 of file embedder_test_context_gl.cc.

                                                     {
  FML_CHECK(gl_surface_);
  return gl_surface_->GetWindowFBOId();
}

References FML_CHECK.

◆ GLGetProcAddress()

void * flutter::testing::EmbedderTestContextGL::GLGetProcAddress ( const char * name )

Definition at line 180 of file embedder_test_context_gl.cc.

                                                              {
  FML_CHECK(gl_surface_) << "GL surface must be initialized.";
  return gl_surface_->GetProcAddress(name);
}

References FML_CHECK, and flutter::name.

Referenced by EmbedderTestContextGL().

◆ GLPopulateExistingDamage()

void flutter::testing::EmbedderTestContextGL::GLPopulateExistingDamage	(	const intptr_t	id,
		FlutterDamage *	existing_damage
	)

Definition at line 159 of file embedder_test_context_gl.cc.

                                    {
  FML_CHECK(gl_surface_) << "GL surface must be initialized.";
 
  GLPopulateExistingDamageCallback callback;
  {
    std::scoped_lock lock(gl_callback_mutex_);
    callback = gl_populate_existing_damage_callback_;
  }
 
  if (callback) {
    callback(id, existing_damage);
  }
}

References callback, and FML_CHECK.

◆ SetGLGetFBOCallback()

void flutter::testing::EmbedderTestContextGL::SetGLGetFBOCallback ( const GLGetFBOCallback & callback )

Sets a callback that will be invoked (on the raster task runner) when the engine asks the embedder for a new FBO ID at the updated size.

Attention: The callback will be invoked on the raster task runner. The callback can be set on the tests host thread.

Parameters

[in] callback The callback to set. The previous callback will be un-registered.

Definition at line 125 of file embedder_test_context_gl.cc.

                                      {
  std::scoped_lock lock(gl_callback_mutex_);
  gl_get_fbo_callback_ = callback;
}

References callback.

Referenced by ~EmbedderTestContextGL().

◆ SetGLPopulateExistingDamageCallback()

void flutter::testing::EmbedderTestContextGL::SetGLPopulateExistingDamageCallback ( GLPopulateExistingDamageCallback callback )

Definition at line 131 of file embedder_test_context_gl.cc.

                                               {
  std::scoped_lock lock(gl_callback_mutex_);
  gl_populate_existing_damage_callback_ = std::move(callback);
}

References callback.

Referenced by flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), and flutter::testing::TEST_F().

◆ SetGLPresentCallback()

void flutter::testing::EmbedderTestContextGL::SetGLPresentCallback ( GLPresentCallback callback )

Sets a callback that will be invoked (on the raster task runner) when the engine presents an fbo that was given by the embedder.

Attention: The callback will be invoked on the raster task runner. The callback can be set on the tests host thread.

Parameters

[in] callback The callback to set. The previous callback will be un-registered.

Definition at line 137 of file embedder_test_context_gl.cc.

                                                                           {
  std::scoped_lock lock(gl_callback_mutex_);
  gl_present_callback_ = std::move(callback);
}

References callback.

◆ SetOpenGLFBOCallBack()

void flutter::testing::EmbedderTestContextGL::SetOpenGLFBOCallBack ( )

Definition at line 66 of file embedder_test_context_gl.cc.

                                                 {
  // SetOpenGLRendererConfig must be called before this.
  FML_CHECK(renderer_config_.type == FlutterRendererType::kOpenGL);
 
  renderer_config_.open_gl.fbo_callback = [](void* context) -> uint32_t {
    FlutterFrameInfo frame_info = {};
    // fbo_callback doesn't use the frame size information, only
    // fbo_callback_with_frame_info does.
    frame_info.struct_size = sizeof(FlutterFrameInfo);
    frame_info.size.width = 0;
    frame_info.size.height = 0;
    return reinterpret_cast<EmbedderTestContextGL*>(context)->GLGetFramebuffer(
        frame_info);
  };
}

References FlutterOpenGLRendererConfig::fbo_callback, FML_CHECK, FlutterUIntSize::height, kOpenGL, FlutterRendererConfig::open_gl, flutter::testing::EmbedderTestContext::renderer_config_, FlutterFrameInfo::size, FlutterFrameInfo::struct_size, FlutterRendererConfig::type, and FlutterUIntSize::width.

◆ SetOpenGLPresentCallBack()

void flutter::testing::EmbedderTestContextGL::SetOpenGLPresentCallBack ( )

Definition at line 82 of file embedder_test_context_gl.cc.

                                                     {
  // SetOpenGLRendererConfig must be called before this.
  FML_CHECK(renderer_config_.type == FlutterRendererType::kOpenGL);
 
  renderer_config_.open_gl.present = [](void* context) -> bool {
    // passing a placeholder fbo_id.
    return reinterpret_cast<EmbedderTestContextGL*>(context)->GLPresent(
        FlutterPresentInfo{
            .fbo_id = 0,
        });
  };
}

References FlutterPresentInfo::fbo_id, FML_CHECK, kOpenGL, FlutterRendererConfig::open_gl, FlutterOpenGLRendererConfig::present, flutter::testing::EmbedderTestContext::renderer_config_, and FlutterRendererConfig::type.

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

shell/platform/embedder/tests/embedder_test_context_gl.h
shell/platform/embedder/tests/embedder_test_context_gl.cc

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ GLGetFBOCallback

◆ GLPopulateExistingDamageCallback

◆ GLPresentCallback

Constructor & Destructor Documentation

◆ EmbedderTestContextGL()

◆ ~EmbedderTestContextGL()

Member Function Documentation

◆ GetContextType()

◆ GetSurfacePresentCount()

◆ GetWindowFBOId()

◆ GLGetProcAddress()

◆ GLPopulateExistingDamage()

◆ SetGLGetFBOCallback()

◆ SetGLPopulateExistingDamageCallback()

◆ SetGLPresentCallback()

◆ SetOpenGLFBOCallBack()

◆ SetOpenGLPresentCallBack()