Namespace entt

Description

No description yet.

Namespaces

internal

Classes

as_groupConverts a registry to a group.
as_is_tEmpty class type used to request the as-is policy.
as_ref_tEmpty class type used to request the as ref policy.
as_viewConverts a registry to a view.
as_void_tEmpty class type used to request the as void policy.
basic_actor
basic_collectorCollector.
basic_collector< matcher< type_list< Reject... >, type_list< Require... >, Rule... >, Other... >Collector.
basic_collector<>Collector.
basic_continuous_loaderUtility class for continuous loading.
basic_groupGroup.
basic_group< Entity, exclude_t< Exclude... >, get_t< Get... > >Non-owning group.
basic_group< Entity, exclude_t< Exclude... >, get_t< Get... >, Owned... >Owning group.
basic_handleNon-owning handle to an entity.
basic_hashed_stringZero overhead unique identifier.
basic_observerObserver.
basic_organizerUtility class for creating a static task graph.
basic_registryFast and reliable entity-component system.
basic_runtime_viewRuntime view.
basic_snapshotUtility class to create snapshots from a registry.
basic_snapshot_loaderUtility class to restore a snapshot as a whole.
basic_sparse_setBasic sparse set implementation.
basic_storageBasic storage implementation.
basic_storage< Entity, Type, std::enable_if_t< is_eto_eligible_v< Type > > >Basic storage implementation.
basic_viewView.
basic_view< Entity, exclude_t< Exclude... >, Component... >Multi component view.
basic_view< Entity, exclude_t<>, Component >Single component view specialization.
choice_tUtility class to disambiguate overloaded functions.
choice_t< 0 >Utility class to disambiguate overloaded functions.
connect_arg_tUsed to wrap a function or a member of a specified type.
connectionConnection class.
delegateBasic delegate implementation.
delegate< Ret(Args...)>Utility class to use to send around functions and members.
dispatcherBasic dispatcher implementation.
emitterGeneral purpose event emitter.
entt_traitsEntity traits.
entt_traits< std::uint32_t >Entity traits for a 32 bits entity identifier.
entt_traits< std::uint64_t >Entity traits for a 64 bits entity identifier.
entt_traits< Type, std::enable_if_t< std::is_enum_v< Type > > >Entity traits for enumeration types.
exclude_tAlias for exclusion lists.
familyDynamic identifier generator.
get_tAlias for lists of observed components.
has_meta_associative_container_traitsProvides the member constant value to true if support for meta associative containers is enabled for the given type, false otherwise.
has_meta_associative_container_traits< Type, std::void_t< typename meta_associative_container_traits< Type >::key_type > >Provides the member constant value to true if support for meta associative containers is enabled for the given type, false otherwise.
has_meta_sequence_container_traitsProvides the member constant value to true if support for meta sequence containers is enabled for the given type, false otherwise.
has_meta_sequence_container_traits< Type, std::void_t< typename meta_sequence_container_traits< Type >::value_type > >Provides the member constant value to true if support for meta sequence containers is enabled for the given type, false otherwise.
identifierTypes identifiers.
identityIdentity function object (waiting for C++20).
insertion_sortFunction object for performing insertion sort.
is_applicableSame as std::is_invocable, but with tuples.
is_applicable< Func, std::tuple< Args... > >Same as std::is_invocable, but with tuples.
is_applicable_rSame as std::is_invocable_r, but with tuples for arguments.
is_applicable_r< Ret, Func, std::tuple< Args... > >Same as std::is_invocable_r, but with tuples for arguments.
is_equality_comparableProvides the member constant value to true if a given type is equality comparable, false otherwise.
is_equality_comparable< Type, std::void_t< decltype(std::declval< Type >()==std::declval< Type >())> >Provides the member constant value to true if a given type is equality comparable, false otherwise.
is_eto_eligibleProvides the member constant value to true if a given type is empty and the empty type optimization is enabled, false otherwise.
is_key_only_meta_associative_containerProvides the member constant value to true if a meta associative container claims to wrap a key-only type, false otherwise.
is_key_only_meta_associative_container< Type, std::void_t< typename meta_associative_container_traits< Type >::mapped_type > >Provides the member constant value to true if a meta associative container claims to wrap a key-only type, false otherwise.
is_meta_pointer_likeProvides the member constant value to true if a given type is a pointer-like type from the point of view of the meta system, false otherwise.
is_meta_pointer_like< std::shared_ptr< Type > >Makes std::shared_ptrs of any type pointer-like types for the meta system.
is_meta_pointer_like< std::unique_ptr< Type, Args... > >Makes std::unique_ptrs of any type pointer-like types for the meta system.
is_meta_pointer_like< Type * >Makes plain pointers pointer-like types for the meta system.
matcherGrouping matcher.
member_classExtracts the class of a non-static member object or function.
meta_anyOpaque wrapper for values of any type.
meta_associative_containerProxy object for associative containers.
meta_associative_container_traitsTraits class template to be specialized to enable support for meta associative containers.
meta_associative_container_traits< std::map< Key, Value, Args... > >Meta associative container traits for std::maps of any type.
meta_associative_container_traits< std::set< Key, Args... > >Meta associative container traits for std::sets of any type.
meta_associative_container_traits< std::unordered_map< Key, Value, Args... > >Meta associative container traits for std::unordered_maps of any type.
meta_associative_container_traits< std::unordered_set< Key, Args... > >Meta associative container traits for std::unordered_sets of any type.
meta_baseOpaque wrapper for meta base classes.
meta_convOpaque wrapper for meta conversion functions.
meta_ctorOpaque wrapper for meta constructors.
meta_ctxOpaque container for a meta context.
meta_dataOpaque wrapper for meta data.
meta_factoryMeta factory to be used for reflection purposes.
meta_factory< Type >Basic meta factory to be used for reflection purposes.
meta_factory< Type, Spec... >Extended meta factory to be used for reflection purposes.
meta_funcOpaque wrapper for meta functions.
meta_handleOpaque pointers to instances of any type.
meta_propOpaque wrapper for meta properties of any type.
meta_rangeIterable range to use to iterate all types of meta objects.
meta_sequence_containerProxy object for sequence containers.
meta_sequence_container_traitsTraits class template to be specialized to enable support for meta sequence containers.
meta_sequence_container_traits< std::array< Type, N > >Meta sequence container traits for std::arrays of any type.
meta_sequence_container_traits< std::vector< Type, Args... > >Meta sequence container traits for std::vectors of any type.
meta_typeOpaque wrapper for meta types.
monostateMinimal implementation of the monostate pattern.
null_tNull object for all entity identifiers.
overloadedHelper type for visitors.
poolApplies component-to-pool conversion and defines the resulting type as the member typedef type.
pool< Entity, const Type >Applies component-to-pool conversion and defines the resulting type as the member typedef type.
processBase class for processes.
process_adaptorAdaptor for lambdas and functors to turn them into processes.
radix_sortFunction object for performing LSD radix sort.
resource_cacheSimple cache for resources of a given type.
resource_handleShared resource handle.
resource_loaderBase class for resource loaders.
schedulerCooperative scheduler for processes.
scoped_connectionScoped connection class.
service_locatorService locator, nothing more.
sighUnmanaged signal handler.
sigh< Ret(Args...)>Unmanaged signal handler.
sigh_pool_mixinMixin type to use to add signal support to pools.
sinkSink class.
sink< Ret(Args...)>Sink class.
size_ofA type-only sizeof wrapper that returns 0 where sizeof complains.
size_of< Type, std::void_t< decltype(sizeof(Type))> >A type-only sizeof wrapper that returns 0 where sizeof complains.
std_sortFunction object to wrap std::sort in a class type.
storage_adapterDefault pool implementation.
type_hashType hash.
type_infoImplementation specific information about a type.
type_listA class to use to push around lists of types, nothing more.
type_list_catPrimary template isn't defined on purpose.
type_list_cat< type_list< Type... > >Concatenates multiple type lists.
type_list_cat< type_list< Type... >, type_list< Other... >, List... >Concatenates multiple type lists.
type_list_cat<>Concatenates multiple type lists.
type_list_containsProvides the member constant value to true if a type list contains a given type, false otherwise.
type_list_contains< type_list< Type... >, Other >Provides the member constant value to true if a type list contains a given type, false otherwise.
type_list_uniquePrimary template isn't defined on purpose.
type_list_unique< type_list< Type, Other... > >Removes duplicates types from a type list.
type_list_unique< type_list<> >Removes duplicates types from a type list.
type_nameType name.
type_seqType sequential identifier.
view_packView pack.
y_combinatorBasic implementation of a y-combinator.

