mirror of
https://github.com/Insality/druid
synced 2025-06-27 10:27:48 +02:00
98 lines
2.1 KiB
Markdown
98 lines
2.1 KiB
Markdown
# druid.widget.fps_panel API
|
|
|
|
> at /druid/widget/fps_panel/fps_panel.lua
|
|
|
|
|
|
## Functions
|
|
- [init](#init)
|
|
- [on_remove](#on_remove)
|
|
- [update](#update)
|
|
- [push_fps_value](#push_fps_value)
|
|
|
|
|
|
## Fields
|
|
- [root](#root)
|
|
- [delta_time](#delta_time)
|
|
- [collect_time](#collect_time)
|
|
- [collect_time_counter](#collect_time_counter)
|
|
- [graph_samples](#graph_samples)
|
|
- [fps_samples](#fps_samples)
|
|
- [mini_graph](#mini_graph)
|
|
- [text_min_fps](#text_min_fps)
|
|
- [text_fps](#text_fps)
|
|
- [timer_id](#timer_id)
|
|
- [previous_time](#previous_time)
|
|
|
|
|
|
|
|
### init
|
|
|
|
---
|
|
```lua
|
|
fps_panel:init()
|
|
```
|
|
|
|
### on_remove
|
|
|
|
---
|
|
```lua
|
|
fps_panel:on_remove()
|
|
```
|
|
|
|
### update
|
|
|
|
---
|
|
```lua
|
|
fps_panel:update([dt])
|
|
```
|
|
|
|
- **Parameters:**
|
|
- `[dt]` *(any)*:
|
|
|
|
### push_fps_value
|
|
|
|
---
|
|
```lua
|
|
fps_panel:push_fps_value()
|
|
```
|
|
|
|
|
|
## Fields
|
|
<a name="root"></a>
|
|
- **root** (_node_)
|
|
|
|
<a name="delta_time"></a>
|
|
- **delta_time** (_number_): in seconds
|
|
|
|
<a name="collect_time"></a>
|
|
- **collect_time** (_integer_): in seconds
|
|
|
|
<a name="collect_time_counter"></a>
|
|
- **collect_time_counter** (_integer_)
|
|
|
|
<a name="graph_samples"></a>
|
|
- **graph_samples** (_number_)
|
|
|
|
<a name="fps_samples"></a>
|
|
- **fps_samples** (_table_): Store frame time in seconds last collect_time seconds
|
|
|
|
<a name="mini_graph"></a>
|
|
- **mini_graph** (_druid.widget.mini_graph_): Widget to display a several lines with different height in a row
|
|
Init, set amount of samples and max value of value means that the line will be at max height
|
|
Use `push_line_value` to add a new value to the line
|
|
Or `set_line_value` to set a value to the line by index
|
|
Setup colors inside template file (at minimum and maximum)
|
|
|
|
<a name="text_min_fps"></a>
|
|
- **text_min_fps** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
|
|
|
|
<a name="text_fps"></a>
|
|
- **text_fps** (_druid.text_): The component to handle text behaviour over a GUI Text node, mainly used to automatically adjust text size to fit the text area
|
|
|
|
<a name="timer_id"></a>
|
|
- **timer_id** (_unknown_)
|
|
|
|
<a name="previous_time"></a>
|
|
- **previous_time** (_unknown_)
|
|
|