Unverified Commit d285b884 authored by Michael Goderbauer's avatar Michael Goderbauer Committed by GitHub

Add option to delay rendering the first frame (#45135)

parent 45953a12
...@@ -283,6 +283,53 @@ mixin RendererBinding on BindingBase, ServicesBinding, SchedulerBinding, Gesture ...@@ -283,6 +283,53 @@ mixin RendererBinding on BindingBase, ServicesBinding, SchedulerBinding, Gesture
drawFrame(); drawFrame();
} }
int _firstFrameDeferredCount = 0;
bool _firstFrameSent = false;
/// Whether frames produced by [drawFrame] are sent to the engine.
///
/// If false the framework will do all the work to produce a frame,
/// but the frame is never send to the engine to actually appear on screen.
///
/// See also:
///
/// * [deferFirstFrame], which defers when the first frame is send to the
/// engine.
bool get sendFramesToEngine => _firstFrameSent || _firstFrameDeferredCount == 0;
/// Tell the framework to not send the first frames to the engine until there
/// is a corresponding call to [allowFirstFrame].
///
/// Call this to perform asynchronous initialisation work before the first
/// frame is rendered (which takes down the splash screen). The framework
/// will still do all the work to produce frames, but those frames are never
/// send to the engine and will not appear on screen.
///
/// Calling this has no effect after the first frame has been send to the
/// engine.
void deferFirstFrame() {
assert(_firstFrameDeferredCount >= 0);
_firstFrameDeferredCount += 1;
}
/// Called after [deferFirstFrame] to tell the framework that it is ok to
/// send the first frame to the engine now.
///
/// For best performance, this method should only be called while the
/// [schedulerPhase] is [SchedulerPhase.idle].
///
/// This method may only be called once for each corresponding call
/// to [deferFirstFrame].
void allowFirstFrame() {
assert(_firstFrameDeferredCount > 0);
_firstFrameDeferredCount -= 1;
// Always schedule a warm up frame even if the deferral count is not down to
// zero yet since the removal of a deferral may uncover new deferrals that
// are lower in the widget tree.
if (!_firstFrameSent)
scheduleWarmUpFrame();
}
/// Pump the rendering pipeline to generate a frame. /// Pump the rendering pipeline to generate a frame.
/// ///
/// This method is called by [handleDrawFrame], which itself is called /// This method is called by [handleDrawFrame], which itself is called
...@@ -344,8 +391,11 @@ mixin RendererBinding on BindingBase, ServicesBinding, SchedulerBinding, Gesture ...@@ -344,8 +391,11 @@ mixin RendererBinding on BindingBase, ServicesBinding, SchedulerBinding, Gesture
pipelineOwner.flushLayout(); pipelineOwner.flushLayout();
pipelineOwner.flushCompositingBits(); pipelineOwner.flushCompositingBits();
pipelineOwner.flushPaint(); pipelineOwner.flushPaint();
renderView.compositeFrame(); // this sends the bits to the GPU if (sendFramesToEngine) {
pipelineOwner.flushSemantics(); // this also sends the semantics to the OS. renderView.compositeFrame(); // this sends the bits to the GPU
pipelineOwner.flushSemantics(); // this also sends the semantics to the OS.
_firstFrameSent = true;
}
} }
@override @override
......
...@@ -572,9 +572,6 @@ mixin WidgetsBinding on BindingBase, ServicesBinding, SchedulerBinding, GestureB ...@@ -572,9 +572,6 @@ mixin WidgetsBinding on BindingBase, ServicesBinding, SchedulerBinding, GestureB
} }
bool _needToReportFirstFrame = true; bool _needToReportFirstFrame = true;
int _deferFirstFrameReportCount = 0;
bool get _reportFirstFrame => _deferFirstFrameReportCount == 0;
final Completer<void> _firstFrameCompleter = Completer<void>(); final Completer<void> _firstFrameCompleter = Completer<void>();
...@@ -600,11 +597,6 @@ mixin WidgetsBinding on BindingBase, ServicesBinding, SchedulerBinding, GestureB ...@@ -600,11 +597,6 @@ mixin WidgetsBinding on BindingBase, ServicesBinding, SchedulerBinding, GestureB
/// Whether the first frame has finished building. /// Whether the first frame has finished building.
/// ///
/// Only useful in profile and debug builds; in release builds, this always
/// return false. This can be deferred using [deferFirstFrameReport] and
/// [allowFirstFrameReport]. The value is set at the end of the call to
/// [drawFrame].
///
/// This value can also be obtained over the VM service protocol as /// This value can also be obtained over the VM service protocol as
/// `ext.flutter.didSendFirstFrameEvent`. /// `ext.flutter.didSendFirstFrameEvent`.
/// ///
...@@ -616,27 +608,30 @@ mixin WidgetsBinding on BindingBase, ServicesBinding, SchedulerBinding, GestureB ...@@ -616,27 +608,30 @@ mixin WidgetsBinding on BindingBase, ServicesBinding, SchedulerBinding, GestureB
/// Tell the framework not to report the frame it is building as a "useful" /// Tell the framework not to report the frame it is building as a "useful"
/// first frame until there is a corresponding call to [allowFirstFrameReport]. /// first frame until there is a corresponding call to [allowFirstFrameReport].
/// ///
/// This is used by [WidgetsApp] to avoid reporting frames that aren't useful /// Deprecated. Use [deferFirstFrame]/[allowFirstFrame] to delay rendering the
/// during startup as the "first frame". /// first frame.
@Deprecated(
'Use deferFirstFrame/allowFirstFrame to delay rendering the first frame. '
'This feature was deprecated after v1.12.4.'
)
void deferFirstFrameReport() { void deferFirstFrameReport() {
if (!kReleaseMode) { if (!kReleaseMode) {
assert(_deferFirstFrameReportCount >= 0); deferFirstFrame();
_deferFirstFrameReportCount += 1;
} }
} }
/// When called after [deferFirstFrameReport]: tell the framework to report /// When called after [deferFirstFrameReport]: tell the framework to report
/// the frame it is building as a "useful" first frame. /// the frame it is building as a "useful" first frame.
/// ///
/// This method may only be called once for each corresponding call /// Deprecated. Use [deferFirstFrame]/[allowFirstFrame] to delay rendering the
/// to [deferFirstFrameReport]. /// first frame.
/// @Deprecated(
/// This is used by [WidgetsApp] to report when the first useful frame is 'Use deferFirstFrame/allowFirstFrame to delay rendering the first frame. '
/// painted. 'This feature was deprecated after v1.12.4.'
)
void allowFirstFrameReport() { void allowFirstFrameReport() {
if (!kReleaseMode) { if (!kReleaseMode) {
assert(_deferFirstFrameReportCount >= 1); allowFirstFrame();
_deferFirstFrameReportCount -= 1;
} }
} }
...@@ -753,18 +748,23 @@ mixin WidgetsBinding on BindingBase, ServicesBinding, SchedulerBinding, GestureB ...@@ -753,18 +748,23 @@ mixin WidgetsBinding on BindingBase, ServicesBinding, SchedulerBinding, GestureB
return true; return true;
}()); }());
if (_needToReportFirstFrame && _reportFirstFrame) { TimingsCallback firstFrameCallback;
if (_needToReportFirstFrame) {
assert(!_firstFrameCompleter.isCompleted); assert(!_firstFrameCompleter.isCompleted);
TimingsCallback firstFrameCallback;
firstFrameCallback = (List<FrameTiming> timings) { firstFrameCallback = (List<FrameTiming> timings) {
assert(sendFramesToEngine);
if (!kReleaseMode) { if (!kReleaseMode) {
developer.Timeline.instantSync('Rasterized first useful frame'); developer.Timeline.instantSync('Rasterized first useful frame');
developer.postEvent('Flutter.FirstFrame', <String, dynamic>{}); developer.postEvent('Flutter.FirstFrame', <String, dynamic>{});
} }
SchedulerBinding.instance.removeTimingsCallback(firstFrameCallback); SchedulerBinding.instance.removeTimingsCallback(firstFrameCallback);
firstFrameCallback = null;
_firstFrameCompleter.complete(); _firstFrameCompleter.complete();
}; };
// Callback is only invoked when [Window.render] is called. When
// [sendFramesToEngine] is set to false during the frame, it will not
// be called and we need to remove the callback (see below).
SchedulerBinding.instance.addTimingsCallback(firstFrameCallback); SchedulerBinding.instance.addTimingsCallback(firstFrameCallback);
} }
...@@ -780,11 +780,14 @@ mixin WidgetsBinding on BindingBase, ServicesBinding, SchedulerBinding, GestureB ...@@ -780,11 +780,14 @@ mixin WidgetsBinding on BindingBase, ServicesBinding, SchedulerBinding, GestureB
}()); }());
} }
if (!kReleaseMode) { if (!kReleaseMode) {
if (_needToReportFirstFrame && _reportFirstFrame) { if (_needToReportFirstFrame && sendFramesToEngine) {
developer.Timeline.instantSync('Widgets built first useful frame'); developer.Timeline.instantSync('Widgets built first useful frame');
} }
} }
_needToReportFirstFrame = false; _needToReportFirstFrame = false;
if (firstFrameCallback != null && !sendFramesToEngine) {
SchedulerBinding.instance.removeTimingsCallback(firstFrameCallback);
}
} }
/// The [Element] that is at the root of the hierarchy (and which wraps the /// The [Element] that is at the root of the hierarchy (and which wraps the
...@@ -832,12 +835,9 @@ mixin WidgetsBinding on BindingBase, ServicesBinding, SchedulerBinding, GestureB ...@@ -832,12 +835,9 @@ mixin WidgetsBinding on BindingBase, ServicesBinding, SchedulerBinding, GestureB
return true; return true;
}()); }());
deferFirstFrameReport();
if (renderViewElement != null) if (renderViewElement != null)
buildOwner.reassemble(renderViewElement); buildOwner.reassemble(renderViewElement);
return super.performReassemble().then((void value) { return super.performReassemble();
allowFirstFrameReport();
});
} }
} }
......
...@@ -6,6 +6,7 @@ import 'dart:async'; ...@@ -6,6 +6,7 @@ import 'dart:async';
import 'dart:ui' show Locale; import 'dart:ui' show Locale;
import 'package:flutter/foundation.dart'; import 'package:flutter/foundation.dart';
import 'package:flutter/rendering.dart';
import 'basic.dart'; import 'basic.dart';
import 'binding.dart'; import 'binding.dart';
...@@ -519,9 +520,9 @@ class _LocalizationsState extends State<Localizations> { ...@@ -519,9 +520,9 @@ class _LocalizationsState extends State<Localizations> {
// have finished loading. Until then the old locale will continue to be used. // have finished loading. Until then the old locale will continue to be used.
// - If we're running at app startup time then defer reporting the first // - If we're running at app startup time then defer reporting the first
// "useful" frame until after the async load has completed. // "useful" frame until after the async load has completed.
WidgetsBinding.instance.deferFirstFrameReport(); RendererBinding.instance.deferFirstFrame();
typeToResourcesFuture.then<void>((Map<Type, dynamic> value) { typeToResourcesFuture.then<void>((Map<Type, dynamic> value) {
WidgetsBinding.instance.allowFirstFrameReport(); RendererBinding.instance.allowFirstFrame();
if (!mounted) if (!mounted)
return; return;
setState(() { setState(() {
......
// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import 'dart:async';
import 'package:flutter/rendering.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:flutter/material.dart';
import 'package:flutter/widgets.dart';
const String _actualContent = 'Actual Content';
const String _loading = 'Loading...';
void main() {
testWidgets('deferFirstFrame/allowFirstFrame stops sending frames to engine', (WidgetTester tester) async {
expect(RendererBinding.instance.sendFramesToEngine, isTrue);
final Completer<void> completer = Completer<void>();
await tester.pumpWidget(
Directionality(
textDirection: TextDirection.ltr,
child: _DeferringWidget(
key: UniqueKey(),
loader: completer.future,
),
),
);
final _DeferringWidgetState state = tester.state<_DeferringWidgetState>(find.byType(_DeferringWidget));
expect(find.text(_loading), findsOneWidget);
expect(find.text(_actualContent), findsNothing);
expect(RendererBinding.instance.sendFramesToEngine, isFalse);
await tester.pump();
expect(find.text(_loading), findsOneWidget);
expect(find.text(_actualContent), findsNothing);
expect(RendererBinding.instance.sendFramesToEngine, isFalse);
expect(state.doneLoading, isFalse);
// Complete the future to start sending frames.
completer.complete();
await tester.idle();
expect(state.doneLoading, isTrue);
expect(RendererBinding.instance.sendFramesToEngine, isTrue);
await tester.pump();
expect(find.text(_loading), findsNothing);
expect(find.text(_actualContent), findsOneWidget);
expect(RendererBinding.instance.sendFramesToEngine, isTrue);
});
}
class _DeferringWidget extends StatefulWidget {
const _DeferringWidget({Key key, this.loader}) : super(key: key);
final Future<void> loader;
@override
State<_DeferringWidget> createState() => _DeferringWidgetState();
}
class _DeferringWidgetState extends State<_DeferringWidget> {
bool doneLoading = false;
@override
void initState() {
super.initState();
RendererBinding.instance.deferFirstFrame();
widget.loader.then((_) {
setState(() {
doneLoading = true;
RendererBinding.instance.allowFirstFrame();
});
});
}
@override
Widget build(BuildContext context) {
return doneLoading
? const Text(_actualContent)
: const Text(_loading);
}
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment