io.flutter.embedding.engine.renderer.RenderSurface Interface Reference

Inheritance diagram for io.flutter.embedding.engine.renderer.RenderSurface:

Public Member Functions
FlutterRenderer	getAttachedRenderer ()
void	attachToRenderer (@NonNull FlutterRenderer renderer)
void	detachFromRenderer ()
void	pause ()
void	resume ()

Detailed Description

Owns a Surface that FlutterRenderer would like to paint.

RenderSurface is responsible for providing a Surface to a given
FlutterRenderer when requested, and then notify that FlutterRenderer when the
Surface changes, or is destroyed.

The behavior of providing a Surface is delegated to this interface because the timing of a Surface's availability is determined by Android. Therefore, an accessor method would not fulfill the requirements. Therefore, a RenderSurface is given a
FlutterRenderer, which the RenderSurface is expected to notify as a Surface becomes available, changes, or is destroyed.

Definition at line 24 of file RenderSurface.java.

Member Function Documentation

attachToRenderer()

void io.flutter.embedding.engine.renderer.RenderSurface.attachToRenderer

(

@NonNull FlutterRenderer

renderer

)

Instructs this RenderSurface to give its Surface to the given
FlutterRenderer so that Flutter can paint pixels on it.

After this call, RenderSurface is expected to invoke the following methods on FlutterRenderer at the appropriate times:

1. FlutterRenderer#startRenderingToSurface(Surface, boolean)
2. FlutterRenderer#surfaceChanged(int, int)}
3. FlutterRenderer#stopRenderingToSurface()

Implemented in io.flutter.embedding.android.FlutterImageView.

detachFromRenderer()

void io.flutter.embedding.engine.renderer.RenderSurface.detachFromRenderer

(

)

Instructs this RenderSurface to stop forwarding Surface notifications to the FlutterRenderer that was previously connected with attachToRenderer(FlutterRenderer).

This RenderSurface should also clean up any references related to the previously connected FlutterRenderer.

Implemented in io.flutter.embedding.android.FlutterImageView.

getAttachedRenderer()

FlutterRenderer io.flutter.embedding.engine.renderer.RenderSurface.getAttachedRenderer

(

)

Returns the FlutterRenderer that is attached to this RenderSurface, or null if no FlutterRenderer is currently attached.

Implemented in io.flutter.embedding.android.FlutterImageView.

pause()

void io.flutter.embedding.engine.renderer.RenderSurface.pause

(

)

Instructs this RenderSurface to stop forwarding Surface notifications to the FlutterRenderer that was previously connected with attachToRenderer(FlutterRenderer).

Implemented in io.flutter.embedding.android.FlutterImageView.

resume()

void io.flutter.embedding.engine.renderer.RenderSurface.resume

(

)

Instructs this RenderSurface to resume forwarding Surface notifications to the FlutterRenderer that was previously connected with attachToRenderer(FlutterRenderer).

Implemented in io.flutter.embedding.android.FlutterImageView.

---

The documentation for this interface was generated from the following file:

• shell/platform/android/io/flutter/embedding/engine/renderer/RenderSurface.java