Namespace entt

Description

No description yet.

Namespaces

Classes

	adl_meta_pointer_like	Fake ADL based lookup function for meta pointer-like types.
	as_cref_t	Empty class type used to request the as cref policy.
	as_group	Converts a registry to a group.
	as_is_t	Empty class type used to request the as-is policy.
	as_ref_t	Empty class type used to request the as ref policy.
	as_view	Converts a registry to a view.
	as_void_t	Empty class type used to request the as void policy.
	basic_any	A SBO friendly, type-safe container for single values of any type.
	basic_collector	Collector.
	basic_collector< matcher< type_list< Reject... >, type_list< Require... >, Rule... >, Other... >	Collector.
	basic_collector<>	Collector.
	basic_component_traits	Commonly used default traits for all types.
	basic_continuous_loader	Utility class for continuous loading.
	basic_group	Group.
	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_handle	Non-owning handle to an entity.
	basic_hashed_string	Zero overhead unique identifier.
	basic_observer	Observer.
	basic_organizer	Utility class for creating a static task graph.
	basic_poly	Static polymorphism made simple and within everyone's reach.
	basic_registry	Fast and reliable entity-component system.
	basic_runtime_view	Runtime view.
	basic_snapshot	Utility class to create snapshots from a registry.
	basic_snapshot_loader	Utility class to restore a snapshot as a whole.
	basic_sparse_set	Basic sparse set implementation.
	basic_storage	Storage implementation dispatcher.
	basic_storage_impl	Basic storage implementation.
	basic_storage_impl< Entity, Type, Allocator, std::enable_if_t< component_traits< Type >::ignore_if_empty::value &&std::is_empty_v< Type > > >	Default constructor.
	basic_view	View implementation dispatcher.
	basic_view< Entity, exclude_t< Exclude... >, Component... >	View implementation dispatcher.
	basic_view_impl	View implementation.
	basic_view_impl< packed_storage_policy, Entity, exclude_t<>, Component >	Single component view specialization.
	basic_view_impl< Policy, Entity, exclude_t< Exclude... >, Component... >	Multi component view.
	choice_t	Utility class to disambiguate overloaded functions.
	choice_t< 0 >	Utility class to disambiguate overloaded functions.
	component_traits	Common way to access various properties of components.
	connect_arg_t	Used to wrap a function or a member of a specified type.
	connection	Connection class.
	constness_as	Transcribes the constness of a type to another type.
	constness_as< To, const From >	Transcribes the constness of a type to another type.
	delegate	Basic delegate implementation.
	delegate< Ret(Args...)>	Utility class to use to send around functions and members.
	dispatcher	Basic dispatcher implementation.
	emitter	General purpose event emitter.
	entt_traits	Entity traits.
	exclude_t	Alias for exclusion lists.
	family	Dynamic identifier generator.
	get_t	Alias for lists of observed components.
	identifier	Types identifiers.
	identity	Identity function object (waiting for C++20).
	insertion_sort	Function object for performing insertion sort.
	is_applicable	Same as std::is_invocable, but with tuples.
	is_applicable< Func, const Tuple< Args... > >	Same as std::is_invocable, but with tuples.
	is_applicable< Func, Tuple< Args... > >	Same as std::is_invocable, but with tuples.
	is_applicable_r	Same 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_complete	Provides the member constant `value` to true if a given type is complete, false otherwise.
	is_complete< Type, std::void_t< decltype(sizeof(Type))> >	Provides the member constant `value` to true if a given type is complete, false otherwise.
	is_equality_comparable	Provides the member constant `value` to true if a given type is equality comparable, false otherwise.
	is_iterator	Provides the member constant `value` to true if a given type is an iterator, false otherwise.
	is_iterator< Type, std::void_t< typename std::iterator_traits< Type >::iterator_category > >	Provides the member constant `value` to true if a given type is an iterator, false otherwise.
	is_iterator_type	Provides the member constant `value` to true if a given type is of the required iterator type, false otherwise.
	is_iterator_type< Type, It, std::enable_if_t< is_iterator_v< Type > &&std::is_same_v< Type, It > > >	Provides the member constant `value` to true if a given type is of the required iterator type, false otherwise.
	is_iterator_type< Type, It, std::enable_if_t<!std::is_same_v< Type, It >, std::void_t< typename It::iterator_type > > >	Provides the member constant `value` to true if a given type is of the required iterator type, false otherwise.
	is_meta_pointer_like	Provides 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< const Type >	Partial specialization to ensure that const pointer-like types are also accepted.
	is_meta_pointer_like< std::shared_ptr< Type > >	Makes `std::shared_ptr`s of any type pointer-like types for the meta system.
	is_meta_pointer_like< std::unique_ptr< Type, Args... > >	Makes `std::unique_ptr`s 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.
	is_meta_pointer_like< Type(*)[N]>	Partial specialization used to reject pointers to arrays.
	matcher	Grouping matcher.
	member_class	Extracts the class of a non-static member object or function.
	meta_any	Opaque wrapper for values of any type.
	meta_associative_container	Proxy object for associative containers.
	meta_associative_container_traits	Traits 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::map`s of any type.
	meta_associative_container_traits< std::set< Key, Args... > >	Meta associative container traits for `std::set`s of any type.
	meta_associative_container_traits< std::unordered_map< Key, Value, Args... > >	Meta associative container traits for `std::unordered_map`s of any type.
	meta_associative_container_traits< std::unordered_set< Key, Args... > >	Meta associative container traits for `std::unordered_set`s of any type.
	meta_class_template_tag	Utility class to disambiguate class templates.
	meta_ctor	Opaque wrapper for constructors.
	meta_ctx	Opaque container for a meta context.
	meta_data	Opaque wrapper for data members.
	meta_factory	Meta 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_func	Opaque wrapper for member functions.
	meta_function_descriptor	Primary template isn't defined on purpose.
	meta_function_descriptor< Type, Ret(*)(Args...)>	Meta function descriptor.
	meta_function_descriptor< Type, Ret(Class::*)(Args...) const >	Meta function descriptor.
	meta_function_descriptor< Type, Ret(Class::*)(Args...)>	Meta function descriptor.
	meta_function_helper	Meta function helper.
	meta_handle	Opaque pointers to instances of any type.
	meta_prop	Opaque wrapper for properties of any type.
	meta_range	Iterable range to use to iterate all types of meta objects.
	meta_sequence_container	Proxy object for sequence containers.
	meta_sequence_container_traits	Traits 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::array`s of any type.
	meta_sequence_container_traits< std::vector< Type, Args... > >	Meta sequence container traits for `std::vector`s of any type.
	meta_template_traits	Traits class template to be specialized to enable support for meta template information.
	meta_template_traits< Clazz< Args... > >	General purpose traits class for generating meta template information.
	meta_type	Opaque wrapper for types.
	monostate	Minimal implementation of the monostate pattern.
	null_t	Null object for all entity identifiers.
	overloaded	Helper type for visitors.
	packed_storage_policy	Packed storage policy, aimed at faster linear iteration.
	poly_base	Poly base class used to inject functionalities into concepts.
	poly_inspector	Inspector class used to infer the type of the virtual table.
	poly_storage_traits	Defines the poly storage type associate with a given entity type.
	poly_vtable	Static virtual table factory.
	process	Base class for processes.
	process_adaptor	Adaptor for lambdas and functors to turn them into processes.
	radix_sort	Function object for performing LSD radix sort.
	resource_cache	Simple cache for resources of a given type.
	resource_handle	Shared resource handle.
	resource_loader	Base class for resource loaders.
	scheduler	Cooperative scheduler for processes.
	scoped_connection	Scoped connection class.
	service_locator	Service locator, nothing more.
	sigh	Unmanaged signal handler.
	sigh< Ret(Args...)>	Unmanaged signal handler.
	sigh_storage_mixin	Mixin type to use to add signal support to storage types.
	sink	Sink class.
	sink< Ret(Args...)>	Sink class.
	size_of	A 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.
	stable_storage_policy	Stable storage policy, aimed at pointer stability.
	std_sort	Function object to wrap `std::sort` in a class type.
	Storage	Basic poly storage implementation.
	storage_adapter_mixin	Mixin type to use to wrap basic storage classes.
	storage_traits	Provides a common way to access certain properties of storage types.
	tombstone_t	Tombstone object for all entity identifiers.
	type_hash	Type hash.
	type_identity	Identity type trait.
	type_info	Implementation specific information about a type.
	type_list	A class to use to push around lists of types, nothing more.
	type_list_cat	Primary 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_contains	Provides 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_diff	Primary template isn't defined on purpose.
	type_list_diff< type_list< Type... >, type_list< Other... > >	Computes the difference between two type lists.
	type_list_element	Primary template isn't defined on purpose.
	type_list_element< 0u, type_list< Type, Other... > >	Provides compile-time indexed access to the types of a type list.
	type_list_element< Index, type_list< Type, Other... > >	Provides compile-time indexed access to the types of a type list.
	type_list_unique	Primary 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_name	Type name.
	type_seq	Type sequential identifier.
	value_list	A class to use to push around lists of constant values, nothing more.
	value_list_cat	Primary template isn't defined on purpose.
	value_list_cat< value_list< Value... > >	Concatenates multiple value lists.
	value_list_cat< value_list< Value... >, value_list< Other... >, List... >	Concatenates multiple value lists.
	value_list_cat<>	Concatenates multiple value lists.
	value_list_element	Primary template isn't defined on purpose.
	value_list_element< 0u, value_list< Value, Other... > >	Provides compile-time indexed access to the types of a type list.
	value_list_element< Index, value_list< Value, Other... > >	Provides compile-time indexed access to the values of a value list.
	y_combinator	Basic implementation of a y-combinator.

