aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorJustin Berger <j.david.berger@gmail.com>2018-04-05 07:56:01 -0600
committerJustin Berger <j.david.berger@gmail.com>2018-04-05 07:56:01 -0600
commit9e1883922de980c01e60bde10c1e67261752afa6 (patch)
tree0732dbbc7817644e1f03cea7c8432284af98bd04 /include
parent4b045e61ed6f3812cbf273ae279bfd7bc1ce029c (diff)
downloadlibsurvive-9e1883922de980c01e60bde10c1e67261752afa6.tar.gz
libsurvive-9e1883922de980c01e60bde10c1e67261752afa6.tar.bz2
Fixed typo; naming suggestions
Diffstat (limited to 'include')
-rw-r--r--include/libsurvive/survive_api.h10
1 files changed, 5 insertions, 5 deletions
diff --git a/include/libsurvive/survive_api.h b/include/libsurvive/survive_api.h
index 52eca8d..fc4ce2c 100644
--- a/include/libsurvive/survive_api.h
+++ b/include/libsurvive/survive_api.h
@@ -20,7 +20,7 @@ extern "C" {
SURVIVE_EXPORT void survive_async_close(SurviveAsyncContext* actx);
/**
- * Start the background thread which processes images.
+ * Start the background thread which processes various inputs and produces deliverable data like position.
*/
SURVIVE_EXPORT void survive_async_start_thread(SurviveAsyncContext* actx);
@@ -33,14 +33,14 @@ extern "C" {
typedef struct SurviveAsyncObject SurviveAsyncObject;
/**
- * Get the first known object. Note that the first n objects are the lighthouses; for however many you are
- * configured for.
+ * Get the first known object. Note that this also includes lighthouses
*/
- SURVIVE_EXPORT const SurviveAsyncObject* survive_async_get_first_tracked(SurviveAsyncContext* actx);
+ SURVIVE_EXPORT const SurviveAsyncObject *survive_async_get_first_object(SurviveAsyncContext *actx);
/**
* Get the next known object from a current one.
*/
- SURVIVE_EXPORT const SurviveAsyncObject* survive_async_get_next_tracked(SurviveAsyncContext* actx, const SurviveAsyncObject* curr);
+ SURVIVE_EXPORT const SurviveAsyncObject *survive_async_get_next_object(SurviveAsyncContext *actx,
+ const SurviveAsyncObject *curr);
/**
* Gets the next object which has been updated since we last looked at it with this function