synced with v1.19

1 files changed, 165 insertions, 0 deletions

diff --git a/dragon/framerate_diagnostics.rb b/dragon/framerate_diagnostics.rb
new file mode 100644
index 0000000..6b952bd
--- /dev/null
+++ b/dragon/framerate_diagnostics.rb
@@ -0,0 +1,165 @@
+# Copyright 2019 DragonRuby LLC
+# MIT License
+# framerate_diagnostics.rb has been released under MIT (*only this file*).
+
+module GTK
+  class Runtime
+    # @visibility private
+    module FramerateDiagnostics
+      def framerate_get_diagnostics
+        <<-S
+* INFO: Framerate Diagnostics
+You can display these diagnostics using:
+
+#+begin_src
+  args.outputs.debug << args.gtk.framerate_diagnostics_primitives
+#+end_src
+
+** Draw Calls: ~<<~ Invocation Perf Counter
+Here is how many times ~args.outputs.PRIMITIVE_ARRAY <<~ was called:
+
+  #{$perf_counter_outputs_push_count} times invoked.
+
+If the number above is high, consider batching primitives so you can lower the invocation of ~<<~. For example.
+
+Instead of:
+
+#+begin_src
+  args.state.enemies.map do |e|
+    e.alpha = 128
+    args.outputs.sprites << e # <-- ~args.outputs.sprites <<~ is invoked a lot
+  end
+#+end_src
+
+Do this:
+
+#+begin_src
+  args.outputs.sprites << args.state
+                              .enemies
+                              .map do |e| # <-- ~args.outputs.sprites <<~ is only invoked once.
+    e.alpha = 128
+    e
+  end
+#+end_src
+
+** Array Primitives
+~Primitives~ represented as an ~Array~ (~Tuple~) are great for prototyping, but are not as performant as using a ~Hash~.
+
+Here is the number of ~Array~ primitives that were encountered:
+
+  #{$perf_counter_primitive_is_array} Array Primitives.
+
+If the number above is high, consider converting them to hashes. For example.
+
+Instead of:
+
+#+begin_src
+  args.outputs.sprites << [0, 0, 100, 100, 'sprites/enemy.png']
+#+begin_end
+
+Do this:
+
+#+begin_src
+  args.outputs.sprites << { x: 0,
+                            y: 0,
+                            w: 100,
+                            h: 100,
+                            path: 'sprites/enemy.png' }
+#+begin_end
+
+** Primitive Counts
+Here are the draw counts ordered by lowest to highest z order:
+
+PRIMITIVE   COUNT, STATIC COUNT
+solids:     #{@args.outputs.solids.length}, #{@args.outputs.static_solids.length}
+sprites:    #{@args.outputs.sprites.length}, #{@args.outputs.static_sprites.length}
+primitives: #{@args.outputs.primitives.length}, #{@args.outputs.static_primitives.length}
+labels:     #{@args.outputs.labels.length}, #{@args.outputs.static_labels.length}
+lines:      #{@args.outputs.lines.length}, #{@args.outputs.static_lines.length}
+borders:    #{@args.outputs.borders.length}, #{@args.outputs.static_borders.length}
+debug:      #{@args.outputs.debug.length}, #{@args.outputs.static_debug.length}
+reserved:   #{@args.outputs.reserved.length}, #{@args.outputs.static_reserved.length}
+
+** Additional Help
+Come to the DragonRuby Discord channel if you need help troubleshooting performance issues. http://discord.dragonruby.org.
+
+Source code for these diagnostics can be found at: [[https://github.com/dragonruby/dragonruby-game-toolkit-contrib/]]
+S
+      end
+
+      def framerate_warning_message
+        <<-S
+* WARNING:
+Your average framerate dropped below 60 fps for two seconds.
+
+The average FPS was #{current_framerate}.
+
+** How To Disable Warning
+If this warning is getting annoying put the following in your tick method:
+
+#+begin_src
+  args.gtk.log_level = :off
+#+end_src
+
+#{framerate_get_diagnostics}
+  S
+      end
+
+      def current_framerate_primitives
+        framerate_diagnostics_primitives
+      end
+
+      def framerate_diagnostics_primitives
+        [
+          { x: 0, y: 93.from_top, w: 500, h: 93, a: 128 }.solid,
+          {
+            x: 5,
+            y: 5.from_top,
+            text: "More Info via DragonRuby Console: $gtk.framerate_diagnostics",
+            r: 255,
+            g: 255,
+            b: 255,
+            size_enum: -2
+          }.label,
+          {
+            x: 5,
+            y: 20.from_top,
+            text: "FPS: %.2f" % args.gtk.current_framerate,
+            r: 255,
+            g: 255,
+            b: 255,
+            size_enum: -2
+          }.label,
+          {
+            x: 5,
+            y: 35.from_top,
+            text: "Draw Calls: #{$perf_counter_outputs_push_count}",
+            r: 255,
+            g: 255,
+            b: 255,
+            size_enum: -2
+          }.label,
+          {
+            x: 5,
+            y: 50.from_top,
+            text: "Array Primitives: #{$perf_counter_primitive_is_array}",
+            r: 255,
+            g: 255,
+            b: 255,
+            size_enum: -2
+          }.label,
+          {
+            x: 5,
+            y: 65.from_top,
+            text: "Mouse: #{@args.inputs.mouse.point}",
+            r: 255,
+            g: 255,
+            b: 255,
+            size_enum: -2
+          }.label,
+        ]
+      end
+
+    end
+  end
+end