#include <android_surface_gl_skia.h>

Inheritance diagram for flutter::AndroidSurfaceGLSkia:

Public Member Functions
	AndroidSurfaceGLSkia (const std::shared_ptr< AndroidContextGLSkia > &android_context)

	~AndroidSurfaceGLSkia () override

bool	IsValid () const override

std::unique_ptr< Surface >	CreateGPUSurface (GrDirectContext *gr_context) override

void	TeardownOnScreenContext () override

bool	OnScreenSurfaceResize (const SkISize &size) override

bool	ResourceContextMakeCurrent () override

bool	ResourceContextClearCurrent () override

bool	SetNativeWindow (fml::RefPtr< AndroidNativeWindow > window) override

virtual std::unique_ptr< Surface >	CreateSnapshotSurface () override

std::unique_ptr< GLContextResult >	GLContextMakeCurrent () override

bool	GLContextClearCurrent () override

SurfaceFrame::FramebufferInfo	GLContextFramebufferInfo () const override

void	GLContextSetDamageRegion (const std::optional< SkIRect > &region) override

bool	GLContextPresent (const GLPresentInfo &present_info) override

GLFBOInfo	GLContextFBO (GLFrameInfo frame_info) const override

sk_sp< const GrGLInterface >	GetGLInterface () const override

AndroidEGLSurface *	GetOnscreenSurface () const

Public Member Functions inherited from flutter::GPUSurfaceGLDelegate
	~GPUSurfaceGLDelegate ()

virtual std::unique_ptr< GLContextResult >	GLContextMakeCurrent ()=0

virtual bool	GLContextClearCurrent ()=0

virtual void	GLContextSetDamageRegion (const std::optional< SkIRect > &region)

virtual bool	GLContextPresent (const GLPresentInfo &present_info)=0

virtual GLFBOInfo	GLContextFBO (GLFrameInfo frame_info) const =0

virtual bool	GLContextFBOResetAfterPresent () const

virtual SurfaceFrame::FramebufferInfo	GLContextFramebufferInfo () const

virtual SkMatrix	GLContextSurfaceTransformation () const

virtual sk_sp< const GrGLInterface >	GetGLInterface () const

virtual GLProcResolver	GetGLProcResolver () const

virtual bool	AllowsDrawingWhenGpuDisabled () const

Public Member Functions inherited from flutter::AndroidSurface
virtual	~AndroidSurface ()

virtual bool	IsValid () const =0

virtual void	TeardownOnScreenContext ()=0

virtual std::unique_ptr< Surface >	CreateGPUSurface (GrDirectContext *gr_context=nullptr)=0

virtual bool	OnScreenSurfaceResize (const SkISize &size)=0

virtual bool	ResourceContextMakeCurrent ()=0

virtual bool	ResourceContextClearCurrent ()=0

virtual bool	SetNativeWindow (fml::RefPtr< AndroidNativeWindow > window)=0

virtual std::unique_ptr< Surface >	CreateSnapshotSurface ()

virtual std::shared_ptr< impeller::Context >	GetImpellerContext ()

Additional Inherited Members
Public Types inherited from flutter::GPUSurfaceGLDelegate
using	GLProcResolver = std::function< void (const char )>

Static Public Member Functions inherited from flutter::GPUSurfaceGLDelegate
static sk_sp< const GrGLInterface >	GetDefaultPlatformGLInterface ()

Protected Member Functions inherited from flutter::AndroidSurface
	AndroidSurface ()

Detailed Description

Definition at line 21 of file android_surface_gl_skia.h.

Constructor & Destructor Documentation

◆ AndroidSurfaceGLSkia()

flutter::AndroidSurfaceGLSkia::AndroidSurfaceGLSkia ( const std::shared_ptr< AndroidContextGLSkia > & android_context )

explicit

Definition at line 23 of file android_surface_gl_skia.cc.

    : android_context_(android_context),
      native_window_(nullptr),
      onscreen_surface_(nullptr),
      offscreen_surface_(nullptr) {
  // Acquire the offscreen surface.
  offscreen_surface_ = android_context_->CreateOffscreenSurface();
  if (!offscreen_surface_->IsValid()) {
    offscreen_surface_ = nullptr;
  }
}

