BGAPI2 ImageProcessor Functions

Functions related to the Image Processor. More...

Typedefs

typedef struct BGAPI2_ImageProcessor BGAPI2_ImageProcessor
 Struct for pointers of type ImageProcessor. More...
 

Functions

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_CreateImageProcessor (BGAPI2_ImageProcessor **img_proc)
 Creates an image processor. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ReleaseImageProcessor (BGAPI2_ImageProcessor *img_proc)
 Release an image processor. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_GetVersion (BGAPI2_ImageProcessor *img_proc, char *version, bo_uint64 *string_length)
 Get the version string of image processor. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_CreateEmptyImage (BGAPI2_ImageProcessor *img_proc, BGAPI2_Image **image)
 Creates an empty image by image processor. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_CreateImage (BGAPI2_ImageProcessor *img_proc, bo_uint width, bo_uint height, const char *pixelformat, void *buffer, bo_uint64 buffer_size, BGAPI2_Image **image)
 Creates an image by image processor. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_CreateTransformedImage (BGAPI2_ImageProcessor *img_proc, BGAPI2_Image *image_input, const char *pixelformat, BGAPI2_Image **image_result)
 Transformes an given image using the pixelformat using the image processor. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_TransformImageToBuffer (BGAPI2_ImageProcessor *img_proc, BGAPI2_Image *image, const char *pixelformat, void *buffer, bo_uint64 buffer_size)
 Creates an new image based on given image with new pixelformat by image processor. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_GetNode (BGAPI2_ImageProcessor *img_proc, const char *name, BGAPI2_Node **node)
 Get the named node of given map of image processor. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_GetNodeTree (BGAPI2_ImageProcessor *img_proc, BGAPI2_NodeMap **node_tree)
 Get the node map of image processor as a tree. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_GetNodeList (BGAPI2_ImageProcessor *img_proc, BGAPI2_NodeMap **node_list)
 Get the node map of image processor as a list. More...
 

Detailed Description

Functions related to the Image Processor.

Typedef Documentation

◆ BGAPI2_ImageProcessor

Struct for pointers of type ImageProcessor.

Function Documentation

◆ BGAPI2_CreateImageProcessor()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_CreateImageProcessor ( BGAPI2_ImageProcessor **  img_proc)

Creates an image processor.

Parameters
[out]img_procPointer on image processor
Return values
BGAPI2_RESULT_SUCCESSNo error

◆ BGAPI2_ReleaseImageProcessor()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ReleaseImageProcessor ( BGAPI2_ImageProcessor img_proc)

Release an image processor.

Parameters
[in]img_procPointer on image processor
Return values
BGAPI2_RESULT_SUCCESSNo error

◆ BGAPI2_ImageProcessor_GetVersion()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_GetVersion ( BGAPI2_ImageProcessor img_proc,
char *  version,
bo_uint64 *  string_length 
)

Get the version string of image processor.

Parameters
[in]img_procPointer to the image processor
[in,out]versionNullptr to get string length or pointer to store result
[in,out]string_lengthResult size, length of string (including string end zero)
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_NOT_AVAILABLECould not stop event thread
BGAPI2_RESULT_INVALID_BUFFERGiven pVersion is too small
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters
Todo:
check params in,out

◆ BGAPI2_ImageProcessor_CreateEmptyImage()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_CreateEmptyImage ( BGAPI2_ImageProcessor img_proc,
BGAPI2_Image **  image 
)

Creates an empty image by image processor.

Parameters
[in]img_procPointer to the image processor
[out]imagePointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORSome internal errors
BGAPI2_RESULT_NOT_AVAILABLEImage processor parts not available, not initialized
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_ImageProcessor_CreateImage()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_CreateImage ( BGAPI2_ImageProcessor img_proc,
bo_uint  width,
bo_uint  height,
const char *  pixelformat,
void *  buffer,
bo_uint64  buffer_size,
BGAPI2_Image **  image 
)

Creates an image by image processor.

Parameters
[in]img_procPointer to the image processor
[in]widthWidth of image in pixel
[in]heightHeight of image in pixel
[in]pixelformatName of pixelformat to use in image
[in]bufferPointer to raw image data buffer
[in]buffer_size(maximum) size of raw image data buffer
[out]imagePointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORSome internal errors
BGAPI2_RESULT_NOT_AVAILABLEImage processor parts not available, not initialized
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_ImageProcessor_CreateTransformedImage()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_CreateTransformedImage ( BGAPI2_ImageProcessor img_proc,
BGAPI2_Image image_input,
const char *  pixelformat,
BGAPI2_Image **  image_result 
)

Transformes an given image using the pixelformat using the image processor.

Parameters
[in]img_procPointer to the image processor
[in]image_inputPointer to the given image
[in]pixelformatName of new pixelformat to use in image
[out]image_resultPointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_ImageProcessor_TransformImageToBuffer()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_TransformImageToBuffer ( BGAPI2_ImageProcessor img_proc,
BGAPI2_Image image,
const char *  pixelformat,
void *  buffer,
bo_uint64  buffer_size 
)

Creates an new image based on given image with new pixelformat by image processor.

Parameters
[in]img_procPointer to the image processor
[in]imagePointer to the given image
[in]pixelformatName of new pixelformat for the result buffer
[in,out]bufferDestination buffer for new image with new pixelformat
[in]buffer_sizeBuffer size for image with new pixelformat
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORError on image transformation
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_ImageProcessor_GetNode()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_GetNode ( BGAPI2_ImageProcessor img_proc,
const char *  name,
BGAPI2_Node **  node 
)

Get the named node of given map of image processor.

Parameters
[in]img_procPointer to the image processor
[in]nameNode name
[out]nodePointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_ImageProcessor_GetNodeTree()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_GetNodeTree ( BGAPI2_ImageProcessor img_proc,
BGAPI2_NodeMap **  node_tree 
)

Get the node map of image processor as a tree.

Parameters
[in]img_procPointer to the image processor
[out]node_treePointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_NOT_AVAILABLEError for missing root node
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_ImageProcessor_GetNodeList()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ImageProcessor_GetNodeList ( BGAPI2_ImageProcessor img_proc,
BGAPI2_NodeMap **  node_list 
)

Get the node map of image processor as a list.

Parameters
[in]img_procPointer to the image processor
[out]node_listNode map of image processor
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_NOT_AVAILABLEError for missing root node
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters