Canvas:getPixel

Available since LÖVE 0.9.0 and removed in LÖVE 0.10.0
Use Canvas:newImageData instead.


Gets the pixel at the specified position from a Canvas.

Valid x and y values start at 0 and go up to canvas width and height minus 1.

This function can be very slow: it can cause the CPU to wait for the GPU to finish all the work currently in its queue, which can be a whole frame's worth (or more.)

Function

Synopsis

r, g, b, a = Canvas:getPixel( x, y )

Arguments

number x
The position of the pixel on the x-axis.
number y
The position of the pixel on the y-axis.

Returns

number r
The red component (0-255).
number g
The green component (0-255).
number b
The blue component (0-255).
number a
The alpha component (0-255).

See Also

© 2006–2020 LÖVE Development Team
Licensed under the GNU Free Documentation License, Version 1.3.
https://love2d.org/wiki/Canvas:getPixel