Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

entity: update doc

Browse Source
This commit is contained in:
Michele Caini
2023-09-05 09:58:52 +02:00
parent d79d08ef11
commit be09b3a40a
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/entt/entity/entity.hpp
View File

@@ -170,8 +170,10 @@ struct entt_traits: basic_entt_traits<internal::entt_traits<Type>> {
};
/**
* @copydoc entt_traits<Entity>::to_integral
* @brief Converts an entity to its underlying type.
* @tparam Entity The value type.
* @param value The value to convert.
* @return The integral representation of the given value.
*/
template<typename Entity>
[[nodiscard]] constexpr typename entt_traits<Entity>::entity_type to_integral(const Entity value) noexcept {
@@ -179,8 +181,10 @@ template<typename Entity>
}
/**
* @copydoc entt_traits<Entity>::to_entity
* @brief Returns the entity part once converted to the underlying type.
* @tparam Entity The value type.
* @param value The value to convert.
* @return The integral representation of the entity part.
*/
template<typename Entity>
[[nodiscard]] constexpr typename entt_traits<Entity>::entity_type to_entity(const Entity value) noexcept {
@@ -188,8 +192,10 @@ template<typename Entity>
}
/**
* @copydoc entt_traits<Entity>::to_version
* @brief Returns the version part once converted to the underlying type.
* @tparam Entity The value type.
* @param value The value to convert.
* @return The integral representation of the version part.
*/
template<typename Entity>
[[nodiscard]] constexpr typename entt_traits<Entity>::version_type to_version(const Entity value) noexcept {