Functions related to the GenICam Buffer. More...
Typedefs | |
typedef struct BGAPI2_Buffer | BGAPI2_Buffer |
Struct for pointers of type Buffer. More... | |
typedef void(BGAPI2CALL * | BGAPI2_NewBufferEventHandler) (void *callBackOwner, BGAPI2_Buffer *pBuffer) |
Declaration for callback functions for BGAPI2_NewBufferEventHandler. More... | |
Functions | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_CreateBuffer (BGAPI2_Buffer **buffer) |
Creates a new buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_CreateBufferWithUserPtr (BGAPI2_Buffer **buffer, void *user_obj) |
Returns a new buffer, initialized with user parameter. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_CreateBufferWithExternalMemory (BGAPI2_Buffer **buffer, void *user_buffer, bo_uint64 user_buffer_size, void *user_obj) |
Returns a new buffer, initialized with user parameter and external memory. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_DeleteBuffer (BGAPI2_Buffer *buffer, void **user_obj) |
Destroys the buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetNode (BGAPI2_Buffer *buffer, char *name, BGAPI2_Node **node) |
Gets a node of the buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetNodeTree (BGAPI2_Buffer *buffer, BGAPI2_NodeMap **node_tree) |
Gets the node tree of the buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetNodeList (BGAPI2_Buffer *buffer, BGAPI2_NodeMap **node_list) |
Gets the node list of the buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetChunkNodeList (BGAPI2_Buffer *buffer, BGAPI2_NodeMap **node_list) |
Gets the chunk node list of given buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetID (BGAPI2_Buffer *buffer, char *ID, bo_uint64 *string_length) |
Returns the identifier of the buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetMemPtr (BGAPI2_Buffer *buffer, void **mem_ptr) |
Returns the memory (data) pointer of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetMemSize (BGAPI2_Buffer *buffer, bo_uint64 *buffer_size) |
Returns the memory size of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetUserPtr (BGAPI2_Buffer *buffer, void **user) |
Returns the user pointer of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetTimestamp (BGAPI2_Buffer *buffer, bo_uint64 *timestamp) |
Delivers the timestamp of the buffer obtained by the camera. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetHostTimestamp (BGAPI2_Buffer *buffer, bo_uint64 *host_timestamp) |
Returns the host time stamp of the first received packet of a new image using a steady clock. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetNewData (BGAPI2_Buffer *buffer, bo_bool *new_data) |
Returns the flag for new data of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetIsQueued (BGAPI2_Buffer *buffer, bo_bool *is_queued) |
Returns the flag for queued buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetIsAcquiring (BGAPI2_Buffer *buffer, bo_bool *is_acquiring) |
Returns the flag for acquiring data of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetIsIncomplete (BGAPI2_Buffer *buffer, bo_bool *is_incomplete) |
Returns the flag for incomplete data of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetTLType (BGAPI2_Buffer *buffer, char *tl_type, bo_uint64 *string_length) |
Returns the transport layer of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetSizeFilled (BGAPI2_Buffer *buffer, bo_uint64 *size_filled) |
Returns the current size of data of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetWidth (BGAPI2_Buffer *buffer, bo_uint64 *width) |
Returns the width (in pixel) of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetHeight (BGAPI2_Buffer *buffer, bo_uint64 *height) |
Returns height (in pixel) of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetXOffset (BGAPI2_Buffer *buffer, bo_uint64 *offset_x) |
Returns x offset (in pixel) of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetYOffset (BGAPI2_Buffer *buffer, bo_uint64 *offset_y) |
Returns y offset (in pixel) of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetXPadding (BGAPI2_Buffer *buffer, bo_uint64 *padding_x) |
Returns x padding bytes (number of extra bytes in each line) of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetYPadding (BGAPI2_Buffer *buffer, bo_uint64 *padding_y) |
Returns y padding bytes (number of extra bytes at image end) of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetFrameID (BGAPI2_Buffer *buffer, bo_uint64 *frame_id) |
Returns the frame identifier of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetImagePresent (BGAPI2_Buffer *buffer, bo_bool *image_present) |
Returns the flag for available image of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetImageOffset (BGAPI2_Buffer *buffer, bo_uint64 *image_offset) |
Returns the offset into buffer memory to begin of data of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetPayloadType (BGAPI2_Buffer *buffer, char *payload_type, bo_uint64 *string_length) |
Returns the payload type of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetPixelFormat (BGAPI2_Buffer *buffer, char *pixelformat, bo_uint64 *string_length) |
Returns the payload type of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetDeliveredImageHeight (BGAPI2_Buffer *buffer, bo_uint64 *delivered_image_height) |
Returns the delivered image height of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetDeliveredChunkPayloadSize (BGAPI2_Buffer *buffer, bo_uint64 *delivered_chunk_payload_size) |
Returns the delivered chunk payload size of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetContainsChunk (BGAPI2_Buffer *buffer, bo_bool *contains_chunk) |
Returns the flag to indicating existing chunk of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetChunkLayoutID (BGAPI2_Buffer *buffer, bo_uint64 *chunk_layout_id) |
Returns the chunk layout identifier size of buffer. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetFileName (BGAPI2_Buffer *buffer, char *file_name, bo_uint64 *string_length) |
Returns the filename of buffer (only for payload type = file) More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Buffer_GetParent (BGAPI2_Buffer *buffer, BGAPI2_DataStream **parent) |
Returns the parent object (data stream) which belongs to. More... | |
Detailed Description
Functions related to the GenICam Buffer.
Typedef Documentation
◆ BGAPI2_Buffer
typedef struct BGAPI2_Buffer BGAPI2_Buffer |
Struct for pointers of type Buffer.
◆ BGAPI2_NewBufferEventHandler
typedef void(BGAPI2CALL * BGAPI2_NewBufferEventHandler) (void *callBackOwner, BGAPI2_Buffer *pBuffer) |
Declaration for callback functions for BGAPI2_NewBufferEventHandler.
Function Documentation
◆ BGAPI2_CreateBuffer()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_CreateBuffer | ( | BGAPI2_Buffer ** | buffer | ) |
Creates a new buffer.
- Parameters
-
[out] buffer Pointer to store new buffer object
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_CreateBufferWithUserPtr()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_CreateBufferWithUserPtr | ( | BGAPI2_Buffer ** | buffer, |
void * | user_obj | ||
) |
Returns a new buffer, initialized with user parameter.
- Parameters
-
[out] buffer Variable for new buffer object [in] user_obj Additional user parameter to store in buffer
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_CreateBufferWithExternalMemory()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_CreateBufferWithExternalMemory | ( | BGAPI2_Buffer ** | buffer, |
void * | user_buffer, | ||
bo_uint64 | user_buffer_size, | ||
void * | user_obj | ||
) |
Returns a new buffer, initialized with user parameter and external memory.
Function to create a Buffer-Object. When using this function, the user takes care of allocation of the necessary memory. To use the actual necessary memory size the functions Device::GetPayloadSize and DataStream::GetPayloadSize are used respectively. To use the maximum required memory size of a device the maximum of the PayloadSize feature is queried. See Device::GetRemoteNode and Node::GetIntMax.
- Parameters
-
[out] buffer Variable for new buffer object [in] user_buffer Pointer to a user allocated data buffer. [in] user_buffer_size The size of the user allocated data buffer [in] user_obj Pointer to a user allocated memory
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_DeleteBuffer()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DeleteBuffer | ( | BGAPI2_Buffer * | buffer, |
void ** | user_obj | ||
) |
Destroys the buffer.
- Parameters
-
[in] buffer The buffer object [in] user_obj Pointer to a user allocated memory
- Return values
-
BGAPI2_RESULT_SUCCESS No error
◆ BGAPI2_Buffer_GetNode()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetNode | ( | BGAPI2_Buffer * | buffer, |
char * | name, | ||
BGAPI2_Node ** | node | ||
) |
Gets a node of the buffer.
- Parameters
-
[in] buffer Pointer to the buffer [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_Buffer_GetNodeTree()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetNodeTree | ( | BGAPI2_Buffer * | buffer, |
BGAPI2_NodeMap ** | node_tree | ||
) |
Gets the node tree of the buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] node_tree Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Error for missing root node BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetNodeList()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetNodeList | ( | BGAPI2_Buffer * | buffer, |
BGAPI2_NodeMap ** | node_list | ||
) |
Gets the node list of the buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] node_list Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Error for missing root node BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetChunkNodeList()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetChunkNodeList | ( | BGAPI2_Buffer * | buffer, |
BGAPI2_NodeMap ** | node_list | ||
) |
Gets the chunk node list of given buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] node_list Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_NOT_INITIALIZED Error, chunk is not initialized BGAPI2_RESULT_ERROR Error for invalid buffer BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetID()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetID | ( | BGAPI2_Buffer * | buffer, |
char * | ID, | ||
bo_uint64 * | string_length | ||
) |
Returns the identifier of the buffer.
- Parameters
-
[in] buffer Pointer to the buffer [in,out] ID 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_ERROR Internal error (init failed) BGAPI2_RESULT_NOT_INITIALIZED Producer not initialized BGAPI2_RESULT_LOWLEVEL_ERROR Can't read producer device infos BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetMemPtr()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetMemPtr | ( | BGAPI2_Buffer * | buffer, |
void ** | mem_ptr | ||
) |
Returns the memory (data) pointer of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] mem_ptr Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetMemSize()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetMemSize | ( | BGAPI2_Buffer * | buffer, |
bo_uint64 * | buffer_size | ||
) |
Returns the memory size of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] buffer_size Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetUserPtr()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetUserPtr | ( | BGAPI2_Buffer * | buffer, |
void ** | user | ||
) |
Returns the user pointer of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] user Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetTimestamp()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetTimestamp | ( | BGAPI2_Buffer * | buffer, |
bo_uint64 * | timestamp | ||
) |
Delivers the timestamp of the buffer obtained by the camera.
- Parameters
-
[in] buffer Pointer to the buffer [out] timestamp Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetHostTimestamp()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetHostTimestamp | ( | BGAPI2_Buffer * | buffer, |
bo_uint64 * | host_timestamp | ||
) |
Returns the host time stamp of the first received packet of a new image using a steady clock.
- Parameters
-
[in] buffer Pointer to the buffer [out] host_timestamp Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetNewData()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetNewData | ( | BGAPI2_Buffer * | buffer, |
bo_bool * | new_data | ||
) |
Returns the flag for new data of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] new_data Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetIsQueued()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetIsQueued | ( | BGAPI2_Buffer * | buffer, |
bo_bool * | is_queued | ||
) |
Returns the flag for queued buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] is_queued Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetIsAcquiring()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetIsAcquiring | ( | BGAPI2_Buffer * | buffer, |
bo_bool * | is_acquiring | ||
) |
Returns the flag for acquiring data of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] is_acquiring Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetIsIncomplete()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetIsIncomplete | ( | BGAPI2_Buffer * | buffer, |
bo_bool * | is_incomplete | ||
) |
Returns the flag for incomplete data of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] is_incomplete Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetTLType()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetTLType | ( | BGAPI2_Buffer * | buffer, |
char * | tl_type, | ||
bo_uint64 * | string_length | ||
) |
Returns the transport layer of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [in,out] tl_type 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_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetSizeFilled()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetSizeFilled | ( | BGAPI2_Buffer * | buffer, |
bo_uint64 * | size_filled | ||
) |
Returns the current size of data of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] size_filled Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetWidth()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetWidth | ( | BGAPI2_Buffer * | buffer, |
bo_uint64 * | width | ||
) |
Returns the width (in pixel) of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] width Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetHeight()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetHeight | ( | BGAPI2_Buffer * | buffer, |
bo_uint64 * | height | ||
) |
Returns height (in pixel) of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] height Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetXOffset()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetXOffset | ( | BGAPI2_Buffer * | buffer, |
bo_uint64 * | offset_x | ||
) |
Returns x offset (in pixel) of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] offset_x Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetYOffset()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetYOffset | ( | BGAPI2_Buffer * | buffer, |
bo_uint64 * | offset_y | ||
) |
Returns y offset (in pixel) of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] offset_y Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetXPadding()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetXPadding | ( | BGAPI2_Buffer * | buffer, |
bo_uint64 * | padding_x | ||
) |
Returns x padding bytes (number of extra bytes in each line) of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] padding_x Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetYPadding()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetYPadding | ( | BGAPI2_Buffer * | buffer, |
bo_uint64 * | padding_y | ||
) |
Returns y padding bytes (number of extra bytes at image end) of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] padding_y Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetFrameID()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetFrameID | ( | BGAPI2_Buffer * | buffer, |
bo_uint64 * | frame_id | ||
) |
Returns the frame identifier of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] frame_id Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetImagePresent()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetImagePresent | ( | BGAPI2_Buffer * | buffer, |
bo_bool * | image_present | ||
) |
Returns the flag for available image of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] image_present Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetImageOffset()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetImageOffset | ( | BGAPI2_Buffer * | buffer, |
bo_uint64 * | image_offset | ||
) |
Returns the offset into buffer memory to begin of data of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] image_offset Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetPayloadType()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetPayloadType | ( | BGAPI2_Buffer * | buffer, |
char * | payload_type, | ||
bo_uint64 * | string_length | ||
) |
Returns the payload type of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [in,out] payload_type 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_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetPixelFormat()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetPixelFormat | ( | BGAPI2_Buffer * | buffer, |
char * | pixelformat, | ||
bo_uint64 * | string_length | ||
) |
Returns the payload type of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [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_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetDeliveredImageHeight()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetDeliveredImageHeight | ( | BGAPI2_Buffer * | buffer, |
bo_uint64 * | delivered_image_height | ||
) |
Returns the delivered image height of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] delivered_image_height Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetDeliveredChunkPayloadSize()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetDeliveredChunkPayloadSize | ( | BGAPI2_Buffer * | buffer, |
bo_uint64 * | delivered_chunk_payload_size | ||
) |
Returns the delivered chunk payload size of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] delivered_chunk_payload_size Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetContainsChunk()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetContainsChunk | ( | BGAPI2_Buffer * | buffer, |
bo_bool * | contains_chunk | ||
) |
Returns the flag to indicating existing chunk of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] contains_chunk Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetChunkLayoutID()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetChunkLayoutID | ( | BGAPI2_Buffer * | buffer, |
bo_uint64 * | chunk_layout_id | ||
) |
Returns the chunk layout identifier size of buffer.
- Parameters
-
[in] buffer Pointer to the buffer [out] chunk_layout_id Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetFileName()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetFileName | ( | BGAPI2_Buffer * | buffer, |
char * | file_name, | ||
bo_uint64 * | string_length | ||
) |
Returns the filename of buffer (only for payload type = file)
- Parameters
-
[in] buffer Pointer to the buffer [in,out] file_name 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_NOT_AVAILABLE Internal error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Buffer_GetParent()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Buffer_GetParent | ( | BGAPI2_Buffer * | buffer, |
BGAPI2_DataStream ** | parent | ||
) |
Returns the parent object (data stream) which belongs to.
- Parameters
-
[in] buffer Pointer to the buffer [out] parent Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE In case the buffer was revoked from the data stream BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters