love.graphics.getStats

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.

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.

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.

number shaderswitches Available since 0.10.2

The number of times the active Shader has been changed so far during the current frame.

number drawcallsbatched Available since 11.0

The number of draw calls that were saved by LÖVE's automatic batching, since the start of the frame.

Function

Available since LÖVE 11.0
This variant is not supported in earlier versions.

This variant accepts an existing table to fill in, instead of creating a new one.

Synopsis

stats = love.graphics.getStats( stats )

Arguments

table stats

A table which will be filled in with the stat fields below.

Returns

table stats

The table that was passed in above, now containing 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.

number shaderswitches

The number of times the active Shader has been changed so far during the current frame.

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

• love.graphics