Difference between revisions of "Canvas:getImageData"

m
(Clarified wording)
Line 1: Line 1:
 
{{newin|[[0.8.0]]|080|type=function|text=It has been renamed from [[Framebuffer:getImageData]]}}
 
{{newin|[[0.8.0]]|080|type=function|text=It has been renamed from [[Framebuffer:getImageData]]}}
Returns the image data stored in the [[Canvas]]. Think of it as taking a screenshot of the hidden screen that is the Canvas.
+
Generates [[ImageData]] from the contents of the Canvas. Think of it as taking a screenshot of the hidden screen that is the Canvas.
  
 
== Function ==
 
== Function ==
Line 10: Line 10:
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
{{param|ImageData|data|The image data stored in the Canvas.}}
+
{{param|ImageData|data|The new ImageData made from the Canvas' image.}}
  
 
== See Also ==
 
== See Also ==
Line 16: Line 16:
 
* [[love.graphics.newScreenshot]]
 
* [[love.graphics.newScreenshot]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Get stored [[ImageData]].}}
+
{{#set:Description=Generates [[ImageData]] from the contents of the Canvas.}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|Canvas:getImageData}}
 
{{i18n|Canvas:getImageData}}

Revision as of 09:55, 30 August 2013

Available since LÖVE 0.8.0
It has been renamed from Framebuffer:getImageData.

Generates ImageData from the contents of the Canvas. Think of it as taking a screenshot of the hidden screen that is the Canvas.

Function

Synopsis

data = Canvas:getImageData( )

Arguments

None.

Returns

ImageData data
The new ImageData made from the Canvas' image.

See Also

Other Languages