flutter::SurfaceTextureExternalTexture Class Reference

#include <surface_texture_external_texture.h>

Inheritance diagram for flutter::SurfaceTextureExternalTexture:

Public Member Functions
	SurfaceTextureExternalTexture (int64_t id, const fml::jni::ScopedJavaGlobalRef< jobject > &surface_texture, const std::shared_ptr< PlatformViewAndroidJNI > &jni_facade)
	~SurfaceTextureExternalTexture () override
void	Paint (PaintContext &context, const SkRect &bounds, bool freeze, const DlImageSampling sampling) override
void	OnGrContextCreated () override
void	OnGrContextDestroyed () override
void	MarkNewFrameAvailable () override
void	OnTextureUnregistered () override
Public Member Functions inherited from flutter::Texture
	Texture (int64_t id)
virtual	~Texture ()
int64_t	Id ()
Public Member Functions inherited from flutter::ContextListener
	ContextListener ()
	~ContextListener ()

Protected Types
enum class	AttachmentState { kUninitialized , kAttached , kDetached }

Protected Member Functions
virtual void	ProcessFrame (PaintContext &context, const SkRect &bounds)=0
virtual void	Detach ()
void	Attach (int gl_tex_id)
bool	ShouldUpdate ()
void	Update ()
	FML_DISALLOW_COPY_AND_ASSIGN (SurfaceTextureExternalTexture)

Protected Attributes
std::shared_ptr< PlatformViewAndroidJNI >	jni_facade_
fml::jni::ScopedJavaGlobalRef< jobject >	surface_texture_
AttachmentState	state_ = AttachmentState::kUninitialized
SkMatrix	transform_
sk_sp< flutter::DlImage >	dl_image_

Detailed Description

Definition at line 16 of file surface_texture_external_texture.h.

Member Enumeration Documentation

AttachmentState

enum class flutter::SurfaceTextureExternalTexture::AttachmentState

strongprotected

Enumerator
kUninitialized
kAttached
kDetached

Definition at line 46 of file surface_texture_external_texture.h.

{ kUninitialized, kAttached, kDetached };

Constructor & Destructor Documentation

SurfaceTextureExternalTexture()

flutter::SurfaceTextureExternalTexture::SurfaceTextureExternalTexture	(	int64_t	id,
		const fml::jni::ScopedJavaGlobalRef< jobject > &	surface_texture,
		const std::shared_ptr< PlatformViewAndroidJNI > &	jni_facade
	)

Definition at line 24 of file surface_texture_external_texture.cc.

    : Texture(id),
      jni_facade_(jni_facade),
      surface_texture_(surface_texture),
      transform_(SkMatrix::I()) {}

~SurfaceTextureExternalTexture()

flutter::SurfaceTextureExternalTexture::~SurfaceTextureExternalTexture ( )

override

Definition at line 33 of file surface_texture_external_texture.cc.

{}

Member Function Documentation

Attach()

void flutter::SurfaceTextureExternalTexture::Attach ( int  gl_tex_id )

protected

Definition at line 100 of file surface_texture_external_texture.cc.

                                                        {
  jni_facade_->SurfaceTextureAttachToGLContext(
      fml::jni::ScopedJavaLocalRef<jobject>(surface_texture_), gl_tex_id);
  state_ = AttachmentState::kAttached;
}

Detach()

void flutter::SurfaceTextureExternalTexture::Detach ( )

protectedvirtual

Reimplemented in flutter::SurfaceTextureExternalTextureGL, and flutter::SurfaceTextureExternalTextureImpellerGL.

Definition at line 94 of file surface_texture_external_texture.cc.

                                           {
  jni_facade_->SurfaceTextureDetachFromGLContext(
      fml::jni::ScopedJavaLocalRef<jobject>(surface_texture_));
  dl_image_.reset();
}

FML_DISALLOW_COPY_AND_ASSIGN()

flutter::SurfaceTextureExternalTexture::FML_DISALLOW_COPY_AND_ASSIGN ( SurfaceTextureExternalTexture  )

protected

MarkNewFrameAvailable()

void flutter::SurfaceTextureExternalTexture::MarkNewFrameAvailable ( )

overridevirtual

Implements flutter::Texture.

Definition at line 39 of file surface_texture_external_texture.cc.

                                                          {
  // NOOP.
}

OnGrContextCreated()

void flutter::SurfaceTextureExternalTexture::OnGrContextCreated ( )

overridevirtual

Implements flutter::ContextListener.

Definition at line 35 of file surface_texture_external_texture.cc.

                                                       {
  state_ = AttachmentState::kUninitialized;
}

OnGrContextDestroyed()

void flutter::SurfaceTextureExternalTexture::OnGrContextDestroyed ( )

overridevirtual

Implements flutter::ContextListener.

