Piefiller

Graphical profiler for Love2D >= 0.9.2

Originally by devfirefly, heavily modified by Guard13007.

NOTE: This ReadMe does not currently represent the state of the library as I am currently reworking it.

Usage

Require the file:

  local piefiller = require("piefiller")

Make a new instance of piefiller:

  local Pie = piefiller:new()

Attach the piefiller to the part of your application that you want to monitor (love.update and love.draw typically are good places):

 function love.update()
	Pie:attach()
		-- do something
	Pie:detach()
 end

Draw the output and pass events to your piefiller:

 function love.draw()
	Pie:draw()
 end
 function love.keypressed(key)
 	Pie:keypressed(key)
 end
 function love.mousepressed(...)
 	Pie:mousepressed(...)
 end

With sufficient output, press the "E" key to output to file.

Keys

p = shows/hides the profiler

r = resets the pie

up = decreases depth

down = increases depth

= decreases step size

= = increases step size

s = shortens the names displayed

h = shows/hides hidden processes

e = saves to file called "Profile.txt" and opens directory for you

To redefine these:

Commands available:

reset
increase_depth
decrease_depth
increase_step_size
decrease_step_size
shorten_names
show_hidden
save_to_file
show_profiler

To redefine only one of the keys:

piefiller:setKey(command, key)

example:

piefiller:setKey("increase_depth","up")

To redefine all of the keys:

table = {
	"increase_depth" = "up"
}
piefiller:setKey(table)

For your own interpretation

If you wish to interpret the data on your own use piefiller:unpack(). Output is a table as such:

	data = {
		items = {
			{
				name,
				line_defined,
				current_line,
				source,
				time_taken,
				percentage,
				caller,
			}
		},
		about = {
			depth,
			step,
			totalTime,
		},
	}

Additional notes

The best depth to search in is usually 2 and sometimes 3.

When used in large applications the output may be too much to read, however you most likely will only be wanting to optimize the most expensive items. (And you can always output the data to review later.)

Planned features

See my ToDo list, issue #1 on GitHub.

2.2 KiB Raw Blame History