Difference between revisions of "love.graphics.getStats"
(Created page) |
(Merge variant.) |
||
(12 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
{{newin|[[0.9.2]]|092|type=function}} | {{newin|[[0.9.2]]|092|type=function}} | ||
− | Gets performance-related rendering statistics. | + | Gets performance-related rendering statistics. |
+ | |||
+ | |||
+ | {{notice|The per-frame metrics (drawcalls, canvasswitches, shaderswitches) are reset by [[love.graphics.present]], which for the default implementation of [[love.run]] is called right after the execution of [[love.draw]]. Therefore this function should probably be called at the end of [[love.draw]].}} | ||
+ | |||
== Function == | == Function == | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
− | stats = love.graphics.getStats( ) | + | stats = love.graphics.getStats( stats ) |
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
− | + | {{New feature|11.0| | |
+ | {{param|table|stats (nil)|A table which will be filled in with the stat fields below or nil to create a new table.}} | ||
+ | }} | ||
=== Returns === | === Returns === | ||
{{param|table|stats|A table with the following fields:}} | {{param|table|stats|A table with the following fields:}} | ||
− | {{subparam|number|drawcalls|The number of draw calls made so far during the current frame | + | {{subparam|number|drawcalls|The number of draw calls made so far during the current frame.}} |
− | {{subparam|number|canvasswitches|The number of times the active [[Canvas]] has been switched so far during the current frame | + | {{subparam|number|canvasswitches|The number of times the active [[Canvas]] has been switched so far during the current frame.}} |
− | {{subparam|number|texturememory|The estimated total size in bytes of video memory used by all loaded | + | {{subparam|number|texturememory|The estimated total size in bytes of video memory used by all loaded [[Image]]s, [[Canvas]]es, and [[Font]]s.}} |
{{subparam|number|images|The number of [[Image]] objects currently loaded.}} | {{subparam|number|images|The number of [[Image]] objects currently loaded.}} | ||
{{subparam|number|canvases|The number of [[Canvas]] objects currently loaded.}} | {{subparam|number|canvases|The number of [[Canvas]] objects currently loaded.}} | ||
{{subparam|number|fonts|The number of [[Font]] objects currently loaded.}} | {{subparam|number|fonts|The number of [[Font]] objects currently loaded.}} | ||
+ | {{New feature|0.10.2| | ||
+ | {{subparam|number|shaderswitches|The number of times the active [[Shader]] has been changed so far during the current frame.}} | ||
+ | }}{{New feature|11.0| | ||
+ | {{subparam|number|drawcallsbatched|The number of draw calls that were saved by LÖVE's automatic batching, since the start of the frame.}} | ||
+ | }} | ||
+ | |||
+ | == Examples == | ||
+ | === display the estimated amount of video memory used for textures === | ||
+ | <source lang="lua"> | ||
+ | function love.load() | ||
+ | love.graphics.setNewFont(24) | ||
+ | end | ||
+ | |||
+ | function love.draw() | ||
+ | -- some drawing code here -- | ||
+ | |||
+ | local stats = love.graphics.getStats() | ||
+ | |||
+ | local str = string.format("Estimated amount of texture memory used: %.2f MB", stats.texturememory / 1024 / 1024) | ||
+ | love.graphics.print(str, 10, 10) | ||
+ | end | ||
+ | </source> | ||
== See Also == | == See Also == | ||
* [[parent::love.graphics]] | * [[parent::love.graphics]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
− | {{#set:Sub-Category= | + | {{#set:Sub-Category=SystemInfo}} |
{{#set:Description=Gets performance-related rendering statistics.}} | {{#set:Description=Gets performance-related rendering statistics.}} | ||
== Other Languages == | == Other Languages == | ||
{{i18n|love.graphics.getStats}} | {{i18n|love.graphics.getStats}} |
Latest revision as of 01:19, 11 September 2024
Available since LÖVE 0.9.2 |
This function is not supported in earlier versions. |
Gets performance-related rendering statistics.
The per-frame metrics (drawcalls, canvasswitches, shaderswitches) are reset by love.graphics.present, which for the default implementation of love.run is called right after the execution of love.draw. Therefore this function should probably be called at the end of love.draw. |
Contents
Function
Synopsis
stats = love.graphics.getStats( stats )
Arguments
Available since LÖVE 11.0
table stats (nil)
- A table which will be filled in with the stat fields below or nil to create a new table.
Returns
table stats
- A table with the following fields:
number drawcalls
- The number of draw calls made so far during the current frame.
number canvasswitches
- The number of times the active Canvas has been switched so far during the current frame.
number texturememory
- The estimated total size in bytes of video memory used by all loaded Images, Canvases, and Fonts.
number images
- The number of Image objects currently loaded.
number canvases
- The number of Canvas objects currently loaded.
number fonts
- The number of Font objects currently loaded.
Available since LÖVE 0.10.2
Available since LÖVE 11.0
number drawcallsbatched
- The number of draw calls that were saved by LÖVE's automatic batching, since the start of the frame.
Examples
display the estimated amount of video memory used for textures
function love.load()
love.graphics.setNewFont(24)
end
function love.draw()
-- some drawing code here --
local stats = love.graphics.getStats()
local str = string.format("Estimated amount of texture memory used: %.2f MB", stats.texturememory / 1024 / 1024)
love.graphics.print(str, 10, 10)
end
See Also
Other Languages
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info