Clementine
Public Types | Public Member Functions | List of all members
entt::as_group< Entity > Struct Template Reference

Converts a registry to a group. More...

#include <entt.hpp>

Public Types

using entity_type = std::remove_const_t< Entity >
 Underlying entity identifier.
 
using registry_type = constness_as_t< basic_registry< entity_type >, Entity >
 Type of registry to convert.
 

Public Member Functions

 as_group (registry_type &source) ENTT_NOEXCEPT
 Constructs a converter for a given registry. More...
 
template<typename Exclude , typename Get , typename... Owned>
 operator basic_group< entity_type, Exclude, Get, Owned... > () const
 Conversion function from a registry to a group. More...
 

Detailed Description

template<typename Entity>
struct entt::as_group< Entity >

Converts a registry to a group.

Template Parameters
EntityA valid entity type (see entt_traits for more details).

Constructor & Destructor Documentation

◆ as_group()

template<typename Entity >
entt::as_group< Entity >::as_group ( registry_type source)
inline

Constructs a converter for a given registry.

Parameters
sourceA valid reference to a registry.

Member Function Documentation

◆ operator basic_group< entity_type, Exclude, Get, Owned... >()

template<typename Entity >
template<typename Exclude , typename Get , typename... Owned>
entt::as_group< Entity >::operator basic_group< entity_type, Exclude, Get, Owned... > ( ) const
inline

Conversion function from a registry to a group.

Template Parameters
ExcludeTypes of components used to filter the group.
GetTypes of components observed by the group.
OwnedTypes of components owned by the group.
Returns
A newly created group.

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