atobase 3.2.0
ATOMAS atobase
Library

General (miscellaneous) library API. More...

Functions

ATO_EXPORT const char * ato_base_version (void)
 Return the version of the ATO Base API. More...
 
ATO_EXPORT bool ato_base_isinited (void)
 Returns whether or not the ato base library is initialised. More...
 
ATO_EXPORT int ato_base_init (ato_Ctx *ctx, unsigned short flag)
 Initialise the SDK - see also ato_base_deinit(). More...
 
ATO_EXPORT void ato_base_deinit (void)
 Deinitialise the SDK. More...
 

Detailed Description

General (miscellaneous) library API.

Function Documentation

◆ ato_base_version()

ATO_EXPORT const char * ato_base_version ( void  )

Return the version of the ATO Base API.

Returns
version in the form major.minor.patch.tweak (not all levels may be present)

◆ ato_base_isinited()

ATO_EXPORT bool ato_base_isinited ( void  )

Returns whether or not the ato base library is initialised.

Returns
TRUE or FALSE.

◆ ato_base_init()

ATO_EXPORT int ato_base_init ( ato_Ctx ctx,
unsigned short  flag 
)

Initialise the SDK - see also ato_base_deinit().

This must be called at application startup prior to any threads being started, and before any other initialisation routines but AFTER the first main context object is created using ato_ctx_create() AND AFTER the softwareinfo object has been set using ato_si_set().

Subsequent calls to this are ignored.

Parameters
ctxthe main context object for associated error information if any.
flagused to control the initialisation process - use ATO_BASE_INIT_ALL unless advised otherwise.
Returns
ATO_ERR_OK or an error code - see ato_ctx_err() for any error details

◆ ato_base_deinit()

ATO_EXPORT void ato_base_deinit ( void  )

Deinitialise the SDK.

This must be called at application shutdown after threads are finished and any allocated objects freed.

Subsequent calls to this are ignored.

ato_base_deinit() should be called after all other deinitialisation routines are called.