Functions

invokeHelper to create a listener that directly invokes a member function.
metaUtility function to use for reflection.
operator!=Compares two hashed strings.
operator+Concatenates multiple type lists.
operator==Compares a null object and an entity identifier of any type.
operator|Combines two views in a pack.
overloadConstant utility to disambiguate overloaded members of a class.
resolveReturns the meta type associated with a given type.
to_entityReturns the entity associated with a given component.
to_integralConverts an entity type to its underlying type.
type_idReturns the type info object for a given type.

Enums

entityDefault entity identifier.

Typedefs

using id_type = std::uint32_t

Alias declaration for type identifiers.

Mentioned in:

Configuration / ENTT_ID_TYPE

Core Functionalities / Type info

Core Functionalities / Type index

Core Functionalities / Tag

Entity Component System / Cloning a registry

Entity Component System / Stamping an entity

Entity Component System / Runtime views

Resource Management / The resource, the loader and the cache

using hashed_string = basic_hashed_string< char >

Aliases for common character types.

Mentioned in:

Configuration / ENTT_HS_SUFFIX and ENTT_HWS_SUFFIX

Core Functionalities / Hashed strings

Core Functionalities / Wide characters

Core Functionalities / Monostate

Resource Management / The resource, the loader and the cache

Runtime Reflection System / Names and identifiers

