Difference between revisions of "love.image.newImageData"

(Specify format of the string to pass as initial data.)
(Add PixelFormat variant)
Line 12: Line 12:
 
{{param|ImageData|imageData|The new blank ImageData object. Each pixel's color values, (including the alpha values!) will be set to zero.}}
 
{{param|ImageData|imageData|The new blank ImageData object. Each pixel's color values, (including the alpha values!) will be set to zero.}}
 
== Function ==
 
== Function ==
{{newin|[[0.10.0]]|100|type=variant}}
+
{{newin|[[11.0]]|110|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
imageData = love.image.newImageData( width, height, format, data )
 +
</source>
 +
=== Arguments ===
 +
{{param|number|width|The width of the ImageData.}}
 +
{{param|number|height|The height of the ImageData.}}
 +
{{param|PixelFormat|format|The format of the data parameter.}}
 +
{{param|string|data|The data to load into the ImageData, in the format specified by ''format''.}}
 +
=== Returns ===
 +
{{param|ImageData|imageData|The new ImageData object.}}
 +
== Function ==
 +
{{newinoldin|[[0.10.0]]|100|[[11.0]]|110|type=variant}}
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">

Revision as of 17:35, 4 April 2018

Creates a new ImageData object.

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

imageData = love.image.newImageData( width, height )

Arguments

number width
The width of the ImageData.
number height
The height of the ImageData.

Returns

ImageData imageData
The new blank ImageData object. Each pixel's color values, (including the alpha values!) will be set to zero.

Function

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

Synopsis

imageData = love.image.newImageData( width, height, format, data )

Arguments

number width
The width of the ImageData.
number height
The height of the ImageData.
PixelFormat format
The format of the data parameter.
string data
The data to load into the ImageData, in the format specified by format.

Returns

ImageData imageData
The new ImageData object.

Function

Available since LÖVE 0.10.0 and removed in LÖVE 11.0
This variant is not supported in earlier or later versions.

Synopsis

imageData = love.image.newImageData( width, height, data )

Arguments

number width
The width of the ImageData.
number height
The height of the ImageData.
string data
The data to load into the ImageData (RGBA bytes, left to right and top to bottom).

Returns

ImageData imageData
The new ImageData object.

Function

Synopsis

imageData = love.image.newImageData( filename )

Arguments

string filename
The filename of the image file.

Returns

ImageData imageData
The new ImageData object.

Function

Synopsis

imageData = love.image.newImageData( filedata )

Arguments

FileData filedata
The encoded file data to decode into image data.

Returns

ImageData imageData
The new ImageData object.

See Also


Other Languages