public static interface FlutterRenderer.RenderSurface
FlutterRenderer
to create an interactive Flutter
UI.
A RenderSurface
is responsible for carrying out behaviors that are needed by a
corresponding FlutterRenderer
.
A RenderSurface
also receives callbacks for important events, e.g.,
onFirstFrameRendered()
.Modifier and Type | Method and Description |
---|---|
void |
addOnFirstFrameRenderedListener(OnFirstFrameRenderedListener listener)
Adds the given
listener to this FlutterRenderer , to be notified upon Flutter's
first rendered frame. |
void |
attachToRenderer(FlutterRenderer renderer)
Invoked by the owner of this
RenderSurface when it wants to begin rendering
a Flutter UI to this RenderSurface . |
void |
detachFromRenderer()
Invoked by the owner of this
RenderSurface when it no longer wants to render
a Flutter UI to this RenderSurface . |
void |
onFirstFrameRendered()
The
FlutterRenderer corresponding to this RenderSurface has painted its
first frame since being initialized. |
void |
removeOnFirstFrameRenderedListener(OnFirstFrameRenderedListener listener)
Removes the given
listener , which was previously added with
addOnFirstFrameRenderedListener(OnFirstFrameRenderedListener) . |
void attachToRenderer(@NonNull FlutterRenderer renderer)
RenderSurface
when it wants to begin rendering
a Flutter UI to this RenderSurface
.
The details of how rendering is handled is an implementation detail.void detachFromRenderer()
RenderSurface
when it no longer wants to render
a Flutter UI to this RenderSurface
.
This method will cease any on-going rendering from Flutter to this RenderSurface
.void onFirstFrameRendered()
FlutterRenderer
corresponding to this RenderSurface
has painted its
first frame since being initialized.
"Initialized" refers to Flutter engine initialization, not the first frame after attaching
to the FlutterRenderer
. Therefore, the first frame may have already rendered by
the time a RenderSurface
has called FlutterRenderer.attachToRenderSurface(RenderSurface)
on a FlutterRenderer
. In such a situation, #onFirstFrameRendered()
will
never be called.void addOnFirstFrameRenderedListener(@NonNull OnFirstFrameRenderedListener listener)
listener
to this FlutterRenderer
, to be notified upon Flutter's
first rendered frame.void removeOnFirstFrameRenderedListener(@NonNull OnFirstFrameRenderedListener listener)
listener
, which was previously added with
addOnFirstFrameRenderedListener(OnFirstFrameRenderedListener)
.