You are here: Start » FIL.NET » Function Reference » Image » Image IO » FIL.LoadImageFromBuffer
FIL.LoadImageFromBuffer
Loads a single image from a file stored in memory.
| Namespace: | FilNet |
|---|---|
| Assembly: | FIL.NET.dll |
Syntax
C++
C#
public static void LoadImageFromBuffer ( FilNet.ByteBuffer inBuffer, int inOffset, int? inLength, bool inLoadAlphaChannel, FilNet.Image outImage )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
 | inBuffer | FilNet.ByteBuffer | Source buffer containing image file data. | ||
| inOffset | int | 0 | Image data start position in source buffer. Default value: 0. | |
| inLength | int? | Image data length in source buffer. Default value: ftl::NIL. | ||
| inLoadAlphaChannel | bool | Whether to load the alpha channel (if exists) as an additional image channel. | ||
 | outImage | FilNet.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),
- 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).
Errors
List of possible exceptions:
| Error type | Description |
|---|---|
| IoError | Reading beyond the end of the byte buffer in LoadImageFromBuffer. |
