IO
Image - Decode
Decode an image from a buffer.
IN
| Name | Type | Description |
|---|---|---|
| InBuffer | Buffer | Buffer. |
| InLoadAlphaChannel | Bool | Whether to load also the alpha channel （only if present）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Decoded image. |
| Error | ErrorState | Gets the execution error message |
Image - DecodeFromBase64
Decode an image from a Base64 encoded string. Note: The number of image pixels must be less than 2^30.
IN
| Name | Type | Description |
|---|---|---|
| InString | String | Base64 encoded string. |
| InLoadAlphaChannel | Bool | Whether to load also the alpha channel （only if present）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Decoded image. |
| Error | ErrorState | Gets the execution error message |
Image - Encode
Encode the image into a buffer. Note: The number of image pixels must be less than 2^30.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InImageFileFormat | Enum < ImageFileFormat > | File format （BMP, JPEG, PNG, TIFF） to which the image is saved. |
| InIgnoreErrors | Bool | Whether to ignore errors caused by the encoding process （in this case the function returns as nothing has happened）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutByteBuffer | Buffer | Output buffer. |
| Error | ErrorState | Gets the execution error message |
Image - EncodeToBase64
Encode the image into a Base64 string.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InImageFileFormat | Enum < ImageFileFormat > | File format （BMP, JPEG, PNG, TIFF） to which the image is saved. |
| InIgnoreErrors | Bool | Whether to ignore errors caused by the encoding process （in this case the function returns as nothing has happened）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutString | String | Base64 encoded string. |
| Error | ErrorState | Gets the execution error message |
Image - Load
Loads an image from a file. Note: The number of image pixels must be less than 2^30. All of following formats are supported: BMP, JPEG, PBM/PGM/PPM/PNM, PNG, TIFF, WEBP.
IN
| Name | Type | Description |
|---|---|---|
| InFile | PathFile | Name of the file. |
| InLoadAlphaChannel | Bool | Whether to load also the alpha channel （only if present）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Loaded image. |
| Error | ErrorState | Gets the execution error message |
Image - Save
Saves the image in a file. Note: The number of image pixels must be less than 2^30. All UInt8, single-channel or 3-channel, images can be saved with every format. The following formats have some exceptions: - PNM can also save UInt16 images, - PNG can also save UInt16 images and 4-channels images (RGBA), - TIFF can also save UInt16 and Float images.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InFile | PathFile | Name of the file. |
| InIgnoreErrors | Bool | Whether to ignore errors caused by the saving process （in this case the function returns as nothing has happened）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
Image - ImageTest
Load a test image
IN
| Name | Type | Description |
|---|---|---|
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| ImageOut | Image | Loaded image. |
| Error | ErrorState | Gets the execution error message |
Image - LoadFolder
Loads images from a folder and changes current image at each execution. Supported files are ".bmp", ".gif", ".jpeg", ".jpg", ".png", ".tif", ".tiff"
IN
| Name | Type | Description |
|---|---|---|
| InFolder | PathFile | Name of the folder. |
| InFileIndex | Int | Index of the image's file. |
| InAutoIncrement | Bool | Increments index file after each execution. |
| InAutoLoop | Bool | Restarts the InFileIndex to 0 when end of list is reached （only with InAutoIncrement == true）. |
| InLoadAlphaChannel | Bool | Whether to load also the alpha channel （only if present）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Loaded image. |
| OutFile | String | Loaded file. |
| OutCount | Int | The number of images in current folder |
| Error | ErrorState | Gets the execution error message |