You are here: Start » AVL.NET » AVL.LoadImage(string, bool, AvlNet.Image)

AVL.LoadImage(string, bool, AvlNet.Image)

Loads a single image from a file.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax


public static void LoadImage(
	string inFile,
	bool inLoadAlphaChannel,
	out AvlNet.Image outImage
)

Parameters

inFile
Type: System.String
Path to a file
inLoadAlphaChannel
Type: System.Boolean
Whether to load the alpha channel (if exists) as an additional image channel
outImage
Type: AvlNet.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),
  • 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).

Errors

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

See also