chore: cherry-pick to 2.0.0

Author: glemartret

.vscode/launch.json

@@ -8,7 +8,10 @@
             "name": "Flutter",
             "request": "launch",
             "type": "dart",
-            "program": "example/lib/main.dart"
+            "program": "example/lib/main.dart",
+            "args": [
+                "--web-renderer canvaskit --dart-define=BROWSER_IMAGE_DECODING_ENABLED=false --release"
+            ]
         }
     ]
 }

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [2.0.0] - 13/05/2023
+* Migrate to `FlutterView` from `ui.window` @Mayb3Nots
+## [1.3.0] - 27/12/2022
+* Fix disposing widgets after capturing in widgetToUiImage function @Lan-tb
 ## [1.2.3] - 15/07/2021
 * Support Inheriting Theme for Invisible Widget
 

example/android/app/build.gradle

@@ -26,7 +26,7 @@ apply plugin: 'kotlin-android'
 apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
 
 android {
-    compileSdkVersion 30
+    compileSdkVersion 31
 
     sourceSets {
         main.java.srcDirs += 'src/main/kotlin'
@@ -36,7 +36,7 @@ android {
         // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
         applicationId "com.screenshot.example"
         minSdkVersion 17
-        targetSdkVersion 30
+        targetSdkVersion 31
         versionCode flutterVersionCode.toInteger()
         versionName flutterVersionName
     }

example/android/app/src/main/AndroidManifest.xml

@@ -6,6 +6,7 @@
         <activity
             android:name=".MainActivity"
             android:launchMode="singleTop"
+            android:exported="true"
             android:theme="@style/LaunchTheme"
             android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
             android:hardwareAccelerated="true"

example/android/build.gradle

@@ -1,5 +1,5 @@
 buildscript {
-    ext.kotlin_version = '1.3.50'
+    ext.kotlin_version = '1.6.0'
     repositories {
         google()
         jcenter()
@@ -26,6 +26,6 @@ subprojects {
     project.evaluationDependsOn(':app')
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

example/lib/main.dart

@@ -15,9 +15,9 @@ class MyApp extends StatelessWidget {
       title: 'Flutter Demo',
       theme: ThemeData(
         textTheme: TextTheme(
-            headline6: TextStyle(
+            titleLarge: TextStyle(
           color: Colors.yellow,
-          fontSize: 50,
+          // fontSize: 50,
         )),
         // This is the theme of your application.
         //
@@ -73,7 +73,14 @@ class _MyHomePageState extends State<MyHomePage> {
                     border: Border.all(color: Colors.blueAccent, width: 5.0),
                     color: Colors.amberAccent,
                   ),
-                  child: Text("This widget will be captured as an image")),
+                  child: Stack(
+                    children: [
+                      Image.asset(
+                        'assets/images/flutter.png',
+                      ),
+                      Text("This widget will be captured as an image"),
+                    ],
+                  )),
             ),
             SizedBox(
               height: 25,
@@ -103,9 +110,16 @@ class _MyHomePageState extends State<MyHomePage> {
                       border: Border.all(color: Colors.blueAccent, width: 5.0),
                       color: Colors.redAccent,
                     ),
-                    child: Text(
-                      "This is an invisible widget",
-                      style: Theme.of(context).textTheme.headline6,
+                    child: Stack(
+                      children: [
+                        Image.asset(
+                          'assets/images/flutter.png',
+                        ),
+                        Text(
+                          "This is an invisible widget",
+                          style: Theme.of(context).textTheme.titleLarge,
+                        ),
+                      ],
                     ));
                 screenshotController
                     .captureFromWidget(
@@ -138,9 +152,7 @@ class _MyHomePageState extends State<MyHomePage> {
         appBar: AppBar(
           title: Text("Captured widget screenshot"),
         ),
-        body: Center(
-          child: Image.memory(capturedImage),
-        ),
+        body: Center(child: Image.memory(capturedImage)),
       ),
     );
   }

example/pubspec.yaml

@@ -18,7 +18,7 @@ dependencies:
     sdk: flutter
   screenshot:
     path: ../
-  cupertino_icons: ^0.1.2
+  # cupertino_icons: ^0.1.2
   # image_gallery_saver: ^1.1.0
 
 dev_dependencies:

example/test/widget_test.dart

@@ -8,7 +8,7 @@
 import 'package:flutter/material.dart';
 import 'package:flutter_test/flutter_test.dart';
 
-import 'package:example/main.dart';
+import '../lib/main.dart';
 
 void main() {
   testWidgets('Counter increments smoke test', (WidgetTester tester) async {

example/windows/flutter/generated_plugins.cmake

@@ -5,6 +5,9 @@
 list(APPEND FLUTTER_PLUGIN_LIST
 )
 
+list(APPEND FLUTTER_FFI_PLUGIN_LIST
+)
+
 set(PLUGIN_BUNDLED_LIBRARIES)
 
 foreach(plugin ${FLUTTER_PLUGIN_LIST})
@@ -13,3 +16,8 @@ foreach(plugin ${FLUTTER_PLUGIN_LIST})
   list(APPEND PLUGIN_BUNDLED_LIBRARIES $<TARGET_FILE:${plugin}_plugin>)
   list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries})
 endforeach(plugin)
+
+foreach(ffi_plugin ${FLUTTER_FFI_PLUGIN_LIST})
+  add_subdirectory(flutter/ephemeral/.plugin_symlinks/${ffi_plugin}/windows plugins/${ffi_plugin})
+  list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${ffi_plugin}_bundled_libraries})
+endforeach(ffi_plugin)

lib/screenshot.dart

@@ -14,6 +14,7 @@ import 'src/platform_specific/file_manager/file_manager.dart';
 class Screenshot<T> extends StatefulWidget {
   final Widget? child;
   final ScreenshotController controller;
+
   const Screenshot({
     Key? key,
     required this.child,
@@ -33,6 +34,7 @@ class Screenshot<T> extends StatefulWidget {
 ///
 class ScreenshotController {
   late GlobalKey _containerKey;
+
   ScreenshotController() {
     _containerKey = GlobalKey();
   }
@@ -50,6 +52,8 @@ class ScreenshotController {
         );
         ByteData? byteData =
             await image?.toByteData(format: ui.ImageByteFormat.png);
+        image?.dispose();
+
         Uint8List? pngBytes = byteData?.buffer.asUint8List();
 
         return pngBytes;
@@ -75,9 +79,10 @@ class ScreenshotController {
     return fileManager.saveFile(content!, directory, name: fileName);
   }
 
-  Future<ui.Image?> captureAsUiImage(
-      {double? pixelRatio: 1,
-      Duration delay: const Duration(milliseconds: 20)}) {
+  Future<ui.Image?> captureAsUiImage({
+    double? pixelRatio = 1,
+    Duration delay = const Duration(milliseconds: 20),
+  }) {
     //Delay is required. See Issue https://github.com/flutter/flutter/issues/22308
     return new Future.delayed(delay, () async {
       try {
@@ -110,7 +115,7 @@ class ScreenshotController {
   ///
   Future<Uint8List> captureFromWidget(
     Widget widget, {
-    Duration delay: const Duration(seconds: 1),
+    Duration delay = const Duration(seconds: 1),
     double? pixelRatio,
     BuildContext? context,
     Size? targetSize,
@@ -122,13 +127,15 @@ class ScreenshotController {
         targetSize: targetSize);
     final ByteData? byteData =
         await image.toByteData(format: ui.ImageByteFormat.png);
+    image.dispose();
 
     return byteData!.buffer.asUint8List();
   }
 
+  /// If you are building a desktop/web application that supports multiple view. Consider passing the [context] so that flutter know which view to capture.
   static Future<ui.Image> widgetToUiImage(
     Widget widget, {
-    Duration delay: const Duration(seconds: 1),
+    Duration delay = const Duration(seconds: 1),
     double? pixelRatio,
     BuildContext? context,
     Size? targetSize,
@@ -159,16 +166,20 @@ class ScreenshotController {
 
     final RenderRepaintBoundary repaintBoundary = RenderRepaintBoundary();
 
-    Size logicalSize = targetSize ??
-        ui.window.physicalSize / ui.window.devicePixelRatio; // Adapted
-    Size imageSize = targetSize ?? ui.window.physicalSize; // Adapted
+    final platformDispatcher = WidgetsBinding.instance.platformDispatcher;
+    final fallBackView = platformDispatcher.views.first;
+    final view =
+        context == null ? fallBackView : View.maybeOf(context) ?? fallBackView;
+    Size logicalSize =
+        targetSize ?? view.physicalSize / view.devicePixelRatio; // Adapted
+    Size imageSize = targetSize ?? view.physicalSize; // Adapted
 
     assert(logicalSize.aspectRatio.toStringAsPrecision(5) ==
         imageSize.aspectRatio
             .toStringAsPrecision(5)); // Adapted (toPrecision was not available)
 
     final RenderView renderView = RenderView(
-      window: ui.window,
+      view: view,
       child: RenderPositionedBox(
           alignment: Alignment.center, child: repaintBoundary),
       configuration: ViewConfiguration(
@@ -226,7 +237,7 @@ class ScreenshotController {
           pixelRatio: pixelRatio ?? (imageSize.width / logicalSize.width));
 
       ///
-      ///This delay sholud increas with Widget tree Size
+      ///This delay should increase with Widget tree Size
       ///
 
       await Future.delayed(delay);
@@ -251,10 +262,16 @@ class ScreenshotController {
       retryCounter--;
 
       ///
-      ///retry untill capture is successfull
+      /// retry until capture is successful
       ///
-
     } while (isDirty && retryCounter >= 0);
+    try {
+      /// Dispose All widgets
+      // rootElement.visitChildren((Element element) {
+      //   rootElement.deactivateChild(element);
+      // });
+      buildOwner.finalizeTree();
+    } catch (e) {}
 
     return image; // Adapted to directly return the image and not the Uint8List
   }