Difference between revisions of "ImageData:encode"
(Created page with 'Encodes the ImageData. == Function == === Synopsis === <source lang="lua"> data = ImageData:encode( format ) </source> === Arguments === {{param|ImageFormat|format|The format to …') |
m |
||
| (11 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
| − | Encodes the ImageData. | + | Encodes the ImageData to a file format and optionally writes it to the [[love.filesystem|save directory]]. |
| + | |||
== Function == | == Function == | ||
| + | {{newin|[[0.10.0]]|100|type=variant}} | ||
| + | === Synopsis === | ||
| + | <source lang="lua"> | ||
| + | filedata = ImageData:encode( format, filename ) | ||
| + | </source> | ||
| + | === Arguments === | ||
| + | {{param|ImageEncodeFormat|format|The format to encode the image as.}} | ||
| + | {{param|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 === | ||
| + | {{param|FileData|filedata|The encoded image as a new FileData object.}} | ||
| + | |||
| + | == Function == | ||
| + | {{newinoldin|[[0.8.0]]|080|[[0.10.0]]|100|type=variant}} | ||
| + | === Synopsis === | ||
| + | <source lang="lua"> | ||
| + | ImageData:encode( outFile ) | ||
| + | </source> | ||
| + | === Arguments === | ||
| + | {{param|string|outFile|Name of a file to write encoded data to. The format will be automatically deduced from the file extension.}} | ||
| + | === Returns === | ||
| + | Nothing. | ||
| + | |||
| + | == Function == | ||
| + | {{newinoldin|[[0.8.0]]|080|[[0.10.0]]|100|type=variant}} | ||
| + | === Synopsis === | ||
| + | <source lang="lua"> | ||
| + | ImageData:encode( outFile, format ) | ||
| + | </source> | ||
| + | === Arguments === | ||
| + | {{param|string|outFile|Name of a file to write encoded data to.}} | ||
| + | {{param|ImageEncodeFormat|format|The format to encode the image in.}} | ||
| + | === Returns === | ||
| + | Nothing. | ||
| + | |||
| + | == Function == | ||
| + | {{oldin|[[0.8.0]]|080|type=variant}} | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| Line 6: | Line 43: | ||
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
| − | {{param| | + | {{param|ImageEncodeFormat|format|The format to encode the image in.}} |
=== Returns === | === Returns === | ||
{{param|Data|data|The encoded image data.}} | {{param|Data|data|The encoded image data.}} | ||
| + | |||
== See Also == | == See Also == | ||
* [[parent::ImageData]] | * [[parent::ImageData]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
| − | {{#set:Description=Encodes ImageData.}} | + | {{#set:Description=Encodes the ImageData to a file format and optionally writes it to the [[love.filesystem|save directory]].}} |
| + | {{#set:Since=000}} | ||
| + | |||
| + | == User Notes == | ||
| + | * If you want the file to have an extension when saved add it in the file name. Example : <source lang="lua">image:encode("png","aPngImage.png")</source> | ||
| + | |||
== Other Languages == | == Other Languages == | ||
{{i18n|ImageData:encode}} | {{i18n|ImageData:encode}} | ||
Revision as of 23:01, 12 February 2020
Encodes the ImageData to a file format and optionally writes it to the save directory.
Contents
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.
See Also
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")
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