◆ ~AndroidSurfaceGLSkia()

flutter::AndroidSurfaceGLSkia::~AndroidSurfaceGLSkia ( )

overridedefault

Member Function Documentation

◆ CreateGPUSurface()

std::unique_ptr< Surface > flutter::AndroidSurfaceGLSkia::CreateGPUSurface ( GrDirectContext * gr_context )

overridevirtual

Implements flutter::AndroidSurface.

Definition at line 50 of file android_surface_gl_skia.cc.

                                 {
  if (gr_context) {
    return std::make_unique<GPUSurfaceGLSkia>(sk_ref_sp(gr_context), this,
                                              true);
  } else {
    sk_sp<GrDirectContext> main_skia_context =
        android_context_->GetMainSkiaContext();
    if (!main_skia_context) {
      main_skia_context = GPUSurfaceGLSkia::MakeGLContext(this);
      android_context_->SetMainSkiaContext(main_skia_context);
    }
    return std::make_unique<GPUSurfaceGLSkia>(main_skia_context, this, true);
  }
}

◆ CreateSnapshotSurface()

std::unique_ptr< Surface > flutter::AndroidSurfaceGLSkia::CreateSnapshotSurface ( )

overridevirtual

Reimplemented from flutter::AndroidSurface.

Definition at line 206 of file android_surface_gl_skia.cc.

                                                                   {
  if (!onscreen_surface_ || !onscreen_surface_->IsValid()) {
    onscreen_surface_ = android_context_->CreatePbufferSurface();
  }
  sk_sp<GrDirectContext> main_skia_context =
      android_context_->GetMainSkiaContext();
  if (!main_skia_context) {
    main_skia_context = GPUSurfaceGLSkia::MakeGLContext(this);
    android_context_->SetMainSkiaContext(main_skia_context);
  }
 
  return std::make_unique<GPUSurfaceGLSkia>(main_skia_context, this, true);
}

◆ GetGLInterface()

sk_sp< const GrGLInterface > flutter::AndroidSurfaceGLSkia::GetGLInterface ( ) const

overridevirtual

Reimplemented from flutter::GPUSurfaceGLDelegate.

Definition at line 174 of file android_surface_gl_skia.cc.

                                                                      {
  // This is a workaround for a bug in the Android emulator EGL/GLES
  // implementation.  Some versions of the emulator will not update the
  // GL version string when the process switches to a new EGL context
  // unless the EGL context is being made current for the first time.
  // The inaccurate version string will be rejected by Skia when it
  // tries to build the GrGLInterface.  Flutter can work around this
  // by creating a new context, making it current to force an update
  // of the version, and then reverting to the previous context.
  const char* gl_renderer =
      reinterpret_cast<const char*>(glGetString(GL_RENDERER));
  if (gl_renderer && strncmp(gl_renderer, kEmulatorRendererPrefix,
                             strlen(kEmulatorRendererPrefix)) == 0) {
    EGLContext new_context = android_context_->CreateNewContext();
    if (new_context != EGL_NO_CONTEXT) {
      EGLContext old_context = eglGetCurrentContext();
      EGLDisplay display = eglGetCurrentDisplay();
      EGLSurface draw_surface = eglGetCurrentSurface(EGL_DRAW);
      EGLSurface read_surface = eglGetCurrentSurface(EGL_READ);
      [[maybe_unused]] EGLBoolean result =
          eglMakeCurrent(display, draw_surface, read_surface, new_context);
      FML_DCHECK(result == EGL_TRUE);
      result = eglMakeCurrent(display, draw_surface, read_surface, old_context);
      FML_DCHECK(result == EGL_TRUE);
      result = eglDestroyContext(display, new_context);
      FML_DCHECK(result == EGL_TRUE);
    }
  }
 
  return GPUSurfaceGLDelegate::GetGLInterface();
}

◆ GetOnscreenSurface()

AndroidEGLSurface * flutter::AndroidSurfaceGLSkia::GetOnscreenSurface ( ) const

