Back to FabImage Library website

You are here: Start » Function Reference » Image » Image IO » SaveImage

SaveImage


Header: FIL.h
Namespace: fil
Module: FoundationLite

Saves an image to a file.

Syntax

C++
C#
 
void fil::SaveImage
(
	const fil::Image& inImage,
	ftl::Optional<fil::ImageFileFormat::Type> inImageFileFormat,
	const ftl::File& inFile,
	bool inIgnoreErrors = false
)

Parameters

Name Type Default Description
Input value inImage const Image& An image to be saved
Input value inImageFileFormat Optional<ImageFileFormat::Type> NIL If Nil the format will be chosen on the basis of extension
Input value inFile const File& Path to a file
Input value inIgnoreErrors bool false Switches to re-trying and canceling in case of errors (e.g. when the disk is full)

Description

The operation saves an image to file encoded in one of the standard image file formats. Currently the filter supports the following formats:

  • BMP (*.bmp)
  • JPEG (*.jpg, *jpeg)
  • PNG (*.png),
  • PNM (*.pbm, *.pgm, *.ppm, *.pnm),
  • TIFF (*.tif, *.tiff).

Because of the limitations of the standard image formats, the filter is capable of saving three-channel images of UInt8 pixel type for all formats, and UInt16 for supported formats only (PNG, TIFF). To alter the format of an image one can use the filters contained in the Image Conversions category.

The inImageFileFormat input can be used to explicitly select the file format to be used. When inImageFileFormat is set to Auto the recognition of the desired image file format is based on the extension of the file being written, so it is essential that the extension is present and accurate. When extension of the file is not specified, it will be appended according to inImageFileFormat.

If the selected file does not exist, it will be created on filter execution. If the selected file does exist, it will be overwritten.

Errors

List of possible exceptions:

Error type Description
DomainError Unsupported pixel type in SaveImage.

See Also

  • LoadImage – Loads a single image from a file.