Difference between revisions of "Canvas:getPixel"

m (Added performance notice)
(Added oldin)
Line 1: Line 1:
 
{{newin|[[0.9.0]]|090|type=function}}
 
{{newin|[[0.9.0]]|090|type=function}}
 +
{{oldin|[[0.10.0]]|100|type=function|text=Use [[Canvas:newImageData]] instead.}}
 +
 
Gets the pixel at the specified position from a Canvas.
 
Gets the pixel at the specified position from a Canvas.
  

Revision as of 04:57, 17 December 2015

Available since LÖVE 0.9.0
This function is not supported in earlier versions.
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.

O.png 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

Other Languages