Difference between revisions of "Canvas:newImageData"

(Updated for 11.0)
m (CanvasMipmapMode -> MipmapMode)
 
(One intermediate revision by one other user not shown)
Line 21: Line 21:
 
=== Arguments ===
 
=== Arguments ===
 
{{param|number|slice|The cubemap face index, array index, or depth layer for [[TextureType|cubemap, array, or volume]] type Canvases, respectively. This argument is ignored for regular 2D canvases.}}
 
{{param|number|slice|The cubemap face index, array index, or depth layer for [[TextureType|cubemap, array, or volume]] type Canvases, respectively. This argument is ignored for regular 2D canvases.}}
{{param|number|mipmap (1)|The mipmap index to use, for Canvases with [[CanvasMipmapMode|mipmaps]].}}
+
{{param|number|mipmap (1)|The mipmap index to use, for Canvases with [[MipmapMode|mipmaps]].}}
 
{{param|number|x|The x-axis of the top-left corner (in pixels) of the area within the Canvas to capture.}}
 
{{param|number|x|The x-axis of the top-left corner (in pixels) of the area within the Canvas to capture.}}
 
{{param|number|y|The y-axis of the top-left corner (in pixels) of the area within the Canvas to capture.}}
 
{{param|number|y|The y-axis of the top-left corner (in pixels) of the area within the Canvas to capture.}}
Line 45: Line 45:
 
== See Also ==
 
== See Also ==
 
* [[parent::Canvas]]
 
* [[parent::Canvas]]
* [[love.graphics.newScreenshot]]
+
* [[love.graphics.captureScreenshot]]
 
* [[Constructs::ImageData]]
 
* [[Constructs::ImageData]]
 
[[Category:Functions]]
 
[[Category:Functions]]

Latest revision as of 14:57, 29 July 2020

Available since LÖVE 0.10.0
It has been renamed from Canvas:getImageData.

Generates ImageData from the contents of the Canvas.


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

data = Canvas:newImageData( )

Arguments

None.

Returns

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

Function

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

Synopsis

data = Canvas:newImageData( slice, mipmap, x, y, width, height )

Arguments

number slice
The cubemap face index, array index, or depth layer for cubemap, array, or volume type Canvases, respectively. This argument is ignored for regular 2D canvases.
number mipmap (1)
The mipmap index to use, for Canvases with mipmaps.
number x
The x-axis of the top-left corner (in pixels) of the area within the Canvas to capture.
number y
The y-axis of the top-left corner (in pixels) of the area within the Canvas to capture.
number width
The width in pixels of the area within the Canvas to capture.
number height
The height in pixels of the area within the Canvas to capture.

Returns

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

Function

Removed in LÖVE 11.0
This variant is not supported in that and later versions.

Synopsis

data = Canvas:newImageData( x, y, width, height )

Arguments

number x
The x-axis of the top-left corner (in pixels) of the area within the Canvas to capture.
number y
The y-axis of the top-left corner (in pixels) of the area within the Canvas to capture.
number width
The width in pixels of the area within the Canvas to capture.
number height
The height in pixels of the area within the Canvas to capture.

Returns

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

See Also

Other Languages