rewrite resize handler for better support on Windows

This commit is contained in:
Nick Fisher
2023-10-17 00:13:44 +11:00
parent 818d75b493
commit 6ab814114e
7 changed files with 304 additions and 219 deletions

View File

@@ -9,7 +9,7 @@ import 'package:polyvox_filament/filament_controller.dart';
import 'dart:async';
typedef ResizeCallback = void Function(Size oldSize, Size newSize);
typedef ResizeCallback = void Function(Size newSize);
class ResizeObserver extends SingleChildRenderObjectWidget {
final ResizeCallback onResized;
@@ -36,14 +36,14 @@ class _RenderResizeObserver extends RenderProxyBox {
required this.onLayoutChangedCallback,
}) : super(child);
late var _oldSize = size;
Size _oldSize = Size.zero;
@override
void performLayout() {
void performLayout() async {
super.performLayout();
if (size != _oldSize) {
onLayoutChangedCallback(_oldSize, size);
_oldSize = size;
if (size.width != _oldSize.width || size.height != _oldSize.height) {
onLayoutChangedCallback(size);
_oldSize = Size(size.width, size.height);
}
}
}
@@ -65,62 +65,11 @@ class FilamentWidget extends StatefulWidget {
}
class _FilamentWidgetState extends State<FilamentWidget> {
TextureDetails? _textureDetails;
late final AppLifecycleListener _listener;
AppLifecycleState? _lastState;
String? _error;
int? _width;
int? _height;
void _handleStateChange(AppLifecycleState state) async {
switch (state) {
case AppLifecycleState.detached:
print("Detached");
_textureDetails = null;
await widget.controller.destroyViewer();
await widget.controller.destroyTexture();
break;
case AppLifecycleState.hidden:
print("Hidden");
if (Platform.isIOS) {
_textureDetails = null;
await widget.controller.destroyViewer();
await widget.controller.destroyTexture();
}
break;
case AppLifecycleState.inactive:
print("Inactive");
break;
case AppLifecycleState.paused:
print("Paused");
break;
case AppLifecycleState.resumed:
print("Resumed");
if (!Platform.isWindows) {
if (_textureDetails == null) {
var size = ((context.findRenderObject()) as RenderBox).size;
print("Size after resuming : $size");
_height = size.height.ceil();
_width = size.width.ceil();
await widget.controller.createViewer(_width!, _height!);
print("Created viewer Size after resuming");
}
}
break;
}
_lastState = state;
}
@override
void initState() {
_listener = AppLifecycleListener(
onStateChange: _handleStateChange,
);
WidgetsBinding.instance.addPostFrameCallback((timeStamp) async {
// when attaching a debugger via Android Studio on startup, this can delay presentation of the widget
// (meaning the widget may attempt to create a viewer with size 0x0).
@@ -131,26 +80,166 @@ class _FilamentWidgetState extends State<FilamentWidget> {
var size = ((context.findRenderObject()) as RenderBox).size;
_width = size.width.ceil();
_height = size.height.ceil();
try {
_textureDetails =
await widget.controller.createViewer(_width!, _height!);
} catch (err) {
setState(() {
_error = err.toString();
});
setState(() {});
});
super.initState();
}
@override
Widget build(BuildContext context) {
if (_width == null || _height == null) {
return widget.initial ?? Container(color: Colors.red);
}
return ResizeObserver(
onResized: (newSize) {
WidgetsBinding.instance.addPostFrameCallback((timeStamp) {
setState(() {
_width = newSize.width.ceil();
_height = newSize.height.ceil();
});
});
},
child: _SizedFilamentWidget(
initial: widget.initial,
width: _width!,
height: _height!,
controller: widget.controller,
));
}
}
class _SizedFilamentWidget extends StatefulWidget {
final int width;
final int height;
final Widget? initial;
final FilamentController controller;
const _SizedFilamentWidget(
{super.key,
required this.width,
required this.height,
this.initial,
required this.controller});
@override
State<StatefulWidget> createState() => _SizedFilamentWidgetState();
}
class _SizedFilamentWidgetState extends State<_SizedFilamentWidget> {
String? _error;
late final AppLifecycleListener _appLifecycleListener;
AppLifecycleState? _lastState;
@override
void initState() {
_appLifecycleListener = AppLifecycleListener(
onStateChange: _handleStateChange,
);
WidgetsBinding.instance.addPostFrameCallback((timeStamp) async {
// when attaching a debugger via Android Studio on startup, this can delay presentation of the widget
// (meaning the widget may attempt to create a viewer with size 0x0).
// we just add a small delay here which should avoid this
if (!kReleaseMode) {
await Future.delayed(Duration(seconds: 2));
}
try {
widget.controller.createViewer(widget.width, widget.height);
} catch (err) {
_error = err.toString();
}
setState(() {});
});
super.initState();
}
Timer? _resizeTimer;
bool _resizing = false;
Future _resize() {
final completer = Completer();
_resizeTimer?.cancel();
_resizeTimer = Timer(Duration(milliseconds: 200), () async {
var size = ((context.findRenderObject()) as RenderBox).size;
var width = size.width.ceil();
var height = size.height.ceil();
while (_resizing) {
await Future.delayed(Duration(milliseconds: 20));
}
_resizing = true;
await widget.controller.resize(width, height);
_resizeTimer = null;
setState(() {});
_resizing = false;
completer.complete();
});
return completer.future;
}
@override
void didUpdateWidget(_SizedFilamentWidget oldWidget) {
super.didUpdateWidget(oldWidget);
if (oldWidget.height != widget.height || oldWidget.width != widget.width) {
_resize();
}
}
@override
void dispose() {
_listener.dispose();
_appLifecycleListener.dispose();
super.dispose();
}
Timer? _resizeTimer;
bool _wasRenderingOnInactive = false;
void _handleStateChange(AppLifecycleState state) async {
switch (state) {
case AppLifecycleState.detached:
print("Detached");
if (widget.controller.textureDetails != null) {
await widget.controller.destroyViewer();
await widget.controller.destroyTexture();
}
break;
case AppLifecycleState.hidden:
print("Hidden");
if (Platform.isIOS && widget.controller.textureDetails != null) {
await widget.controller.destroyViewer();
await widget.controller.destroyTexture();
}
break;
case AppLifecycleState.inactive:
print("Inactive");
// on Windows in particular, restoring a window after minimizing stalls the renderer (and the whole application) for a considerable length of time.
// disabling rendering on minimize seems to fix the issue (so I wonder if there's some kind of command buffer that's filling up while the window is minimized).
_wasRenderingOnInactive = widget.controller.rendering;
await widget.controller.setRendering(false);
break;
case AppLifecycleState.paused:
print("Paused");
break;
case AppLifecycleState.resumed:
print("Resumed");
if (!Platform.isWindows) {
if (widget.controller.textureDetails == null) {
var size = ((context.findRenderObject()) as RenderBox).size;
widget.controller
.createViewer(size.width.ceil(), size.height.ceil());
}
} else {
await _resize();
}
await widget.controller.setRendering(_wasRenderingOnInactive);
break;
}
_lastState = state;
}
@override
Widget build(BuildContext context) {
@@ -164,51 +253,26 @@ class _FilamentWidgetState extends State<FilamentWidget> {
]));
}
// if no texture ID is available, display the [initial] widget (solid red by default)
late Widget content;
if (_textureDetails == null ||
_textureDetails!.height != _height ||
_textureDetails!.width != _width) {
content = widget.initial ?? Container(color: Colors.red);
} else {
content = Texture(
key: ObjectKey("texture_${_textureDetails!.textureId}"),
textureId: _textureDetails!.textureId,
filterQuality: FilterQuality.none,
freeze: false,
);
if (widget.controller.textureDetails == null || _resizeTimer != null) {
return widget.initial ?? Container(color: Colors.red);
}
// see [FilamentControllerFFI.resize] for an explanation of how we deal with resizing
return ResizeObserver(
onResized: (Size oldSize, Size newSize) async {
_resizeTimer?.cancel();
var texture = Texture(
key: ObjectKey("texture_${widget.controller.textureDetails!.textureId}"),
textureId: widget.controller.textureDetails!.textureId,
filterQuality: FilterQuality.none,
freeze: false,
);
_resizeTimer = Timer(const Duration(milliseconds: 50), () async {
var newWidth = newSize.width.ceil();
var newHeight = newSize.height.ceil();
try {
_textureDetails =
await widget.controller.resize(newWidth, newHeight);
setState(() {
_width = newWidth;
_height = newHeight;
});
} catch (err) {
print(err);
}
});
},
child: Stack(children: [
Positioned.fill(
child: Platform.isLinux || Platform.isWindows
? Transform(
alignment: Alignment.center,
transform: Matrix4.rotationX(
pi), // TODO - this rotation is due to OpenGL texture coordinate working in a different space from Flutter, can we move this to the C++ side somewhere?
child: content)
: content)
]));
return Stack(children: [
Positioned.fill(
child: Platform.isLinux || Platform.isWindows
? Transform(
alignment: Alignment.center,
transform: Matrix4.rotationX(
pi), // TODO - this rotation is due to OpenGL texture coordinate working in a different space from Flutter, can we move this to the C++ side somewhere?
child: texture)
: texture)
]);
}
}