You are here: Start » Filter Reference » Image IO » LoadImageFromBuffer
LoadImageFromBuffer
Loads a single image from a file stored in memory.
| 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 |
Applications
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).
Errors
This filter can throw an exception to report error. Read how to deal with errors here: Error Handling
| Error type | Description |
|---|---|
| IoError | Reading beyond the end of the byte buffer. |
Complexity Level
This filter is available on Advanced Complexity Level.
