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
typedef struct BGAPI2_ImageProcessor 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_proc Pointer on image processor
- Return values
-
BGAPI2_RESULT_SUCCESS No error
◆ BGAPI2_ReleaseImageProcessor()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_ReleaseImageProcessor | ( | BGAPI2_ImageProcessor * | img_proc | ) |
Release an image processor.
- Parameters
-
[in] img_proc Pointer on image processor
- Return values
-
BGAPI2_RESULT_SUCCESS No 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_proc Pointer to the image processor [in,out] version Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Could not stop event thread BGAPI2_RESULT_INVALID_BUFFER Given pVersion is too small BGAPI2_RESULT_INVALID_PARAMETER Error 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_proc Pointer to the image processor [out] image Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Some internal errors BGAPI2_RESULT_NOT_AVAILABLE Image processor parts not available, not initialized BGAPI2_RESULT_INVALID_PARAMETER Error 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_proc Pointer to the image processor [in] width Width of image in pixel [in] height Height of image in pixel [in] pixelformat Name of pixelformat to use in image [in] buffer Pointer to raw image data buffer [in] buffer_size (maximum) size of raw image data buffer [out] image Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Some internal errors BGAPI2_RESULT_NOT_AVAILABLE Image processor parts not available, not initialized BGAPI2_RESULT_INVALID_PARAMETER Error 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_proc Pointer to the image processor [in] image_input Pointer to the given image [in] pixelformat Name of new pixelformat to use in image [out] image_result Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_INVALID_PARAMETER Error 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_proc Pointer to the image processor [in] image Pointer to the given image [in] pixelformat Name of new pixelformat for the result buffer [in,out] buffer Destination buffer for new image with new pixelformat [in] buffer_size Buffer size for image with new pixelformat
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Error on image transformation BGAPI2_RESULT_INVALID_PARAMETER Error 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_proc Pointer to the image processor [in] name Node name [out] node Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_INVALID_PARAMETER Error 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_proc Pointer to the image processor [out] node_tree Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Error for missing root node BGAPI2_RESULT_INVALID_PARAMETER Error 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_proc Pointer to the image processor [out] node_list Node map of image processor
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Error for missing root node BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters