Back to Aurora Vision Library Lite website
You are here: Start » Image » Image IO » SaveImageToJpeg
SaveImageToJpeg
Header: | AVL.h |
---|---|
Namespace: | avl |
Saves an image to a JPEG file.
Syntax
void avl::SaveImageToJpeg ( const avl::Image& inImage, const atl::File& inFile, atl::Optional<int> inQuality, bool inIgnoreErrors )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inImage | const Image& | An image to be saved | |||
inFile | const File& | Path to a file | |||
inQuality | Optional<int> | 0 - 100 | NIL | Quality | |
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 SaveImageToJpeg. Supported formats: UInt8, UInt16. |