Perception Tool Kit (PTK) API Guide
PTK External API support

Introduction

Since the PTK is expected to be platform independent, certain primitives like mutual exclusion cannot be implemented within the PTK library itself and are expected to be provided by the integrating Application. To simplify this process, the PTK library exports promitive signatures and function and the implementation needs to be provided by the Application.

Collaboration diagram for PTK External API support:

Functions

void * PTK_Drv_InsMutexCreate ()
 Creates a mutex object. More...
 
int32_t PTK_Drv_InsMutexLock (void *mutex)
 Locks a critical section. More...
 
int32_t PTK_Drv_InsMutexUnLock (void *mutex)
 Unlocks a critical section previously locked using PTK_Drv_InsMutexLock() API. More...
 
int32_t PTK_Drv_InsMutexDelete (void *)
 Deletes a mutex object. More...
 

Function Documentation

◆ PTK_Drv_InsMutexCreate()

void* PTK_Drv_InsMutexCreate ( )

Creates a mutex object.

◆ PTK_Drv_InsMutexLock()

int32_t PTK_Drv_InsMutexLock ( void *  mutex)

Locks a critical section.

◆ PTK_Drv_InsMutexUnLock()

int32_t PTK_Drv_InsMutexUnLock ( void *  mutex)

Unlocks a critical section previously locked using PTK_Drv_InsMutexLock() API.

◆ PTK_Drv_InsMutexDelete()

int32_t PTK_Drv_InsMutexDelete ( void *  )

Deletes a mutex object.