Difference between revisions of "ImageData"

m (1 revision: Imported docs from potato.)
Line 1: Line 1:
  
 +
Raw (decoded) image data.
  
 +
You can't draw ImageData directly to screen. See [[Image]] for that.
 
== Functions ==
 
== Functions ==
 
{{#ask: [[Category:Functions]] [[parent::ImageData]]
 
{{#ask: [[Category:Functions]] [[parent::ImageData]]
Line 31: Line 33:
 
* [[Image]]
 
* [[Image]]
 
[[Category:Types]]
 
[[Category:Types]]
{{#set:Description=}}
+
{{#set:Description=Raw (decoded) image data.
 +
}}

Revision as of 16:17, 14 February 2010

Raw (decoded) image data.

You can't draw ImageData directly to screen. See Image for that.

Functions

ImageData:encodeEncodes the ImageData to a file format and optionally writes it to the save directory.
ImageData:getDimensionsGets the width and height of the ImageData in pixels.
ImageData:getFormatGets the pixel format of the ImageData.
ImageData:getHeightGets the height of the ImageData in pixels.
ImageData:getPixelGets the color of a pixel.
ImageData:getStringGets the full ImageData as a string.
ImageData:getWidthGets the width of the ImageData in pixels.
ImageData:mapPixelTransform an image by applying a function to every pixel.
ImageData:pastePaste into ImageData from another source ImageData.
ImageData:setPixelSets the color of a pixel.

Examples

Images that have dimensions that are not a 2^n will display incorrectly as a white rectangle on some graphics chipsets. This function pads images so they will display correctly.

function newPaddedImage(filename)
	local source = love.image.newImageData(filename)
	local w, h = source:getWidth(), source:getHeight()
	
	-- Find closest power-of-two.
	local wp = math.pow(2, math.ceil(math.log(w)/math.log(2)))
	local hp = math.pow(2, math.ceil(math.log(h)/math.log(2)))
	
	-- Only pad if needed:
	if wp ~= w or hp ~= h then
		local padded = love.image.newImageData(wp, hp)
		padded:paste(source, 0, 0)
		return love.graphics.newImage(padded)
	end
	
	return love.graphics.newImage(source)
end

See Also