Difference between revisions of "ImageData:mapPixel"

m (Added New feature template and default values)
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
Transform an image by applying a function to every pixel.
 
Transform an image by applying a function to every pixel.
  
This function is a higher order function. It takes another function as a parameter, and calls it once for each pixel in the ImageData.
+
This function is a [https://en.wikipedia.org/wiki/Higher-order_function higher-order function]. It takes another function as a parameter, and calls it once for each pixel in the ImageData.
  
 
The passed function is called with six parameters for each pixel in turn. The parameters are numbers that represent the x and y coordinates of the pixel and its red, green, blue and alpha values. The function should return the new red, green, blue, and alpha values for that pixel.
 
The passed function is called with six parameters for each pixel in turn. The parameters are numbers that represent the x and y coordinates of the pixel and its red, green, blue and alpha values. The function should return the new red, green, blue, and alpha values for that pixel.
Line 14: Line 14:
 
</source>
 
</source>
  
 +
In versions prior to [[11.0]], color component values were within the range of 0 to 255 instead of 0 to 1.
 
== Function ==
 
== Function ==
=== Synopsis ===
 
<source lang="lua">
 
ImageData:mapPixel( pixelFunction )
 
</source>
 
=== Arguments ===
 
{{param|function|pixelFunction|Function to apply to every pixel.}}
 
=== Returns ===
 
Nothing.
 
 
== Function ==
 
{{newin|[[0.9.0]]|090|type=variant}}
 
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 32: Line 22:
 
=== Arguments ===
 
=== Arguments ===
 
{{param|function|pixelFunction|Function to apply to every pixel.}}
 
{{param|function|pixelFunction|Function to apply to every pixel.}}
{{param|number|x|The x-axis of the top-left corner of the area within the ImageData to apply the function to.}}
+
{{New feature|0.9.0|
{{param|number|y|The y-axis of the top-left corner of the area within the ImageData to apply the function to.}}
+
{{param|number|x (0)|The x-axis of the top-left corner of the area within the ImageData to apply the function to.}}
{{param|number|width|The width of the area within the ImageData to apply the function to.}}
+
{{param|number|y (0)|The y-axis of the top-left corner of the area within the ImageData to apply the function to.}}
{{param|number|height|The height of the area within the ImageData to apply the function to.}}
+
{{param|number|width (ImageData:getWidth())|The width of the area within the ImageData to apply the function to.}}
 +
{{param|number|height (ImageData:getHeight())|The height of the area within the ImageData to apply the function to.}}
 +
}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
Line 43: Line 35:
 
<source lang="lua">
 
<source lang="lua">
 
function brighten( x, y, r, g, b, a )
 
function brighten( x, y, r, g, b, a )
   r = math.min(r * 3, 255)
+
   r = math.min(r * 3, 1)
   g = math.min(g * 3, 255)
+
   g = math.min(g * 3, 1)
   b = math.min(b * 3, 255)
+
   b = math.min(b * 3, 1)
 
   return r,g,b,a
 
   return r,g,b,a
 
end
 
end
Line 54: Line 46:
 
<source lang="lua">
 
<source lang="lua">
 
function stripey( x, y, r, g, b, a )
 
function stripey( x, y, r, g, b, a )
   r = math.min(r * math.sin(x*100)*2, 255)
+
   r = math.min(r * math.sin(x*100)*2, 1)
   g = math.min(g * math.cos(x*150)*2, 255)
+
   g = math.min(g * math.cos(x*150)*2, 1)
   b = math.min(b * math.sin(x*50)*2, 255)
+
   b = math.min(b * math.sin(x*50)*2, 1)
 
   return r,g,b,a
 
   return r,g,b,a
 
end
 
end
Line 62: Line 54:
 
imageData:mapPixel( stripey )
 
imageData:mapPixel( stripey )
 
</source>
 
</source>
source: http://khason.net/blog/hlsl-pixel-shader-effects-tutorial/
+
source: http://khason.net/blog/hlsl-pixel-shader-effects-tutorial/ (broken 11/16. See [http://blogs.microsoft.co.il/tamir/2008/06/17/hlsl-pixel-shader-effects-tutorial/ blogs.microsoft.co.il] or [http://web.archive.org/web/20150515111551/http://khason.net/blog/hlsl-pixel-shader-effects-tutorial/ archive.org] mirrors.)
 +
 
 
== See Also ==
 
== See Also ==
 
* [[parent::ImageData]]
 
* [[parent::ImageData]]

Revision as of 08:50, 14 August 2019

Transform an image by applying a function to every pixel.

This function is a higher-order function. It takes another function as a parameter, and calls it once for each pixel in the ImageData.

The passed function is called with six parameters for each pixel in turn. The parameters are numbers that represent the x and y coordinates of the pixel and its red, green, blue and alpha values. The function should return the new red, green, blue, and alpha values for that pixel.

function pixelFunction(x, y, r, g, b, a)
    -- template for defining your own pixel mapping function
    -- perform computations giving the new values for r, g, b and a
    -- ...
    return r, g, b, a
end

In versions prior to 11.0, color component values were within the range of 0 to 255 instead of 0 to 1.

Function

Synopsis

ImageData:mapPixel( pixelFunction, x, y, width, height )

Arguments

function pixelFunction
Function to apply to every pixel.
Available since LÖVE 0.9.0
number x (0)
The x-axis of the top-left corner of the area within the ImageData to apply the function to.
number y (0)
The y-axis of the top-left corner of the area within the ImageData to apply the function to.
number width (ImageData:getWidth())
The width of the area within the ImageData to apply the function to.
number height (ImageData:getHeight())
The height of the area within the ImageData to apply the function to.

Returns

Nothing.

Examples

Brighten an image:

function brighten( x, y, r, g, b, a )
   r = math.min(r * 3, 1)
   g = math.min(g * 3, 1)
   b = math.min(b * 3, 1)
   return r,g,b,a
end

imageData:mapPixel( brighten )

Add colored stripes to an image:

function stripey( x, y, r, g, b, a )
   r = math.min(r * math.sin(x*100)*2, 1)
   g = math.min(g * math.cos(x*150)*2, 1)
   b = math.min(b * math.sin(x*50)*2, 1)
   return r,g,b,a
end

imageData:mapPixel( stripey )

source: http://khason.net/blog/hlsl-pixel-shader-effects-tutorial/ (broken 11/16. See blogs.microsoft.co.il or archive.org mirrors.)

See Also


Other Languages