Back to FabImage Library website

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

LoadImage


Header: FIL.h
Namespace: fil
Module: FoundationLite

Loads a single image from a file.

Syntax

C++
C#
 
void fil::LoadImage
(
	const ftl::File& inFile,
	bool inLoadAlphaChannel,
	fil::Image& outImage
)

Parameters

Name Type Default Description
Input value inFile const File& Path to a file
Input value inLoadAlphaChannel bool Whether to load the alpha channel (if exists) as an additional image channel
Output value outImage Image& Output image

Description

The operation loads an image from a file 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).

The format of the image file is recognized automatically based on the file header.

The resulting outImage will be three-channel image of UInt8 pixel type, or sometimes of UInt16 pixel type for 16-bit depth images of supported formats (PNG, TIFF).

Hints

  • Set inFile to specify a path to the image file you want to load.
  • This filter can also be added easily by dragging and dropping an image file from Windows Explorer to the Program Editor in FabImage Studio.

Errors

List of possible exceptions:

Error type Description
DomainError Image is damaged or it is not a BMP, PNG, PNM, TIF or JPG file in LoadImage. 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, PNM, JPG and TIFF formats.

See Also