Runtime Reflection System / Properties and meta objects

Frequently Asked Questions / Warning C4307: integral constant overflow

using hashed_wstring = basic_hashed_string< wchar_t >

Aliases for common character types.

Mentioned in:

Core Functionalities / Wide characters

template <typename Type, typename>
using unpack_as_t = Type

Using declaration to be used to repeat the same type a number of times equal to the size of a given parameter pack.

Template Parameters:

Type - A type to repeat.

template <auto Value>
using integral_constant = std::integral_constant< decltype(Value), Value >

Wraps a static constant.

Template Parameters:

Value - A static constant.

Mentioned in:

Core Functionalities / Integral constant

template <id_type Value>
using tag = integral_constant< Value >

Alias template to ease the creation of named values.

Template Parameters:

Value - A constant value at least convertible to id_type.

Mentioned in:

Core Functionalities / Tag

template <typename... List>
using type_list_cat_t = typename type_list_cat< List... >::type

Helper type.

Template Parameters:

List - Type lists to concatenate.

template <typename Type>
using type_list_unique_t = typename type_list_unique< Type >::type

Helper type.

Template Parameters:

Type - A type list.

template <typename Member>
using member_class_t = typename member_class< Member >::type

Helper type.

Template Parameters:

Member - A pointer to a non-static member object or function.

Mentioned in:

Core Functionalities / Member class type

using sparse_set = basic_sparse_set< entity >

Alias declaration for the most common use case.

template <typename... Args>
using storage = basic_storage< entity, Args... >

Alias declaration for the most common use case.

Template Parameters:

Args - Other template parameters.

using registry = basic_registry< entity >

Alias declaration for the most common use case.

Mentioned in:

Getting Started / Code Example

Entity Component System / A bitset-free entity-component system

Entity Component System / The Registry, the Entity and the Component

Entity Component System / Observe changes

Entity Component System / Cloning a registry

Entity Component System / Stamping an entity

using observer = basic_observer< entity >

Alias declaration for the most common use case.

Mentioned in:

Entity Component System / They call me Reactive System

using organizer = basic_organizer< entity >

Alias declaration for the most common use case.

using handle = basic_handle< entity >

Alias declaration for the most common use case.

Mentioned in:

Entity Component System / Handle

using const_handle = basic_handle< const entity >

Alias declaration for the most common use case.

Mentioned in:

Entity Component System / Handle

using snapshot = basic_snapshot< entity >

Alias declaration for the most common use case.

Mentioned in:

Entity Component System / Snapshot: complete vs continuous

using snapshot_loader = basic_snapshot_loader< entity >

Alias declaration for the most common use case.

Mentioned in:

Entity Component System / Snapshot loader

using continuous_loader = basic_continuous_loader< entity >

Alias declaration for the most common use case.

Mentioned in:

Entity Component System / Continuous loader

template <typename... Args>
using view = basic_view< entity, Args... >

Alias declaration for the most common use case.

Template Parameters:

Args - Other template parameters.

Mentioned in:

Entity Component System / Types: const, non-const and all in between

using runtime_view = basic_runtime_view< entity >

