A high-performance general-purpose compute library

Load an image from disk to an array More...

Functions

array loadimage (const char *filename, const bool is_color=false)
 C++ Interface for loading an image.
 
array loadImage (const char *filename, const bool is_color=false)
 C++ Interface for loading an image.
 
array loadImageNative (const char *filename)
 C++ Interface for loading an image as its original type.
 
af_err af_load_image (af_array *out, const char *filename, const bool isColor)
 C Interface for loading an image.
 
af_err af_load_image_native (af_array *out, const char *filename)
 C Interface for loading an image as is original type.
 

Detailed Description

Load an image from disk to an array

Supported formats include JPG, PNG, PPM and other formats supported by freeimage

Function Documentation

◆ af_load_image()

af_err af_load_image ( af_array * out,
const char * filename,
const bool isColor )

C Interface for loading an image.

Parameters
[out]outwill contain the image
[in]filenameis name of file to be loaded
[in]isColorboolean denoting if the image should be loaded as 1 channel or 3 channel
Returns
AF_SUCCESS if the color transformation is successful, otherwise an appropriate error code is returned.

◆ af_load_image_native()

af_err af_load_image_native ( af_array * out,
const char * filename )

C Interface for loading an image as is original type.

This load image function allows you to load images as u8, u16 or f32 depending on the type of input image as shown by the table below.

Bits per Color (Gray/RGB/RGBA Bits Per Pixel) Array Type Range
8 ( 8/24/32 BPP) u8 0 - 255
16 (16/48/64 BPP) u16 0 - 65535
32 (32/96/128 BPP) f32 0 - 1
Parameters
[out]outcontains them image
[in]filenameis name of file to be loaded
Returns
AF_SUCCESS if successful

◆ loadImage()

array loadImage ( const char * filename,
const bool is_color = false )

C++ Interface for loading an image.

Parameters
[in]filenameis name of file to be loaded
[in]is_colorboolean denoting if the image should be loaded as 1 channel or 3 channel
Returns
image loaded as af::array()

◆ loadimage()

array loadimage ( const char * filename,
const bool is_color = false )

C++ Interface for loading an image.

Parameters
[in]filenameis name of file to be loaded
[in]is_colorboolean denoting if the image should be loaded as 1 channel or 3 channel
Returns
image loaded as af::array()
Deprecated
Use loadImage instead

◆ loadImageNative()

array loadImageNative ( const char * filename)

C++ Interface for loading an image as its original type.

This load image function allows you to load images as u8, u16 or f32 depending on the type of input image as shown by the table below.

Bits per Color (Gray/RGB/RGBA Bits Per Pixel) Array Type Range
8 ( 8/24/32 BPP) u8 0 - 255
16 (16/48/64 BPP) u16 0 - 65535
32 (32/96/128 BPP) f32 0 - 1
Parameters
[in]filenameis name of file to be loaded
Returns
image loaded as af::array()