mirror/magic_enum
1
0
Fork 0
mirror of https://github.com/Neargye/magic_enum.git synced 2026-01-10 23:44:29 +00:00
Code Activity

update readme

Browse source
This commit is contained in:
neargye 2019-04-09 14:36:21 +05:00
parent 0d4dad3ab3
commit 866b957213
1 changed files with 10 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -177,7 +177,16 @@ enum Color { RED = 2, BLUE = 4, GREEN = 8 };
* `magic_enum::enum_names` returns `std::array<std::string_view, N>` with all string enum name where `N = number of enum values`, sorted by enum value.
* Enum value must be in range `[-256, 256]`. If you need another range, add specialization enum_range for necessary enum type.
* Enum value must be in range `[MAGIC_ENUM_RANGE_MIN, MAGIC_ENUM_RANGE_MAX]`. By default `MAGIC_ENUM_RANGE_MAX = 128`, `MAGIC_ENUM_RANGE_MIN = -128`.
If need another range for all enum types by default, redefine the macro `MAGIC_ENUM_RANGE_MAX` and `MAGIC_ENUM_RANGE_MIN`.
```cpp
#define MAGIC_ENUM_RANGE_MAX 256
#define MAGIC_ENUM_RANGE_MIN 0
#include <magic_enum.hpp>
```
If need another range for specific enum type, add specialization `enum_range` for necessary enum type.
```cpp
#include <magic_enum.hpp>