Back to Adaptive Vision Library website

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

LoadImageFormat


Header: AVL.h
Namespace: avl
Module: FoundationLite

Loads a single image format from a file without loading all image data.

Syntax

C++
C#
 
void avl::LoadImageFormat
(
	const atl::File& inFile,
	bool inLoadAlphaChannel,
	avl::ImageFormat& outImageFormat
)

Parameters

Name Type Default Description
Input value
 inFile const File& Path to a file
Input value
 inLoadAlphaChannel bool
Output value
 outImageFormat ImageFormat&

Errors

List of possible exceptions:

Error type Description
DomainError Image is damaged or it is not a BMP, PNG, TIF or JPG file in LoadImageFormat. File: File name
Unable to open an image. Image header format is unrecognized. Image format is unknown or image is damaged. Load image supports only BMP, PNG, JPG and TIFF formats.