SaveEditorToJPEG()
Summary
Saves the editor image as a JPEG compressed file.
Syntax
SaveEditorToJPEG(string editor_name, string jpeg_name, int quality)
| Argument | Contents |
|---|---|
| editor_name | The name of the editor, or null for the current editor |
| jpeg_name | The path and file name of the JPEG file to be created |
| quality | A number between 1 and 100 representing the quality of the desired image |
Notes
-
JPEG is a lossy compression, meaning that the output image will not be identical to the original. There is a trade-off between the quality of the image file and its size. The quality value is a number between 1 and 100, where 100 is the highest quality image and 1 is the lowest. A quality value of 75 is recommended.
-
This function is based on the work of the Independent JPEG Group's software.
-
It is preferable to use the SaveEditorToImage() function rather than this function.
Example
SaveEditorToJPEG(, "editor.jpg", 75)Error Codes
| Error Type | Meaning |
|---|---|
| Error | An error has occurred saving the file |
| NotFound | The editor was not found in the workspace |
See Also
| Function | Summary |
|---|---|
| SaveEditorToImage() | Saves the contents of the editor window to an image file |
| SaveEditorToBitmap() | Saves the editor image as a Windows bitmap file |