widget_test_capture
library
Functions
-
captureScenario({required Widget child, ThemeMode themeMode = ThemeMode.light, Locale locale = const Locale('en'), double textScale = 1, TextDirection direction = TextDirection.ltr})
→ Widget
-
Builds a widget under a known theme, locale, text scale, and direction.
-
captureTest(String description, Future<void> callback(WidgetTester, TestCapture), {CaptureConfig config = const CaptureConfig(), bool skip = false, Timeout? timeout, TestVariant<Object?>? variant})
→ void
-
Registers a widget test with opt-in capture around the callback.
-
doctorFfmpeg({String? executable})
→ Future<String>
-
Checks that FFmpeg is runnable and includes an H.264 video encoder.
-
encodeAnimationGif(List<File> frames, File output, {required int fps, int loopCount = 0, int paletteColors = 256, int background = 0xffffffff})
→ Future<File>
-
Encodes deterministic animation frames with one GIF delay derived from FPS.
-
encodeGif(List<File> frames, File output, {GifOptions options = const GifOptions()})
→ Future<File>
-
Encodes PNG frames into an animated GIF using a common canvas.
The canvas uses the largest frame dimensions. Smaller frames start at the
top-left; the configured background fills the remaining area.
-
encodeMp4(List<File> frames, File output, {String? executable, int fps = 15, int? width, int? height, String paddingColor = 'black'})
→ Future<File>
-
Encodes an ordered list of PNG frames as silent H.264 MP4.
-
encodeStoryboard(List<File> checkpoints, String outputPath, {GifOptions options = const GifOptions()})
→ Future<File>
-
Creates a storyboard GIF from named screenshot files.
-
expectCaptureMatchesGolden(WidgetTester tester, String name, {GoldenMode mode = GoldenMode.compare, String outputDirectory = 'assets/widget_test/goldens'})
→ Future<void>
-
Compares a captured PNG with Flutter's approved golden baseline.
-
loadCaptureFont([String? family, String? assetPath])
→ Future<void>
-
Loads a font before a widget test paints text.
-
loadCaptureFontsFromManifest()
→ Future<bool>
-
Loads the app's declared font families from
FontManifest.json.
-
loadCaptureMaterialIcons()
→ Future<void>
-
Loads Flutter's local Material icon font for deterministic icon screenshots.
-
precacheCaptureImage(WidgetTester tester, ImageProvider<Object> provider)
→ Future<void>
-
Resolves and precaches an image provider in a widget test.
-
safeName(String input)
→ String
-
-
withCaptureDevice(WidgetTester tester, CaptureDevice device, Future<void> body())
→ Future<void>
-
Applies simulated logical size and DPR for
body, then restores both.