Alias declaration for the most common use case.

template <typename... Args>
using group = basic_group< entity, Args... >

Alias declaration for the most common use case.

Template Parameters:

Args - Other template parameters.

template <typename Entity, typename Type>
using pool_t = typename pool< Entity, Type >::type

Alias declaration to use to make component-to-pool conversions.

Template Parameters:

Entity - A valid entity type (see entt_traits for more details).

Type - Type of objects assigned to the entities.

Variables

template <id_type Value>
monostate< Value > monostate_v = {}

Helper variable template.

Template Parameters:

Value - Value used to differentiate between different variables.

template <class Type>
constexpr auto size_of_v = size_of<Type>::value

Helper variable template.

Template Parameters:

Type - The type of which to return the size.

template <auto Value, typename>
constexpr auto unpack_as_v = Value

Helper variable template to be used to repeat the same value a number of times equal to the size of a given parameter pack.

Template Parameters:

Value - A value to repeat.

template <std::size_t N>
constexpr choice_t< N > choice {}

Variable template for the choice trick.

Template Parameters:

N - Number of choices available.

template <class List, typename Type>
constexpr auto type_list_contains_v = type_list_contains<List, Type>::value

Helper variable template.

Template Parameters:

List - Type list.

Type - Type to look for.

template <class Type>
constexpr auto is_equality_comparable_v = is_equality_comparable<Type>::value

Helper variable template.

Template Parameters:

Type - Potentially equality comparable type.

template <typename Func, typename Args>
constexpr auto is_applicable_v = is_applicable<Func, Args>::value

Helper variable template.

Template Parameters:

Func - A valid function type.

Args - The list of arguments to use to probe the function type.

template <typename Ret, typename Func, typename Args>
constexpr auto is_applicable_r_v = is_applicable_r<Ret, Func, Args>::value

Helper variable template.

Template Parameters:

Ret - The type to which the return type of the function should be convertible.

Func - A valid function type.

Args - The list of arguments to use to probe the function type.

template <typename Type>
constexpr auto is_eto_eligible_v = is_eto_eligible<Type>::value

Helper variable template.

Template Parameters:

Type - Potential empty type.

constexpr null_t null {}

Compile-time constant for null entities.

Internal details not to be documented. There exist implicit conversions from this variable to entity identifiers of any allowed type. Similarly, there exist comparision operators between the null entity and any other entity identifier.

Mentioned in:

Entity Component System / Null entity

Frequently Asked Questions / How can I represent hierarchies with my components?

constexpr basic_collector collector {}

Variable template used to ease the definition of collectors.

template <typename... Type>
constexpr exclude_t< Type... > exclude {}

Variable template for exclusion lists.

Template Parameters:

Type - List of types.

Mentioned in:

Entity Component System / They call me Reactive System

Entity Component System / Views

Entity Component System / Full-owning groups

Entity Component System / Partial-owning groups

Entity Component System / Non-owning groups

Entity Component System / Nested groups

template <typename... Type>
constexpr get_t< Type... > get {}

Variable template for lists of observed components.

Template Parameters:

Type - List of types.

Mentioned in:

Entity Component System / Groups

Entity Component System / Partial-owning groups

Entity Component System / Non-owning groups

Entity Component System / Nested groups

constexpr as_ref_t as_ref

Disambiguation tag.

template <typename Type>
constexpr auto has_meta_sequence_container_traits_v = has_meta_sequence_container_traits<Type>::value

Helper variable template.

Template Parameters:

Type - Potentially sequence container type.

template <typename Type>
constexpr auto has_meta_associative_container_traits_v = has_meta_associative_container_traits<Type>::value

Helper variable template.

Template Parameters:

Type - Potentially associative container type.

template <typename Type>
constexpr auto is_key_only_meta_associative_container_v = is_key_only_meta_associative_container<Type>::value

Helper variable template.

Template Parameters:

Type - Potentially key-only meta associative container type.

template <typename Type>
constexpr auto is_meta_pointer_like_v = is_meta_pointer_like<Type>::value

Helper variable template.

Template Parameters:

Type - Potentially pointer-like type.

template <auto Func>
constexpr connect_arg_t< Func > connect_arg {}

Constant of type connect_arg_t used to disambiguate calls.

Mentioned in:

Events, Signals And Everything In Between / Delegate

Source

Line 13 in src/entt/core/algorithm.hpp.






Add Discussion

Log in to comment