Merge pull request #5 from PlugFox/feature/dirty

Feature/dirty

Author: PlugFox

.github/workflows/deploy.yml

@@ -0,0 +1,14 @@
+name: Deploy
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+*"
+
+jobs:
+  deploy:
+    name: "Deploy to Pub.dev"
+    permissions:
+      id-token: write # Required for authentication using OIDC
+    uses: dart-lang/setup-dart/.github/workflows/publish.yml@v1

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.0.5
+
+- **CHANGED**: `frameRate` is replaced with `needsPaint` in `RePainter` delegate.
+
 ## 0.0.4
 
 - **ADDED**: More examples

README.md

@@ -9,7 +9,6 @@
 
 Library for creating and managing a canvas similar to CustomPaint but with more features.
 
-
 ## How to
 
 ### Handle mouse events

example/lib/src/feature/fps/fps_screen.dart

@@ -356,4 +356,5 @@ final class FrameRateGraph extends RePainterBase {
 
     canvas.restore();
   }
+
 }

example/lib/src/feature/sunflower/sunflower_screen.dart

@@ -239,15 +239,25 @@ class SunflowerPainter extends PerformanceOverlayPainter {
     final size = box.size;
     final radius = size.shortestSide / 2; // Радиус окружности
     final center = size.center(Offset.zero); // Центр окружности
+
+    // https://github.com/flutter/flutter/issues/160184#issuecomment-2560184639
+    int toARGB32(Color color) {
+      int floatToInt8(double x) => (x * 255.0).round() & 0xff;
+      return floatToInt8(color.a) << 24 |
+          floatToInt8(color.r) << 16 |
+          floatToInt8(color.g) << 8 |
+          floatToInt8(color.b) << 0;
+    }
+
     final outerDotColors = [
-      Colors.lime.value,
-      Colors.lightBlue.value,
-      Colors.lightGreen.value,
+      toARGB32(Colors.lime),
+      toARGB32(Colors.lightBlue),
+      toARGB32(Colors.lightGreen),
     ];
     final innerDotColors = [
-      Colors.deepOrange.value,
-      Colors.red.value,
-      Colors.pink.value,
+      toARGB32(Colors.deepOrange),
+      toARGB32(Colors.red),
+      toARGB32(Colors.pink),
     ];
 
     // 120 градусов

lib/src/repaint.dart

@@ -217,24 +217,11 @@ class RePaintBox extends RenderBox with WidgetsBindingObserver {
     if (!attached) return;
     final delta = elapsed - _lastFrameTime;
     final deltaMs = delta.inMicroseconds / Duration.microsecondsPerMillisecond;
-    switch (_painter.frameRate) {
-      case null:
-        // No frame rate limit.
-        _lastFrameTime = elapsed;
-        break;
-      case <= 0:
-        // Skip updating and rendering the game scene.
-        _lastFrameTime = elapsed;
-        return;
-      case int fr when fr > 0:
-        final targetFrameTime = 1000 / fr;
-        if (deltaMs < targetFrameTime) return; // Limit frame rate
-        _lastFrameTime = elapsed;
-        break;
-    }
+    _lastFrameTime = elapsed;
     // Update game scene and prepare for rendering.
     _painter.update(this, elapsed, deltaMs);
-    markNeedsPaint(); // Mark this game scene as dirty and schedule a repaint.
+    // Mark this game scene as dirty and schedule a repaint.
+    if (_painter.needsPaint) markNeedsPaint();
   }
 
   @override

lib/src/repaint_inline.dart

@@ -14,6 +14,7 @@ class RePaintInline<T extends Object?> extends StatefulWidget {
     this.update,
     this.tearDown,
     this.frameRate,
+    this.needsPaint = true,
     super.key,
   });
 
@@ -40,6 +41,25 @@ class RePaintInline<T extends Object?> extends StatefulWidget {
   /// 120 - 120 frames per second.
   final int? frameRate;
 
+  /// The controller needs to be repainted after the update.
+  ///
+  /// If `true`, the controller will be repainted.
+  /// That means the [paint] method will be called after the [update] method.
+  ///
+  /// If `false`, the controller will not be repainted.
+  /// That means the [paint] method
+  /// will not be called after the [update] method.
+  ///
+  /// This is useful when the controller does not need to be repainted
+  /// after the update if the scene is static and does not changed over time.
+  ///
+  /// You can use this flag to optimize the rendering process.
+  /// For example, implement a frame skipper or a frame limiter.
+  ///
+  /// If you want to skip the [update] method too,
+  /// just check it in the [update] method and return immediately.
+  final bool needsPaint;
+
   @override
   State<RePaintInline<T>> createState() => _RePaintInlineState<T>();
 }
