Functions related to the BGAPI2 Images. More...
Typedefs | |
typedef struct BGAPI2_Image | BGAPI2_Image |
Struct for pointers of type Image. More... | |
Functions | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Image_GetWidth (BGAPI2_Image *image, bo_uint *width) |
Get the image width from given image. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Image_GetHeight (BGAPI2_Image *image, bo_uint *height) |
Get the image height from given image. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Image_GetPixelformat (BGAPI2_Image *image, char *pixelformat, bo_uint64 *string_length) |
Get the image pixelformat from given image. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Image_GetBuffer (BGAPI2_Image *image, void **buffer) |
Get the image pixel buffer from given image. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Image_GetTransformBufferLength (BGAPI2_Image *image, const char *pixelformat, bo_uint *buffer_size) |
Get the required image buffer size for new pixelformat of given image. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Image_Release (BGAPI2_Image *image) |
Release (delete) a given image. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Image_Init (BGAPI2_Image *image, bo_uint width, bo_uint height, const char *pixelformat, void *buffer, bo_uint64 buffer_size) |
Initialize a given image with parameters. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Image_GetNode (BGAPI2_Image *image, const char *name, BGAPI2_Node **node) |
Get the named node of given map of image. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Image_GetNodeTree (BGAPI2_Image *image, BGAPI2_NodeMap **node_tree) |
Get the node tree of the image. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Image_GetNodeList (BGAPI2_Image *image, BGAPI2_NodeMap **node_list) |
Get the node list of the image. More... | |
Detailed Description
Functions related to the BGAPI2 Images.
Typedef Documentation
◆ BGAPI2_Image
typedef struct BGAPI2_Image BGAPI2_Image |
Struct for pointers of type Image.
Function Documentation
◆ BGAPI2_Image_GetWidth()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_GetWidth | ( | BGAPI2_Image * | image, |
bo_uint * | width | ||
) |
Get the image width from given image.
- Parameters
-
[in] image Pointer to the image [out] width Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Image_GetHeight()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_GetHeight | ( | BGAPI2_Image * | image, |
bo_uint * | height | ||
) |
Get the image height from given image.
- Parameters
-
[in] image Pointer to the image [out] height Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Image_GetPixelformat()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_GetPixelformat | ( | BGAPI2_Image * | image, |
char * | pixelformat, | ||
bo_uint64 * | string_length | ||
) |
Get the image pixelformat from given image.
- Parameters
-
[in] image Pointer to the image [in,out] pixelformat Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_INVALID_BUFFER If given destination buffer is too small for pixelformat string BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Image_GetBuffer()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_GetBuffer | ( | BGAPI2_Image * | image, |
void ** | buffer | ||
) |
Get the image pixel buffer from given image.
- Parameters
-
[in] image Pointer to the image [out] buffer Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Image has no buffer (ppBuffer results NULL) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Image_GetTransformBufferLength()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_GetTransformBufferLength | ( | BGAPI2_Image * | image, |
const char * | pixelformat, | ||
bo_uint * | buffer_size | ||
) |
Get the required image buffer size for new pixelformat of given image.
- Parameters
-
[in] image Pointer to the image [in] pixelformat New pixelformat string [out] buffer_size Required size of buffer for new pixelformat
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR If required buffer size is NULL (*buffer_size == NULL) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Image_Release()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_Release | ( | BGAPI2_Image * | image | ) |
Release (delete) a given image.
- Parameters
-
[in] image Pointer to the image
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Image_Init()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_Init | ( | BGAPI2_Image * | image, |
bo_uint | width, | ||
bo_uint | height, | ||
const char * | pixelformat, | ||
void * | buffer, | ||
bo_uint64 | buffer_size | ||
) |
Initialize a given image with parameters.
- Parameters
-
[in] image Pointer to the image [in] width Image width [in] height Image height [in] pixelformat Image pixelformat [in] buffer Buffer pointer [in] buffer_size Size of buffer (must match to pixelformat!)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR If required buffer size is NULL common init error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Image_GetNode()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_GetNode | ( | BGAPI2_Image * | image, |
const char * | name, | ||
BGAPI2_Node ** | node | ||
) |
Get the named node of given map of image.
- Parameters
-
[in] image Pointer to the image [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_Image_GetNodeTree()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_GetNodeTree | ( | BGAPI2_Image * | image, |
BGAPI2_NodeMap ** | node_tree | ||
) |
Get the node tree of the image.
- Parameters
-
[in] image Pointer to the image [out] node_tree Node map of image
- 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_Image_GetNodeList()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Image_GetNodeList | ( | BGAPI2_Image * | image, |
BGAPI2_NodeMap ** | node_list | ||
) |
Get the node list of the image.
- Parameters
-
[in] image Pointer to the image [out] node_list Node map of image
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Error for missing root node BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters