Difference between revisions of "love.image.newImageData"

(Undo revision 9356 by Santos (talk))
m
(12 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
Create a new ImageData object.
+
Creates a new [[ImageData]] object.
 
{{newobjectnotice}}
 
{{newobjectnotice}}
 
== Function ==
 
== Function ==
Line 9: Line 9:
 
{{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.}}
 +
=== Returns ===
 +
{{param|ImageData|imageData|The new blank ImageData object. Each pixel's color values, (including the alpha values!) will be set to zero.}}
 +
 +
== Function ==
 +
{{newin|[[11.0]]|110|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
imageData = love.image.newImageData( width, height, format, rawdata )
 +
</source>
 +
=== Arguments ===
 +
{{param|number|width|The width of the ImageData.}}
 +
{{param|number|height|The height of the ImageData.}}
 +
{{param|PixelFormat|format ("rgba8")|The pixel format of the ImageData.}}
 +
{{param|string or Data|rawdata (nil)|Optional raw byte 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 ===
 +
<source lang="lua">
 +
imageData = love.image.newImageData( width, height, rawdata )
 +
</source>
 +
=== Arguments ===
 +
{{param|number|width|The width of the ImageData.}}
 +
{{param|number|height|The height of the ImageData.}}
 +
{{param|string|rawdata|The data to load into the ImageData (RGBA bytes, left to right and top to bottom).}}
 
=== Returns ===
 
=== Returns ===
 
{{param|ImageData|imageData|The new ImageData object.}}
 
{{param|ImageData|imageData|The new ImageData object.}}
 +
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 20: Line 48:
 
=== Returns ===
 
=== Returns ===
 
{{param|ImageData|imageData|The new ImageData object.}}
 
{{param|ImageData|imageData|The new ImageData object.}}
 +
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
−
imageData = love.image.newImageData( file )
+
imageData = love.image.newImageData( filedata )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
−
{{param|File|file|A File pointing to an image.}}
+
{{param|FileData|filedata|The encoded file data to decode into image data.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|ImageData|imageData|The new ImageData object.}}
 
{{param|ImageData|imageData|The new ImageData object.}}
 +
 
== Function ==
 
== Function ==
 +
{{newin|[[11.0]]|110|type=variant}}
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
−
imageData = love.image.newImageData( data )
+
imageData = love.image.newImageData( encodeddata )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
−
{{param|Data|data|The encoded data to decode into image data.}}
+
{{param|Data|encodeddata|The encoded data to load into the ImageData.}}
 +
 
 
=== Returns ===
 
=== Returns ===
 
{{param|ImageData|imageData|The new ImageData object.}}
 
{{param|ImageData|imageData|The new ImageData object.}}
Line 42: Line 74:
 
* [[Constructs::ImageData]]
 
* [[Constructs::ImageData]]
 
[[Category:Functions]]
 
[[Category:Functions]]
−
{{#set:Description=Create a new blank ImageData.}}
+
{{#set:Description=Creates a new ImageData object.}}
 
{{#set:Since=000}}
 
{{#set:Since=000}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|love.image.newImageData}}
 
{{i18n|love.image.newImageData}}

Revision as of 21:13, 21 July 2020

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, rawdata )

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 or Data rawdata (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, rawdata )

Arguments

number width
The width of the ImageData.
number height
The height of the ImageData.
string rawdata
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( encodeddata )

Arguments

Data encodeddata
The encoded data to load into the ImageData.

Returns

ImageData imageData
The new ImageData object.

See Also


Other Languages

Dansk – Deutsch – English – Español – Français – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Polski – Português – Română – Slovenský – Suomi – Svenska – Türkçe – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – ไทย – 日本語 – 正體中文 – 简体中文 – Tiếng Việt – 한국어
More info

Retrieved from "http://www.love2d.org/w/index.php?title=love.image.newImageData&oldid=25469"