Flecs: API Types and Globals
Description: A fast entity component system (ECS) for C & C++

| Flecs v4.1 A fast entity component system (ECS) for C & C++

Loading...
Searching...
No Matches
API Types and Globals
C++ API » Core

Types and constants bridged from C API. More...

Collaboration diagram for API Types and Globals:

## Typedefs
using | flecs::world_t = ecs_world_t
| World type.
using | flecs::world_info_t = ecs_world_info_t
| World info type.
using | flecs::id_t = ecs_id_t
| ID type.
using | flecs::entity_t = ecs_entity_t
| Entity type.
using | flecs::type_t = ecs_type_t
| Type type.
using | flecs::table_t = ecs_table_t
| Table type.
using | flecs::term_t = ecs_term_t
| Term type.
using | flecs::query_t = ecs_query_t
| Query type.
using | flecs::query_group_info_t = ecs_query_group_info_t
| Query group info type.
using | flecs::observer_t = ecs_observer_t
| Observer type.
using | flecs::iter_t = ecs_iter_t
| Iterator type.
using | flecs::ref_t = ecs_ref_t
| Ref type.
using | flecs::table_record_t = ecs_table_record_t
| Table record type.
using | flecs::table_records_t = ecs_table_records_t
| Table records type.
using | flecs::component_record_t = ecs_component_record_t
| Component record type.
using | flecs::type_info_t = ecs_type_info_t
| Type info type.
using | flecs::type_hooks_t = ecs_type_hooks_t
| Type hooks type.
using | flecs::flags32_t = ecs_flags32_t
| 32-bit flags type.
using | flecs::flags64_t = ecs_flags64_t
| 64-bit flags type.
using | flecs::Component = EcsComponent
| Built-in EcsComponent type.
using | flecs::Identifier = EcsIdentifier
| Built-in EcsIdentifier type.
using | flecs::Poly = EcsPoly
| Built-in EcsPoly type.
using | flecs::DefaultChildComponent = EcsDefaultChildComponent
| Built-in EcsDefaultChildComponent type.
using | flecs::Parent = EcsParent
| Built-in EcsParent type.

## Enumerations
enum | flecs::inout_kind_t { flecs::InOutDefault = EcsInOutDefault , flecs::InOutNone = EcsInOutNone , flecs::InOutFilter = EcsInOutFilter , flecs::InOut = EcsInOut , flecs::In = EcsIn , flecs::Out = EcsOut }
| Inout kind. More...
enum | flecs::oper_kind_t { flecs::And = EcsAnd , flecs::Or = EcsOr , flecs::Not = EcsNot , flecs::Optional = EcsOptional , flecs::AndFrom = EcsAndFrom , flecs::OrFrom = EcsOrFrom , flecs::NotFrom = EcsNotFrom }
| Operator kind. More...
enum | flecs::query_cache_kind_t { flecs::QueryCacheDefault = EcsQueryCacheDefault , flecs::QueryCacheAuto = EcsQueryCacheAuto , flecs::QueryCacheAll = EcsQueryCacheAll , flecs::QueryCacheNone = EcsQueryCacheNone }
| Query cache kind. More...

## Detailed Description

Types and constants bridged from C API.

## Typedef Documentation

## ◆ Component

using flecs::Component = EcsComponent

Built-in EcsComponent type.

Definition at line 77 of file c_types.hpp.

## ◆ component_record_t

using flecs::component_record_t = ecs_component_record_t

Component record type.

Definition at line 32 of file c_types.hpp.

## ◆ DefaultChildComponent

using flecs::DefaultChildComponent = EcsDefaultChildComponent

Built-in EcsDefaultChildComponent type.

Definition at line 83 of file c_types.hpp.

## ◆ entity_t

using flecs::entity_t = ecs_entity_t

Entity type.

Definition at line 21 of file c_types.hpp.

## ◆ flags32_t

using flecs::flags32_t = ecs_flags32_t

32-bit flags type.

Definition at line 35 of file c_types.hpp.

## ◆ flags64_t

using flecs::flags64_t = ecs_flags64_t

64-bit flags type.

Definition at line 36 of file c_types.hpp.

## ◆ id_t

using flecs::id_t = ecs_id_t

ID type.

Definition at line 20 of file c_types.hpp.

## ◆ Identifier

using flecs::Identifier = EcsIdentifier

Built-in EcsIdentifier type.

Definition at line 79 of file c_types.hpp.

## ◆ iter_t

using flecs::iter_t = ecs_iter_t

Iterator type.

Definition at line 28 of file c_types.hpp.

## ◆ observer_t

using flecs::observer_t = ecs_observer_t

Observer type.

Definition at line 27 of file c_types.hpp.

## ◆ Parent

using flecs::Parent = EcsParent

Built-in EcsParent type.

Definition at line 85 of file c_types.hpp.

## ◆ Poly

using flecs::Poly = EcsPoly

Built-in EcsPoly type.

Definition at line 81 of file c_types.hpp.

## ◆ query_group_info_t

using flecs::query_group_info_t = ecs_query_group_info_t

Query group info type.

Definition at line 26 of file c_types.hpp.

## ◆ query_t

using flecs::query_t = ecs_query_t

Query type.

Definition at line 25 of file c_types.hpp.

## ◆ ref_t

using flecs::ref_t = ecs_ref_t

Ref type.

Definition at line 29 of file c_types.hpp.

## ◆ table_record_t

using flecs::table_record_t = ecs_table_record_t

Table record type.

Definition at line 30 of file c_types.hpp.

## ◆ table_records_t

using flecs::table_records_t = ecs_table_records_t

Table records type.

Definition at line 31 of file c_types.hpp.

## ◆ table_t

using flecs::table_t = ecs_table_t

Table type.

Definition at line 23 of file c_types.hpp.

## ◆ term_t

using flecs::term_t = ecs_term_t

Term type.

Definition at line 24 of file c_types.hpp.

## ◆ type_hooks_t

using flecs::type_hooks_t = ecs_type_hooks_t

Type hooks type.

Definition at line 34 of file c_types.hpp.

## ◆ type_info_t

using flecs::type_info_t = ecs_type_info_t

Type info type.

Definition at line 33 of file c_types.hpp.

## ◆ type_t

using flecs::type_t = ecs_type_t

Type type.

Definition at line 22 of file c_types.hpp.

## ◆ world_info_t

using flecs::world_info_t = ecs_world_info_t

World info type.

Definition at line 19 of file c_types.hpp.

## ◆ world_t

using flecs::world_t = ecs_world_t

World type.

Definition at line 18 of file c_types.hpp.

## Enumeration Type Documentation

## ◆ inout_kind_t

enum flecs::inout_kind_t

Inout kind.

Enumerator
InOutDefault | InOutDefault.
InOutNone | InOutNone.
InOutFilter | InOutFilter.
InOut | InOut.
In | In.
Out | Out.

Definition at line 39 of file c_types.hpp.

## ◆ oper_kind_t

enum flecs::oper_kind_t

Operator kind.

Enumerator
And | And operator.
Or | Or operator.
Not | Not operator.
Optional | Optional operator.
AndFrom | AndFrom operator.
OrFrom | OrFrom operator.
NotFrom | NotFrom operator.

Definition at line 49 of file c_types.hpp.

## ◆ query_cache_kind_t

enum flecs::query_cache_kind_t

Query cache kind.

Enumerator
QueryCacheDefault | Default query cache.
QueryCacheAuto | Auto query cache.
QueryCacheAll | Cache all.
QueryCacheNone | No caching.

Definition at line 60 of file c_types.hpp.