Functions

	any_cast overload	Performs type-safe access to the contained object.
	dereference_meta_pointer_like	ADL based lookup function for dereferencing meta pointer-like types.
	forward_as_any	Forwards its argument and avoids copies for lvalue references.
	forward_as_meta	Forwards its argument and avoids copies for lvalue references.
	get_as_tuple	Gets the element assigned to an entity from a storage, if any.
	invoke	Helper to create a listener that directly invokes a member function.
	make_any	Constructs a wrapper from a given type, passing it all arguments.
	make_meta	Constructs a wrapper from a given type, passing it all arguments.
	meta	Utility function to use for reflection.
	meta_arg	Returns the meta type of the i-th element of a list of arguments.
	meta_construct overload	Constructs an instance given a list of erased parameters, if possible.
	meta_dispatch	Wraps a value depending on the given policy.
	meta_getter	Gets the value of a given variable.
	meta_invoke overload	Invokes a callable object given a list of erased parameters, if possible.
	meta_invoke overload	Invokes a function given a list of erased parameters, if possible.
	meta_reset overload	Resets a type and all its parts.
	meta_setter	Sets the value of a given variable.
	operator!= overload	Checks if two wrappers differ in their content.
	operator!= overload	Compares two hashed strings.
	operator!= overload	Compares the contents of two type info objects.
	operator!= overload	Compares a null object and an entity identifier of any type.
	operator!= overload	Compares a tombstone object and an entity identifier of any type.
	operator!= overload	Compares two handles.
	operator!= overload	Checks if two objects refer to the same type.
	operator!= overload	Compares the contents of two delegates.
	operator""_hs	User defined literal for hashed strings.
	operator""_hws	User defined literal for hashed wstrings.
	operator+ overload	Concatenates multiple type lists.
	operator+ overload	Concatenates multiple value lists.
	operator== overload	Compares a null object and an entity identifier of any type.
	operator== overload	Compares a tombstone object and an entity identifier of any type.
	operator\|	Combines two views in a more specific one.
	overload overload	Constant utility to disambiguate overloaded members of a class.
	overload overload	Constant utility to disambiguate overloaded functions.
	poly_call	Shortcut for calling `poly_base<Type>invoke`.
	resolve overload	Returns the meta type associated with a given type.
	resolve overload	Returns the meta type associated with a given identifier, if any.
	resolve overload	Returns the meta type associated with a given type info object, if any.
	to_entity	Returns the entity associated with a given component.
	to_integral	Converts an entity to its underlying type.
	type_id	Returns the type info object for a given type.

