Difference between revisions of "Canvas:getPixel"

(Created page with "{{newin|0.9.0|090|type=function}} 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. == Fu...")
 
m (Added performance notice)
Line 3: Line 3:
  
 
Valid x and y values start at 0 and go up to canvas width and height minus 1.
 
Valid x and y values start at 0 and go up to canvas width and height minus 1.
 +
 +
{{notice|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 ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===

Revision as of 00:57, 11 August 2014

Available since LÖVE 0.9.0
This function is not supported in earlier versions.

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