Difference between revisions of "love.graphics.getStats"

(Created page)
 
m (Added example)
Line 16: Line 16:
 
{{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.}}
 +
== 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()
 +
    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]]

Revision as of 03:32, 29 August 2014

Available since LÖVE 0.9.2
This function is not supported in earlier versions.

Gets performance-related rendering statistics.

Function

Synopsis

stats = love.graphics.getStats( )

Arguments

None.

Returns

table stats
A table with the following fields:
number drawcalls
The number of draw calls made so far during the current frame. This includes all internal draw calls – for example, drawing smooth lines takes two draw calls.
number canvasswitches
The number of times the active Canvas has been switched so far during the current frame. This includes all internal canvas switches – for example, calling Canvas:clear if the Canvas isn't active will trigger two canvas switches.
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.

Examples

display the estimated amount of video memory used for textures

function love.load()
    love.graphics.setNewFont(24)
end

function love.draw()
    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