Enums

	entity	Default entity identifier.
	deletion_policy	Sparse set deletion policy.

Typedefs

Typedefs (fwd.hpp)

using id_type = std::uint32_t

Alias declaration for type identifiers.

Mentioned in:

Configuration / ENTT_ID_TYPE

Core Functionalities / Type info

Core Functionalities / Tag

Entity Component System / Runtime views

Resource Management / The resource, the loader and the cache

using any = basic_any<>

Alias declaration for the most common use case.

Mentioned in:

Core Functionalities / Any as in any type

Poly / Introduction

Poly / Storage size and alignment requirement

Runtime Reflection System / Any to the rescue

Typedefs (hashed_string.hpp)

using hashed_string = basic_hashed_string< char >

Aliases for common character types.

Mentioned in:

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

Typedefs (type_traits.hpp)

	template <typename Type> using type_identity_t = typename type_identity< Type >::type	Helper type. Template Parameters `Type` - A type.
	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 facilitate the creation of named values. Template Parameters `Value` - A constant value at least convertible to `id_type`. Mentioned in: Core Functionalities / Tag
	template <std::size_t Index, typename List> using type_list_element_t = typename type_list_element< Index, List >::type	Helper type. Template Parameters `Index` - Index of the type to return. `List` - Type list to search into.
	template <typename... List> using type_list_cat_t = typename type_list_cat< List... >::type	Helper type. Template Parameters `List` - Type lists to concatenate. Mentioned in: Poly / Inheritance
	template <typename Type> using type_list_unique_t = typename type_list_unique< Type >::type	Helper type. Template Parameters `Type` - A type list.
	template <typename... List> using type_list_diff_t = typename type_list_diff< List... >::type	Helper type. Template Parameters `List` - Type lists between which to compute the difference.
	template <typename... List> using value_list_cat_t = typename value_list_cat< List... >::type	Helper type. Template Parameters `List` - Value lists to concatenate. Mentioned in: Poly / Inheritance
	template <typename To, typename From> using constness_as_t = typename constness_as< To, From >::type	Alias template to facilitate the transcription of the constness. Template Parameters `To` - The type to which to transcribe the constness. `From` - The type from which to transcribe the constness. Mentioned in: Core Functionalities / Constness as
	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

Typedefs (fwd.hpp)

	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 / Type-less and bitset-free Entity Component System / The Registry, the Entity and the Component Entity Component System / Observe changes Entity Component System / Organizer
	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. Mentioned in: Entity Component System / Organizer
	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
	template <typename... Args> using handle_view = basic_handle< entity, Args... >	Alias declaration for the most common use case. Template Parameters `Args` - Other template parameters.
	template <typename... Args> using const_handle_view = basic_handle< const entity, Args... >	Alias declaration for the most common use case. Template Parameters `Args` - Other template parameters.
	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 / Organizer 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.

Typedefs (utility.hpp)

template <typename Type, typename Candidate>
using meta_function_helper_t = typename meta_function_helper< Type, Candidate >::type

Helper type.

Template Parameters

Type - Reflected type to which the meta function is associated.

Candidate - The actual function to associate with the reflected type.

Typedefs (fwd.hpp)

template <typename Concept>
using poly = basic_poly< Concept, sizeof(double[2])>

Alias declaration for the most common use case.

Template Parameters: Concept - Concept descriptor.

Mentioned in:

Entity Component System / Build your own

Entity Component System / Meet the runtime

Poly / Crash Course: poly

Poly / Introduction

Poly / Inheritance

Poly / Static polymorphism in the wild

Poly / Storage size and alignment requirement

Variables

Variables (monostate.hpp)

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

Helper variable template.

Template Parameters: Value - Value used to differentiate between different variables.

Variables (type_traits.hpp)

	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 Type> constexpr std::size_t size_of_v = size_of<Type>::value	Helper variable template. Template Parameters `Type` - The type of which to return the size. Mentioned in: Core Functionalities / Size of
	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 <class List, typename Type> constexpr bool type_list_contains_v = type_list_contains<List, Type>::value	Helper variable template. Template Parameters `List` - Type list. `Type` - Type to look for.
	template <std::size_t Index, typename List> constexpr auto value_list_element_v = value_list_element<Index, List>::value	Helper type. Template Parameters `Index` - Index of the value to return. `List` - Value list to search into.
	template <typename Func, typename Args> constexpr bool 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 bool 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 bool is_complete_v = is_complete<Type>::value	Helper variable template. Template Parameters `Type` - The type to test.
	template <typename Type> constexpr bool is_iterator_v = is_iterator<Type>::value	Helper variable template. Template Parameters `Type` - The type to test.
	template <typename Type, typename It> constexpr bool is_iterator_type_v = is_iterator_type<Type, It>::value	Helper variable template. Template Parameters `Type` - The type to test. `It` - Required iterator type.
	template <class Type> constexpr bool is_equality_comparable_v = is_equality_comparable<Type>::value	Helper variable template. Template Parameters `Type` - The type to test.

Variables (entity.hpp)

constexpr null_t null {}

Compile-time constant for null entities.

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

Entity Component System / Hierarchies and the like

constexpr tombstone_t tombstone {}

Compile-time constant for tombstone entities.

There exist implicit conversions from this variable to entity identifiers of any allowed type. Similarly, there exist comparision operators between the tombstone entity and any other entity identifier.

Mentioned in:: Entity Component System / Tombstone

Variables (observer.hpp)

constexpr basic_collector collector {}

Variable template used to ease the definition of collectors.

Variables (utility.hpp)

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

Variables (type_traits.hpp)

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.

Variables (delegate.hpp)

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.

Namespace entt

Description

Namespaces

Classes

Functions

Enums

Typedefs

Typedefs (fwd.hpp)

Typedefs (hashed_string.hpp)

Typedefs (type_traits.hpp)

Typedefs (fwd.hpp)

Typedefs (utility.hpp)

Typedefs (fwd.hpp)

Variables

Variables (monostate.hpp)

Variables (type_traits.hpp)

Variables (entity.hpp)

Variables (observer.hpp)

Variables (utility.hpp)

Variables (type_traits.hpp)

Variables (delegate.hpp)

Source

Add Discussion