Definition at line 85 of file surface_texture_external_texture.cc.

                                                         {
  if (state_ == AttachmentState::kAttached) {
    Detach();
  }
  state_ = AttachmentState::kDetached;
}

OnTextureUnregistered()

void flutter::SurfaceTextureExternalTexture::OnTextureUnregistered ( )

overridevirtual

Implements flutter::Texture.

Definition at line 92 of file surface_texture_external_texture.cc.

{}

Paint()

void flutter::SurfaceTextureExternalTexture::Paint ( PaintContext &  context, const SkRect &  bounds, bool  freeze, const DlImageSampling  sampling  )

overridevirtual

Implements flutter::Texture.

Definition at line 43 of file surface_texture_external_texture.cc.

                                                                          {
  if (state_ == AttachmentState::kDetached) {
    return;
  }
  const bool should_process_frame =
      !freeze || ShouldUpdate() || dl_image_ == nullptr;
  if (should_process_frame) {
    ProcessFrame(context, bounds);
  }
  FML_CHECK(state_ == AttachmentState::kAttached);
 
  if (dl_image_) {
    DlAutoCanvasRestore autoRestore(context.canvas, true);
 
    // The incoming texture is vertically flipped, so we flip it
    // back. OpenGL's coordinate system has Positive Y equivalent to up, while
    // Skia's coordinate system has Negative Y equvalent to up.
    context.canvas->Translate(bounds.x(), bounds.y() + bounds.height());
    context.canvas->Scale(bounds.width(), -bounds.height());
 
    if (!transform_.isIdentity()) {
      DlImageColorSource source(dl_image_, DlTileMode::kClamp,
                                DlTileMode::kClamp, sampling, &transform_);
 
      DlPaint paintWithShader;
      if (context.paint) {
        paintWithShader = *context.paint;
      }
      paintWithShader.setColorSource(&source);
      context.canvas->DrawRect(SkRect::MakeWH(1, 1), paintWithShader);
    } else {
      context.canvas->DrawImage(dl_image_, {0, 0}, sampling, context.paint);
    }
  } else {
    FML_LOG(WARNING)
        << "No DlImage available for SurfaceTextureExternalTexture to paint.";
  }
}

ProcessFrame()

virtual void flutter::SurfaceTextureExternalTexture::ProcessFrame ( PaintContext &  context, const SkRect &  bounds  )

protectedpure virtual

Implemented in flutter::SurfaceTextureExternalTextureGL, and flutter::SurfaceTextureExternalTextureImpellerGL.

ShouldUpdate()

bool flutter::SurfaceTextureExternalTexture::ShouldUpdate ( )

protected

Definition at line 106 of file surface_texture_external_texture.cc.

                                                 {
  return jni_facade_->SurfaceTextureShouldUpdate(
      fml::jni::ScopedJavaLocalRef<jobject>(surface_texture_));
}

Update()

void flutter::SurfaceTextureExternalTexture::Update ( )

protected

Definition at line 111 of file surface_texture_external_texture.cc.

                                           {
  jni_facade_->SurfaceTextureUpdateTexImage(
      fml::jni::ScopedJavaLocalRef<jobject>(surface_texture_));
 
  jni_facade_->SurfaceTextureGetTransformMatrix(
      fml::jni::ScopedJavaLocalRef<jobject>(surface_texture_), transform_);
 
  // Android's SurfaceTexture transform matrix works on texture coordinate
  // lookups in the range 0.0-1.0, while Skia's Shader transform matrix works on
  // the image itself, as if it were inscribed inside a clip rect.
  // An Android transform that scales lookup by 0.5 (displaying 50% of the
  // texture) is the same as a Skia transform by 2.0 (scaling 50% of the image
  // outside of the virtual "clip rect"), so we invert the incoming matrix.
  SkMatrix inverted;
  if (!transform_.invert(&inverted)) {
    FML_LOG(FATAL)
        << "Invalid (not invertable) SurfaceTexture transformation matrix";
  }
  transform_ = inverted;
}

Member Data Documentation

dl_image_

sk_sp<flutter::DlImage> flutter::SurfaceTextureExternalTexture::dl_image_

protected

Definition at line 52 of file surface_texture_external_texture.h.

jni_facade_

std::shared_ptr<PlatformViewAndroidJNI> flutter::SurfaceTextureExternalTexture::jni_facade_

protected

Definition at line 48 of file surface_texture_external_texture.h.

state_

AttachmentState flutter::SurfaceTextureExternalTexture::state_ = AttachmentState::kUninitialized

protected

Definition at line 50 of file surface_texture_external_texture.h.

surface_texture_

fml::jni::ScopedJavaGlobalRef<jobject> flutter::SurfaceTextureExternalTexture::surface_texture_

protected

Definition at line 49 of file surface_texture_external_texture.h.

transform_

SkMatrix flutter::SurfaceTextureExternalTexture::transform_

protected

Definition at line 51 of file surface_texture_external_texture.h.

---

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

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