Difference between revisions of "love.image.newImageData"

m
(Arguments)
(2 intermediate revisions by 2 users not shown)
Line 11: Line 11:
 
=== Returns ===
 
=== Returns ===
 
{{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|[[11.0]]|110|type=variant}}
 
{{newin|[[11.0]]|110|type=variant}}
Line 20: Line 21:
 
{{param|number|width|The width of the ImageData.}}
 
{{param|number|width|The width of the ImageData.}}
 
{{param|number|height|The height of the ImageData.}}
 
{{param|number|height|The height of the ImageData.}}
{{param|PixelFormat|format ("rgba8")|The format of the data parameter.}}
+
{{param|PixelFormat|format ("rgba8")|The pixel format of the ImageData.}}
{{param|string|data (nil)|The data to load into the ImageData, in the format specified by ''format''.}}
+
{{param|string|data (nil)|Optional raw byte data to load into the ImageData, in the format specified by ''format''.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|ImageData|imageData|The new ImageData object.}}
 
{{param|ImageData|imageData|The new ImageData object.}}
 +
 
== Function ==
 
== Function ==
 
{{newinoldin|[[0.10.0]]|100|[[11.0]]|110|type=variant}}
 
{{newinoldin|[[0.10.0]]|100|[[11.0]]|110|type=variant}}
Line 36: Line 38:
 
=== Returns ===
 
=== Returns ===
 
{{param|ImageData|imageData|The new ImageData object.}}
 
{{param|ImageData|imageData|The new ImageData object.}}
 +
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 45: Line 48:
 
=== Returns ===
 
=== Returns ===
 
{{param|ImageData|imageData|The new ImageData object.}}
 
{{param|ImageData|imageData|The new ImageData object.}}
 +
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 52: Line 56:
 
=== Arguments ===
 
=== Arguments ===
 
{{param|FileData|filedata|The encoded file data to decode into image data.}}
 
{{param|FileData|filedata|The encoded file data to decode into image data.}}
 +
=== Returns ===
 +
{{param|ImageData|imageData|The new ImageData object.}}
 +
 +
== Function ==
 +
{{newin|[[11.0]]|110|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
imageData = love.image.newImageData( data )
 +
</source>
 +
=== Arguments ===
 +
{{param|ByteData|data|The encoded byte data to load into the ImageData.}}
 +
 
=== Returns ===
 
=== Returns ===
 
{{param|ImageData|imageData|The new ImageData object.}}
 
{{param|ImageData|imageData|The new ImageData object.}}

Revision as of 14:40, 30 December 2019

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 ("rgba8")
The pixel format of the ImageData.
string data (nil)
Optional raw byte 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.

Function

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

Synopsis

imageData = love.image.newImageData( data )

Arguments

ByteData data
The encoded byte data to load into the ImageData.

Returns

ImageData imageData
The new ImageData object.

See Also


Other Languages