Difference between revisions of "love.window.setIcon"

m (Updated description text)
m (Added return value)
Line 4: Line 4:
 
=== 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]]

Revision as of 21:41, 20 September 2013

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.

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