Difference between revisions of "love.graphics.newImage"

m
(Added new variant for 0.9.1)
Line 1: Line 1:
Creates a new [[Image]] from a filepath, [[File]] or an [[ImageData]].{{newobjectnotice}}
+
Creates a new [[Image]] from a filepath, [[FileData]] or an [[ImageData]].{{newobjectnotice}}
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 13: Line 13:
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
image = love.graphics.newImage( file )
+
image = love.graphics.newImage( imageData )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|File|file|A File pointing to an image.}}
+
{{param|ImageData|imageData|An ImageData object. The Image will use this ImageData to reload itself when [[love.graphics.setMode]] is called.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|Image|image|An Image object which can be drawn on screen.}}
 
{{param|Image|image|An Image object which can be drawn on screen.}}
  
 
== Function ==
 
== Function ==
 +
{{newin|[[0.9.0]]|090|type=variant}}
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
image = love.graphics.newImage( imageData )
+
image = love.graphics.newImage( compressedData )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|ImageData|imageData|An ImageData object. The Image will use this ImageData to reload itself when [[love.graphics.setMode]] is called.}}
+
{{param|CompressedData|compressedData|A CompressedData object. The Image will use this CompressedData to reload itself when [[love.window.setMode]] is called.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|Image|image|An Image object which can be drawn on screen.}}
 
{{param|Image|image|An Image object which can be drawn on screen.}}
  
 
== Function ==
 
== Function ==
{{newin|[[0.9.0]]|090|type=variant}}
+
{{newin|[[0.9.1]]|091|type=variant}}
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
image = love.graphics.newImage( compressedData )
+
image = love.graphics.newImage( filename, format )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|CompressedData|compressedData|A CompressedData object. The Image will use this CompressedData to reload itself when [[love.window.setMode]] is called.}}
+
{{param|string|filename|The filepath to the image file (or a FileData or ImageData or CompressedData object.)}}
 +
{{param|TextureFormat|format|The format to interpret the image's data as.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|Image|image|An Image object which can be drawn on screen.}}
 
{{param|Image|image|An Image object which can be drawn on screen.}}
 +
 
== See Also ==
 
== See Also ==
 
* [[parent::love.graphics]]
 
* [[parent::love.graphics]]

Revision as of 06:01, 1 April 2014

Creates a new Image from a filepath, FileData or an ImageData.

O.png This function can be slow if it is called repeatedly, such as from love.update or love.draw. If you need to use a specific resource often, create it once and store it somewhere it can be reused!  



Function

Synopsis

image = love.graphics.newImage( filename )

Arguments

string filename
The filepath to the image file.

Returns

Image image
An Image object which can be drawn on screen.

Function

Synopsis

image = love.graphics.newImage( imageData )

Arguments

ImageData imageData
An ImageData object. The Image will use this ImageData to reload itself when love.graphics.setMode is called.

Returns

Image image
An Image object which can be drawn on screen.

Function

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

Synopsis

image = love.graphics.newImage( compressedData )

Arguments

CompressedData compressedData
A CompressedData object. The Image will use this CompressedData to reload itself when love.window.setMode is called.

Returns

Image image
An Image object which can be drawn on screen.

Function

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

Synopsis

image = love.graphics.newImage( filename, format )

Arguments

string filename
The filepath to the image file (or a FileData or ImageData or CompressedData object.)
TextureFormat format
The format to interpret the image's data as.

Returns

Image image
An Image object which can be drawn on screen.

See Also


Other Languages