Bladeren bron

doc: added a reference to ENTT_USE_ATOMIC where it matters (close #562)

Michele Caini 5 jaren geleden
bovenliggende
commit
de7d79f1f4
1 gewijzigde bestanden met toevoegingen van 8 en 0 verwijderingen
  1. 8 0
      docs/md/entity.md

+ 8 - 0
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
 hand, they could get away with it without having to resort to particular
 expedients.
 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.<br/>
+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`.<br/>
+See the relevant documentation for more information.
+
 ## Iterators
 ## Iterators
 
 
 A special mention is needed for the iterators returned by views and groups. Most
 A special mention is needed for the iterators returned by views and groups. Most