You are here: Start » Filter Reference » Image » Image IO » LoadImageFromBuffer

LoadImageFromBuffer

Module:	FoundationLite

Loads a single image from a file stored in memory.

Applications

Use this filter when you received an image file through I/O communication, e.g. through a TcpIp connection.

Name	Type	Description
inBuffer	ByteBuffer	Source buffer containing image file data
inOffset	Integer	Image data start position in source buffer
inLength	Integer *	Image data length in source buffer
inLoadAlphaChannel	Bool	Whether to load the alpha channel (if exists) as an additional image channel
outImage	Image	Output image

Description

This function loads an Image from a common format file similarly to LoadImage, but instead of accessing the file system it uses only the memory by loading the file content from ByteBuffer.

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).

Examples

Description of usage of this filter can be found in examples and tutorial: IO HTTP Image Download.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type	Description
IoError	Reading beyond the end of the byte buffer in LoadImageFromBuffer.

Complexity Level