doc: brief mention of void storage

This commit is contained in:
Michele Caini
2023-04-13 14:02:17 +02:00
parent f1914fd946
commit 65889cca44
2 changed files with 10 additions and 1 deletions

2
TODO
View File

@@ -6,7 +6,7 @@ EXAMPLES
* support to polymorphic types (see #859)
DOC:
* storage<void> and storage<entity>
* storage<entity>
* custom storage/view
* examples (and credits) from @alanjfs :)
* update entity doc when the storage based model is in place

View File

@@ -34,6 +34,7 @@
* [Archives](#archives)
* [One example to rule them all](#one-example-to-rule-them-all)
* [Storage](#storage)
* [Void storage](#void-storage)
* [Component traits](#component-traits)
* [Empty type optimization](#empty-type-optimization)
* [Pointer stability](#pointer-stability)
@@ -1168,6 +1169,14 @@ entities are not instead.<br/>
All pools rearranges their items in order to keep the internal arrays tightly
packed and maximize performance, unless pointer stability is enabled.
## Void storage
A void storage, or `storage<void>`, is a fully functional storage type used to
create pools not associated with a particular component type.<br/>
This should be preferred to using a simple sparse set. In particular, a void
storage offers all those feature normally offered by all other storage types.
Therefore, it's a perfectly valid pool for use with views or within a registry.
## Component traits
In `EnTT`, almost everything is customizable. Pools are no exception.<br/>