Difference between revisions of "love.lowmemory"

(Created page)
 
m (type=function > type=callback for consistency)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{newin|[[0.10.0]]|100|type=function}}
+
{{newin|[[0.10.0]]|100|type=callback}}
 
Callback function triggered when the system is running out of memory on mobile devices.
 
Callback function triggered when the system is running out of memory on mobile devices.
  
Mobile operating systems may forcefully kill the game if it uses too much memory, so any non-critical resource should be removed if possible (by setting all variables referencing the resources to nil, and calling collectgarbage()), when this event is triggered. Sounds and images in particular tend to use the most memory.
+
Mobile operating systems may forcefully kill the game if it uses too much memory, so any non-critical resource should be removed if possible (by setting all variables referencing the resources to '''nil'''), when this event is triggered. Sounds and images in particular tend to use the most memory.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 12: Line 12:
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 +
== Examples ==
 +
Clear unused data and collect the garbage when memory is low.
 +
<source lang="lua">
 +
local cachetable = {}
 +
for i = 0, math.pi * 2, math.pi / 1000 do
 +
    cachetable[i] = math.sin(i)
 +
end
 +
 +
function love.lowmemory()
 +
    cachetable = {}
 +
    collectgarbage()
 +
end
 +
</source>
 
== See Also ==
 
== See Also ==
 
* [[parent::love]]
 
* [[parent::love]]

Latest revision as of 14:36, 31 January 2020

Available since LÖVE 0.10.0
This callback is not supported in earlier versions.

Callback function triggered when the system is running out of memory on mobile devices.

Mobile operating systems may forcefully kill the game if it uses too much memory, so any non-critical resource should be removed if possible (by setting all variables referencing the resources to nil), when this event is triggered. Sounds and images in particular tend to use the most memory.

Function

Synopsis

love.lowmemory( )

Arguments

None.

Returns

Nothing.

Examples

Clear unused data and collect the garbage when memory is low.

local cachetable = {}
for i = 0, math.pi * 2, math.pi / 1000 do
    cachetable[i] = math.sin(i)
end

function love.lowmemory()
    cachetable = {}
    collectgarbage()
end

See Also


Other Languages