inline

Definition at line 79 of file android_surface_gl_skia.h.

                                                {
    return onscreen_surface_.get();
  }

◆ GLContextClearCurrent()

bool flutter::AndroidSurfaceGLSkia::GLContextClearCurrent ( )

overridevirtual

Implements flutter::GPUSurfaceGLDelegate.

Definition at line 127 of file android_surface_gl_skia.cc.

                                                 {
  FML_DCHECK(IsValid());
  return android_context_->ClearCurrent();
}

◆ GLContextFBO()

GLFBOInfo flutter::AndroidSurfaceGLSkia::GLContextFBO ( GLFrameInfo frame_info ) const

overridevirtual

Implements flutter::GPUSurfaceGLDelegate.

Definition at line 164 of file android_surface_gl_skia.cc.

                                                                         {
  FML_DCHECK(IsValid());
  // The default window bound framebuffer on Android.
  return GLFBOInfo{
      .fbo_id = 0,
      .existing_damage = onscreen_surface_->InitialDamage(),
  };
}

◆ GLContextFramebufferInfo()

SurfaceFrame::FramebufferInfo flutter::AndroidSurfaceGLSkia::GLContextFramebufferInfo ( ) const

overridevirtual

Reimplemented from flutter::GPUSurfaceGLDelegate.

Definition at line 132 of file android_surface_gl_skia.cc.

          {
  FML_DCHECK(IsValid());
  SurfaceFrame::FramebufferInfo res;
  res.supports_readback = true;
  res.supports_partial_repaint = onscreen_surface_->SupportsPartialRepaint();
  res.existing_damage = onscreen_surface_->InitialDamage();
  // Some devices (Pixel2 XL) needs EGL_KHR_partial_update rect aligned to 4,
  // otherwise there are glitches
  // (https://github.com/flutter/flutter/issues/97482#)
  // Larger alignment might also be beneficial for tile base renderers.
  res.horizontal_clip_alignment = 32;
  res.vertical_clip_alignment = 32;
 
  return res;
}

◆ GLContextMakeCurrent()

std::unique_ptr< GLContextResult > flutter::AndroidSurfaceGLSkia::GLContextMakeCurrent ( )

overridevirtual

Implements flutter::GPUSurfaceGLDelegate.

Definition at line 118 of file android_surface_gl_skia.cc.

                                                                          {
  FML_DCHECK(IsValid());
  FML_DCHECK(onscreen_surface_);
  auto status = onscreen_surface_->MakeCurrent();
  auto default_context_result = std::make_unique<GLContextDefaultResult>(
      status != AndroidEGLSurfaceMakeCurrentStatus::kFailure);
  return std::move(default_context_result);
}

◆ GLContextPresent()

bool flutter::AndroidSurfaceGLSkia::GLContextPresent ( const GLPresentInfo & present_info )

overridevirtual

Implements flutter::GPUSurfaceGLDelegate.

Definition at line 155 of file android_surface_gl_skia.cc.

                                                                             {
  FML_DCHECK(IsValid());
  FML_DCHECK(onscreen_surface_);
  if (present_info.presentation_time) {
    onscreen_surface_->SetPresentationTime(*present_info.presentation_time);
  }
  return onscreen_surface_->SwapBuffers(present_info.frame_damage);
}

◆ GLContextSetDamageRegion()

void flutter::AndroidSurfaceGLSkia::GLContextSetDamageRegion ( const std::optional< SkIRect > & region )

overridevirtual

Reimplemented from flutter::GPUSurfaceGLDelegate.

Definition at line 149 of file android_surface_gl_skia.cc.

                                        {
  FML_DCHECK(IsValid());
  onscreen_surface_->SetDamageRegion(region);
}

◆ IsValid()

bool flutter::AndroidSurfaceGLSkia::IsValid ( ) const

overridevirtual

Implements flutter::AndroidSurface.

Definition at line 46 of file android_surface_gl_skia.cc.

                                         {
  return offscreen_surface_ && android_context_->IsValid();
}

