tangent/Piefiller
1
0
Fork 0
mirror of https://github.com/TangentFoxy/Piefiller.git synced 2024-11-19 17:14:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
/Fox --develop 2017-07-26 23:21:15 -07:00 committed by GitHub
parent eb128e3ecc
commit 9215842cc8
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -4,31 +4,33 @@ Graphical profiler for Love2D >= 0.9.2
Originally by devfirefly, heavily modified by Guard13007. Originally by devfirefly, heavily modified by Guard13007.
Note that a lot of functionality is undocumented right now, and that some functionality doesn't work as originally intended (such as setting the position and scale of the profiler). The default settings should get you going pretty easily, the key thing to maybe change is calling the constructor with a table with its own `scale` value.
# Usage # Usage
1) Require the file: 1) Require the file:
```lua ```lua
local piefiller = require("piefiller") local Piefiller = require("piefiller")
``` ```
2) Make a new instance of piefiller: 2) Make a new instance of piefiller:
```lua ```lua
local Pie = piefiller:new() local pie = Piefiller()
``` ```
3) Attach the piefiller to the part of your application that you want to monitor (love.update and love.draw typically are good places): 3) Attach the piefiller to the part of your application that you want to monitor (love.update and love.draw typically are good places):
```lua ```lua
function love.update() function love.update()
Pie:attach() pie:attach()
-- do something -- do something
Pie:detach() pie:detach()
end end
``` ```
4) Draw the output and pass key events to your piefiller: 4) Draw the output and pass key events to your piefiller:
```lua ```lua
function love.draw() function love.draw()
Pie:draw() pie:draw()
end end
function love.keypressed(key) function love.keypressed(key)
Pie:keypressed(key) pie:keypressed(key)
end end
``` ```
5) With sufficient output, press the `E` key to output to file. Example output: 5) With sufficient output, press the `E` key to output to file. Example output:
@ -78,13 +80,13 @@ show_profiler
To redefine only one of the keys: To redefine only one of the keys:
```lua ```lua
piefiller:setKey(command, key) pie:setKey(command, key)
``` ```
example: example:
```lua ```lua
piefiller:setKey("increase_depth","up") pie:setKey("increase_depth","up")
``` ```
To redefine all of the keys: To redefine all of the keys:
@ -92,12 +94,12 @@ To redefine all of the keys:
table = { table = {
"increase_depth" = "up" "increase_depth" = "up"
} }
piefiller:setKey(table) pie:setKey(table)
``` ```
# For your own interpretation # For your own interpretation
If you wish to interpret the data on your own use `piefiller:unpack()`. If you wish to interpret the data on your own use `pie:unpack()`.
Output is a table as such: Output is a table as such:
```lua ```lua