Back to FabImage Library website

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

SaveImageToPng


Header: FIL.h
Namespace: fil
Module: FoundationLite

Saves an image to a PNG file.

Syntax

C++
C#
 
void fil::SaveImageToPng
(
	const fil::Image& inImage,
	const ftl::File& inFile,
	ftl::Optional<int> inCompressionLevel,
	bool inIgnoreErrors
)

Parameters

Name Type Range Default Description
Input value inImage const Image& An image to be saved
Input value inFile const File& Path to a file
Input value inCompressionLevel Optional<int> 0 - 9 NIL Compression level
Input value inIgnoreErrors bool Switches to re-trying and canceling in case of errors (e.g. when the disk is full)

Requirements

For input inImage only pixel formats are supported: uint8, uint16.

Read more about pixel formats in Image documentation.

Errors

List of possible exceptions:

Error type Description
DomainError Not supported inImage pixel format in SaveImageToPng. Supported formats: UInt8, UInt16.