Module: GTK::Runtime::FramerateDiagnostics

Defined in:
dragon/framerate_diagnostics.rb

Instance Method Summary collapse

Instance Method Details

#current_framerate_primitivesObject


112
113
114
# File 'dragon/framerate_diagnostics.rb', line 112

def current_framerate_primitives
  framerate_diagnostics_primitives
end

#framerate_diagnostics_primitivesObject


116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'dragon/framerate_diagnostics.rb', line 116

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

#framerate_get_diagnosticsObject


8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'dragon/framerate_diagnostics.rb', line 8

def framerate_get_diagnostics
  <<-S
* INFO: Framerate Diagnostics
You can display these diagnostics using:

#+begin_src
  def tick args
    # ....

    # IMPORTANT: Put this at the END of the ~tick~ method.
    args.outputs.debug << args.gtk.framerate_diagnostics_primitives
  end
#+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

#framerate_warning_messageObject


94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'dragon/framerate_diagnostics.rb', line 94

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