Clementine
Public Member Functions | List of all members
entt::null_t Struct Reference

Null object for all entity identifiers. More...

#include <entt.hpp>

Public Member Functions

template<typename Entity >
constexpr operator Entity () const ENTT_NOEXCEPT
 Converts the null object to identifiers of any type. More...
 
constexpr bool operator== (const null_t &) const ENTT_NOEXCEPT
 Compares two null objects. More...
 
constexpr bool operator!= (const null_t &) const ENTT_NOEXCEPT
 Compares two null objects. More...
 
template<typename Entity >
constexpr bool operator== (const Entity &entity) const ENTT_NOEXCEPT
 Compares a null object and an entity identifier of any type. More...
 
template<typename Entity >
constexpr bool operator!= (const Entity &entity) const ENTT_NOEXCEPT
 Compares a null object and an entity identifier of any type. More...
 

Detailed Description

Null object for all entity identifiers.

Member Function Documentation

◆ operator Entity()

template<typename Entity >
constexpr entt::null_t::operator Entity ( ) const
inline

Converts the null object to identifiers of any type.

Template Parameters
EntityType of entity identifier.
Returns
The null representation for the given identifier.

◆ operator!=() [1/2]

constexpr bool entt::null_t::operator!= ( const null_t ) const
inline

Compares two null objects.

Returns
False in all cases.

◆ operator!=() [2/2]

template<typename Entity >
constexpr bool entt::null_t::operator!= ( const Entity &  entity) const
inline

Compares a null object and an entity identifier of any type.

Template Parameters
EntityType of entity identifier.
Parameters
entityEntity identifier with which to compare.
Returns
True if the two elements differ, false otherwise.

◆ operator==() [1/2]

constexpr bool entt::null_t::operator== ( const null_t ) const
inline

Compares two null objects.

Returns
True in all cases.

◆ operator==() [2/2]

template<typename Entity >
constexpr bool entt::null_t::operator== ( const Entity &  entity) const
inline

Compares a null object and an entity identifier of any type.

Template Parameters
EntityType of entity identifier.
Parameters
entityEntity identifier with which to compare.
Returns
False if the two elements differ, true otherwise.

The documentation for this struct was generated from the following file: