From de7d79f1f47aa6266cc383aa9d2d73845713a3d1 Mon Sep 17 00:00:00 2001 From: Michele Caini Date: Fri, 2 Oct 2020 10:10:55 +0200 Subject: [PATCH] doc: added a reference to ENTT_USE_ATOMIC where it matters (close #562) --- docs/md/entity.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/md/entity.md b/docs/md/entity.md index f37ae9be6..66738e2b8 100644 --- a/docs/md/entity.md +++ b/docs/md/entity.md @@ -1811,6 +1811,14 @@ are completely responsible for synchronization whether required. On the other hand, they could get away with it without having to resort to particular expedients. +Finally, `EnTT` can be configured via a few compile-time definitions to make +some of its parts implicitly thread-safe, roughly speaking only the ones that +really make sense and can't be turned around.
+In particular, when multiple instances of objects referencing the type index +generator (such as the `registry` class) are used in different threads, then it +might be useful to define `ENTT_USE_ATOMIC`.
+See the relevant documentation for more information. + ## Iterators A special mention is needed for the iterators returned by views and groups. Most