@@ -72,17 +92,40 @@ final class _InlinePainter<T> extends RePainterBase {
 
   T? state;
 
+  double _delta = 0;
+
   @override
-  int? get frameRate => widget?.frameRate;
+  bool get needsPaint => _allowFrame && (widget?.needsPaint ?? true);
+  bool _allowFrame = false;
 
   @override
   void mount(RePaintBox box, PipelineOwner owner) {
     state = widget?.setUp?.call(box);
+    _delta = .0;
   }
 
   @override
   void update(RePaintBox box, Duration elapsed, double delta) {
-    state = widget?.update?.call(box, state as T, delta) ?? state;
+    _delta += delta;
+    switch (widget?.frameRate) {
+      case null:
+        // No frame rate limit.
+        _allowFrame = true;
+      case <= 0:
+        // Skip updating and rendering the game scene.
+        _allowFrame = false;
+        return;
+      case int fr when fr > 0:
+        final targetFrameTime = 1000 / fr;
+        if (_delta < targetFrameTime) {
+          _allowFrame = false;
+          return; // Limit frame rate
+        }
+        _allowFrame = true;
+    }
+    final dt = _delta;
+    _delta = .0; // Reset delta
+    state = widget?.update?.call(box, state as T, dt) ?? state;
   }
 
   @override
@@ -92,6 +135,7 @@ final class _InlinePainter<T> extends RePainterBase {
 
   @override
   void unmount() {
+    _delta = .0;
     widget?.tearDown?.call(state as T);
   }
 }

lib/src/repainter_base.dart

@@ -13,7 +13,7 @@ abstract /* base */ class RePainterBase implements RePainter {
   const RePainterBase();
 
   @override
-  int? get frameRate => null;
+  bool get needsPaint => true;
 
   @override
   void lifecycle(AppLifecycleState state) {

lib/src/repainter_interface.dart

@@ -6,22 +6,24 @@ import 'repaint.dart';
 
 /// The interface for a custom scene painter.
 abstract interface class RePainter {
-  /// The [frameRate] is used to limit the frame rate, (limitter and throttler).
+  /// The controller needs to be repainted after the update.
   ///
-  /// If `null`, the frame rate is not limited.
-  /// 0 - Do not render the scene.
-  /// 30 - 30 frames per second.
-  /// 60 - 60 frames per second.
-  /// 120 - 120 frames per second.
+  /// If `true`, the controller will be repainted.
+  /// That means the [paint] method will be called after the [update] method.
   ///
-  /// After the [frameRate] is set, the real frame rate will be lower.
-  /// Before the frame rate, updates are limited by the flutter ticker,
-  /// so the resulting frame rate will be noticeably lower.
-  /// Because calling the [update] does not immediately cause a redraw,
-  /// but only marks the render object as needing a redraw with
-  /// [RenderObject.markNeedsPaint],
-  /// thats why the frame rate is lower than expected.
-  int? get frameRate;
+  /// If `false`, the controller will not be repainted.
+  /// That means the [paint] method
+  /// will not be called after the [update] method.
+  ///
+  /// This is useful when the controller does not need to be repainted
+  /// after the update if the scene is static and does not changed over time.
+  ///
+  /// You can use this flag to optimize the rendering process.
+  /// For example, implement a frame skipper or a frame limiter.
+  ///
+  /// If you want to skip the [update] method too,
+  /// just check it in the [update] method and return immediately.
+  bool get needsPaint;
 
   /// Mount the controller.
   /// Called when the controller is attached to the render box.

pubspec.yaml

@@ -3,7 +3,7 @@ name: repaint
 description: >
   Library for creating and managing a canvas similar to CustomPaint but with more features.
 
-version: 0.0.4
+version: 0.0.5
 
 homepage: https://github.com/PlugFox/repaint