◆ OnScreenSurfaceResize()

bool flutter::AndroidSurfaceGLSkia::OnScreenSurfaceResize ( const SkISize & size )

overridevirtual

Implements flutter::AndroidSurface.

Definition at line 66 of file android_surface_gl_skia.cc.

                                                                    {
  FML_DCHECK(IsValid());
  FML_DCHECK(onscreen_surface_);
  FML_DCHECK(native_window_);
 
  if (size == onscreen_surface_->GetSize()) {
    return true;
  }
 
  android_context_->ClearCurrent();
 
  // Ensure the destructor is called since it destroys the `EGLSurface` before
  // creating a new onscreen surface.
  onscreen_surface_ = nullptr;
  onscreen_surface_ = android_context_->CreateOnscreenSurface(native_window_);
  if (!onscreen_surface_->IsValid()) {
    FML_LOG(ERROR) << "Unable to create EGL window surface on resize.";
    return false;
  }
  onscreen_surface_->MakeCurrent();
  return true;
}

◆ ResourceContextClearCurrent()

bool flutter::AndroidSurfaceGLSkia::ResourceContextClearCurrent ( )

overridevirtual

Implements flutter::AndroidSurface.

Definition at line 95 of file android_surface_gl_skia.cc.

                                                       {
  FML_DCHECK(IsValid());
  EGLBoolean result = eglMakeCurrent(eglGetCurrentDisplay(), EGL_NO_SURFACE,
                                     EGL_NO_SURFACE, EGL_NO_CONTEXT);
  return result == EGL_TRUE;
}

◆ ResourceContextMakeCurrent()

bool flutter::AndroidSurfaceGLSkia::ResourceContextMakeCurrent ( )

overridevirtual

Implements flutter::AndroidSurface.

Definition at line 89 of file android_surface_gl_skia.cc.

                                                      {
  FML_DCHECK(IsValid());
  auto status = offscreen_surface_->MakeCurrent();
  return status != AndroidEGLSurfaceMakeCurrentStatus::kFailure;
}

◆ SetNativeWindow()

bool flutter::AndroidSurfaceGLSkia::SetNativeWindow ( fml::RefPtr< AndroidNativeWindow > window )

overridevirtual

Implements flutter::AndroidSurface.

Definition at line 102 of file android_surface_gl_skia.cc.

                                           {
  FML_DCHECK(IsValid());
  FML_DCHECK(window);
  native_window_ = window;
  // Ensure the destructor is called since it destroys the `EGLSurface` before
  // creating a new onscreen surface.
  onscreen_surface_ = nullptr;
  // Create the onscreen surface.
  onscreen_surface_ = android_context_->CreateOnscreenSurface(window);
  if (!onscreen_surface_->IsValid()) {
    return false;
  }
  return true;
}

◆ TeardownOnScreenContext()

void flutter::AndroidSurfaceGLSkia::TeardownOnScreenContext ( )

overridevirtual

Implements flutter::AndroidSurface.

Definition at line 38 of file android_surface_gl_skia.cc.

                                                   {
  // When the onscreen surface is destroyed, the context and the surface
  // instance should be deleted. Issue:
  // https://github.com/flutter/flutter/issues/64414
  android_context_->ClearCurrent();
  onscreen_surface_ = nullptr;
}

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

shell/platform/android/android_surface_gl_skia.h
shell/platform/android/android_surface_gl_skia.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AndroidSurfaceGLSkia()

◆ ~AndroidSurfaceGLSkia()

Member Function Documentation

◆ CreateGPUSurface()

◆ CreateSnapshotSurface()

◆ GetGLInterface()

◆ GetOnscreenSurface()

◆ GLContextClearCurrent()

◆ GLContextFBO()

◆ GLContextFramebufferInfo()

◆ GLContextMakeCurrent()

◆ GLContextPresent()

◆ GLContextSetDamageRegion()

◆ IsValid()

◆ OnScreenSurfaceResize()

◆ ResourceContextClearCurrent()

◆ ResourceContextMakeCurrent()

◆ SetNativeWindow()

◆ TeardownOnScreenContext()