flutter::AndroidEGLSurface Class Reference

#include <android_egl_surface.h>

Public Member Functions
	AndroidEGLSurface (EGLSurface surface, EGLDisplay display, EGLContext context)
	~AndroidEGLSurface ()
bool	IsValid () const
AndroidEGLSurfaceMakeCurrentStatus	MakeCurrent () const
	Binds the EGLContext context to the current rendering thread and to the draw and read surface.
bool	SupportsPartialRepaint () const
std::optional< DlIRect >	InitialDamage ()
	This is the minimal area that needs to be repainted to get correct result.
void	SetDamageRegion (const std::optional< DlIRect > &buffer_damage)
	Sets the damage region for current surface. Corresponds to.
bool	SetPresentationTime (const fml::TimePoint &presentation_time)
	Sets the presentation time for the current surface. This.
bool	SwapBuffers (const std::optional< DlIRect > &surface_damage)
	This only applies to on-screen surfaces such as those created by AndroidContextGL::CreateOnscreenSurface.
DlISize	GetSize () const

Detailed Description

Definition at line 41 of file android_egl_surface.h.

Constructor & Destructor Documentation

AndroidEGLSurface()

flutter::AndroidEGLSurface::AndroidEGLSurface	(	EGLSurface	surface,
		EGLDisplay	display,
		EGLContext	context
	)

Definition at line 86 of file android_egl_surface.cc.

    : surface_(surface),
      display_(display),
      context_(context),
      damage_(std::make_unique<AndroidEGLSurfaceDamage>()) {
  damage_->init(display_, context);
}

References surface.

~AndroidEGLSurface()

flutter::AndroidEGLSurface::~AndroidEGLSurface

(

)

Definition at line 96 of file android_egl_surface.cc.

                                      {
  [[maybe_unused]] auto result = eglDestroySurface(display_, surface_);
  FML_DCHECK(result == EGL_TRUE);
}

References FML_DCHECK.

Member Function Documentation

GetSize()

DlISize flutter::AndroidEGLSurface::GetSize

(

)

const

Returns

The size of an EGLSurface.

Definition at line 170 of file android_egl_surface.cc.

                                         {
  EGLint width = 0;
  EGLint height = 0;
 
  if (!eglQuerySurface(display_, surface_, EGL_WIDTH, &width) ||
      !eglQuerySurface(display_, surface_, EGL_HEIGHT, &height)) {
    FML_LOG(ERROR) << "Unable to query EGL surface size";
    LogLastEGLError();
    return DlISize();
  }
  return DlISize(width, height);
}

References FML_LOG, height, flutter::LogLastEGLError(), and width.

InitialDamage()

std::optional< DlIRect > flutter::AndroidEGLSurface::InitialDamage

(

)

This is the minimal area that needs to be repainted to get correct result.

With double or triple buffering this buffer content may lag behind current front buffer and the rect accounts for accumulated damage.

Returns

The area of current surface where it is behind front buffer.

Definition at line 166 of file android_egl_surface.cc.

                                                      {
  return damage_->InitialDamage(display_, surface_);
}

IsValid()

bool flutter::AndroidEGLSurface::IsValid

(

)

const

Returns

Whether the current EGLSurface reference is valid. That is, if the surface doesn't point to EGL_NO_SURFACE.

Definition at line 101 of file android_egl_surface.cc.

                                      {
  return surface_ != EGL_NO_SURFACE;
}

MakeCurrent()

AndroidEGLSurfaceMakeCurrentStatus flutter::AndroidEGLSurface::MakeCurrent

(

)

const

Binds the EGLContext context to the current rendering thread and to the draw and read surface.

Returns

Whether the surface was made current.

Definition at line 129 of file android_egl_surface.cc.

                                                                        {
  if (IsContextCurrent()) {
    return AndroidEGLSurfaceMakeCurrentStatus::kSuccessAlreadyCurrent;
  }
  if (eglMakeCurrent(display_, surface_, surface_, context_) != EGL_TRUE) {
    FML_LOG(ERROR) << "Could not make the context current";
    LogLastEGLError();
    return AndroidEGLSurfaceMakeCurrentStatus::kFailure;
  }
  return AndroidEGLSurfaceMakeCurrentStatus::kSuccessMadeCurrent;
}

References FML_LOG, flutter::kFailure, flutter::kSuccessAlreadyCurrent, flutter::kSuccessMadeCurrent, and flutter::LogLastEGLError().

SetDamageRegion()

void flutter::AndroidEGLSurface::SetDamageRegion

(

const std::optional< DlIRect > &

buffer_damage

)

Sets the damage region for current surface. Corresponds to.

Definition at line 141 of file android_egl_surface.cc.

                                               {
  damage_->SetDamageRegion(display_, surface_, buffer_damage);
}

SetPresentationTime()

bool flutter::AndroidEGLSurface::SetPresentationTime

(

const fml::TimePoint &

presentation_time

)

Sets the presentation time for the current surface. This.

Definition at line 146 of file android_egl_surface.cc.

                                           {
  if (presentation_time_proc_) {
    const auto time_ns = presentation_time.ToEpochDelta().ToNanoseconds();
    return presentation_time_proc_(display_, surface_, time_ns);
  } else {
    return false;
  }
}

References fml::TimePoint::ToEpochDelta(), and fml::TimeDelta::ToNanoseconds().

SupportsPartialRepaint()

bool flutter::AndroidEGLSurface::SupportsPartialRepaint

(

)

const

Returns

Whether target surface supports partial repaint.

Definition at line 162 of file android_egl_surface.cc.

                                                     {
  return damage_->SupportsPartialRepaint();
}

SwapBuffers()

bool flutter::AndroidEGLSurface::SwapBuffers

(

const std::optional< DlIRect > &

surface_damage

)

This only applies to on-screen surfaces such as those created by AndroidContextGL::CreateOnscreenSurface.

Returns

Whether the EGL surface color buffer was swapped.

Definition at line 156 of file android_egl_surface.cc.

                                                {
  TRACE_EVENT0("flutter", "AndroidContextGL::SwapBuffers");
  return damage_->SwapBuffersWithDamage(display_, surface_, surface_damage);
}

References TRACE_EVENT0.

---

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

• shell/platform/android/android_egl_surface.h
• shell/platform/android/android_egl_surface.cc