BGAPI2 Image Functions

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]imagePointer to the image
[out]widthPointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_INVALID_PARAMETERError 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]imagePointer to the image
[out]heightPointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_INVALID_PARAMETERError 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]imagePointer to the image
[in,out]pixelformatNullptr to get string length or pointer to store result
[in,out]string_lengthResult size, length of version string (including string end zero)
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_INVALID_BUFFERIf given destination buffer is too small for pixelformat string
BGAPI2_RESULT_INVALID_PARAMETERError 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]imagePointer to the image
[out]bufferPointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORImage has no buffer (ppBuffer results NULL)
BGAPI2_RESULT_INVALID_PARAMETERError 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]imagePointer to the image
[in]pixelformatNew pixelformat string
[out]buffer_sizeRequired size of buffer for new pixelformat
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORIf required buffer size is NULL (*buffer_size == NULL)
BGAPI2_RESULT_INVALID_PARAMETERError 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]imagePointer to the image
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_INVALID_PARAMETERError 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]imagePointer to the image
[in]widthImage width
[in]heightImage height
[in]pixelformatImage pixelformat
[in]bufferBuffer pointer
[in]buffer_sizeSize of buffer (must match to pixelformat!)
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_ERRORIf required buffer size is NULL common init error
BGAPI2_RESULT_INVALID_PARAMETERError 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]imagePointer to the image
[in]nameNode name
[out]nodePointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_INVALID_PARAMETERError 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]imagePointer to the image
[out]node_treeNode map of image
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_NOT_AVAILABLEError for missing root node
BGAPI2_RESULT_INVALID_PARAMETERError 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]imagePointer to the image
[out]node_listNode map of image
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_NOT_AVAILABLEError for missing root node
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters