a/math: Mention thread safety of m_relation_history

This commit is contained in:
Rylie Pavlik 2023-12-18 14:07:55 -06:00 committed by Jakob Bornecrantz
parent 94aa02ab7a
commit 93a1d58820

View file

@ -5,6 +5,7 @@
* @brief Small utility for keeping track of the history of an xrt_space_relation, ie. for knowing where a HMD or
* controller was in the past
* @author Moses Turner <moses@collabora.com>
* @author Rylie Pavlik <rylie.pavlik@collabora.com>
* @ingroup aux_util
*/
#pragma once
@ -18,6 +19,10 @@ extern "C" {
/**
* @brief Opaque type for storing the history of a space relation in a ring buffer
*
* @note Unlike the bare C++ data structure @ref HistoryBuffer this wraps, **this is a thread safe interface**,
* and is safe for concurrent access from multiple threads.
* (It is using a simple mutex, not a reader/writer lock, but that is fine until proven to be a bottleneck.)
*
* @ingroup aux_util
*/
struct m_relation_history;