Difference between revisions of "love.window.setIcon"

m (Updated description text)
(hint how to set icon in fused executables)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
{{newin|[[0.9.0]]|090|type=function}}
 
{{newin|[[0.9.0]]|090|type=function}}
 
Sets the window icon until the game is quit. Not all operating systems support very large icon images.
 
Sets the window icon until the game is quit. Not all operating systems support very large icon images.
 +
 +
Like t.window.icon in [[Config_Files|conf.lua]], love.window.setIcon allows you to set the executable icon at ''runtime''. Any fused executables will have the default LÖVE application icon in a file explorer or launcher (start menu, dock, etc). See [[Game Distribution]] for steps to change the icon.
 +
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
love.window.setIcon( imagedata )
+
success = love.window.setIcon( imagedata )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
{{param|ImageData|imagedata|The window icon image.}}
 
{{param|ImageData|imagedata|The window icon image.}}
 
=== Returns ===
 
=== Returns ===
Nothing.
+
{{param|boolean|success|Whether the icon has been set successfully.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::love.window]]
 
* [[parent::love.window]]

Latest revision as of 00:28, 1 May 2022

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

Sets the window icon until the game is quit. Not all operating systems support very large icon images.

Like t.window.icon in conf.lua, love.window.setIcon allows you to set the executable icon at runtime. Any fused executables will have the default LÖVE application icon in a file explorer or launcher (start menu, dock, etc). See Game Distribution for steps to change the icon.

Function

Synopsis

success = love.window.setIcon( imagedata )

Arguments

ImageData imagedata
The window icon image.

Returns

boolean success
Whether the icon has been set successfully.

See Also

Other Languages