浏览代码

doc: config.md

skypjack 2 月之前
父节点
当前提交
66f42d358a
共有 2 个文件被更改,包括 16 次插入2 次删除
  1. 0 2
      TODO
  2. 16 0
      docs/md/config.md

+ 0 - 2
TODO

@@ -34,5 +34,3 @@ TODO:
 * organizer: view/storage only based model, no registry
 * refine tests: add prefixes (i.e. signal_delegate) or scope into their dirs
 * introduce a way to inject stl from outside too
-* doc: internal stl stuff
-* doc: config.md is outdated

+ 16 - 0
docs/md/config.md

@@ -4,6 +4,7 @@
 
 * [Introduction](#introduction)
 * [Definitions](#definitions)
+  * [ENTT_USE_STL](#entt_use_stl) 
   * [ENTT_NO_EXCEPTION](#entt_no_exception)
   * [ENTT_USE_ATOMIC](#entt_use_atomic)
   * [ENTT_ID_TYPE](#entt_id_type)
@@ -13,6 +14,7 @@
     * [ENTT_ASSERT_CONSTEXPR](#entt_assert_constexpr)
     * [ENTT_DISABLE_ASSERT](#entt_disable_assert)
   * [ENTT_NO_ETO](#entt_no_eto)
+  * [ENTT_NO_MIXIN](#entt_no_mixin)
   * [ENTT_STANDARD_CPP](#entt_standard_cpp)
 
 # Introduction
@@ -33,6 +35,13 @@ Each parameter can result in internal library definitions. It is not recommended
 to try to also modify these definitions, since there is no guarantee that they
 will remain stable over time unlike the options below.
 
+## ENTT_USE_STL
+
+Intended for testing purposes, it forces the use of built-in replacements of
+some parts of the standard library that aren't always available otherwise.<br/>
+`EnTT` _detects_ these cases on its own, and users should never define this
+variable explicitly. However, it's still possible if desired.
+
 ## ENTT_NO_EXCEPTION
 
 Define this variable without assigning any value to it to turn off exception
@@ -106,6 +115,13 @@ never instantiated nor stored by the ECS module of `EnTT`.<br/>
 Use this variable to treat these types like all others and therefore to create a
 dedicated storage for them.
 
+## ENTT_NO_MIXIN
+
+`EnTT` automatically assigns mixins to all storage types to support signaling
+when creating, destroying, and modifying elements.<br/>
+Mixins can have a (most likely negligible) cost in terms of performance and
+compilation time. If unwanted, this macro suppresses automatic generation.
+
 ## ENTT_STANDARD_CPP
 
 `EnTT` mixes non-standard language features with others that are perfectly