ImageData:encode

Encodes the ImageData to a file format and optionally writes it to the save directory.

Function

Available since LÖVE 0.10.0

This variant is not supported in earlier versions.

Synopsis

filedata = ImageData:encode( format, filename )

Arguments

ImageEncodeFormat format

The format to encode the image as.

string filename (nil)

The filename to write the file to. If nil, no file will be written but the FileData will still be returned.

Returns

FileData filedata

The encoded image as a new FileData object.

Function

Available since LÖVE 0.8.0 and removed in LÖVE 0.10.0

This variant is not supported in earlier or later versions.

Synopsis

ImageData:encode( outFile )

Arguments

string outFile

Name of a file to write encoded data to. The format will be automatically deduced from the file extension.

Returns

Nothing.

Function

Available since LÖVE 0.8.0 and removed in LÖVE 0.10.0

This variant is not supported in earlier or later versions.

Synopsis

ImageData:encode( outFile, format )

Arguments

string outFile

Name of a file to write encoded data to.

ImageEncodeFormat format

The format to encode the image in.

Returns

Nothing.

Function

Removed in LÖVE 0.8.0

This variant is not supported in that and later versions.

Synopsis

data = ImageData:encode( format )

Arguments

ImageEncodeFormat format

The format to encode the image in.

Returns

Data data

The encoded image data.

Examples

Draw a circle in a canvas, save it in file and display it on screen

  function love.load()
    canvas = love.graphics.newCanvas(800,600)
    love.graphics.setCanvas(canvas)
    love.graphics.circle("fill",200,200,100)
  -- need to set another Canvas to avoid Canvas:newImageData cannot be called while that Canvas is currently active.
    love.graphics.setCanvas()
    imagedata = canvas:newImageData()
    imagedata:encode("tga", "test.png")
  end
  
  function love.draw()
    love.graphics.draw(canvas)
  end

User Notes

• If you want the file to have an extension when saved add it in the file name. Example :

  image:encode("png","aPngImage.png")
  

See Also

• ImageData

Other Languages

Dansk – Deutsch – English – Español – Français – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Polski – Português – Română – Slovenský – Suomi – Svenska – Türkçe – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – ไทย – 日本語 – 正體中文 – 简体中文 – Tiếng Việt – 한국어
More info