C++ API

Namespaces

flecs

Functions

app

Mentioned in

bitAdd bitmask constant.
component overloadRegister a component.
constantAdd constant.
cursor overload
doc_brief
doc_color
doc_detail
doc_name

Mentioned in

  • JSON format Manual / Label
each overloadIterate over all entities with components in argument list of function
each overloadIterate over all entities with provided component
each overloadIterate over all entities with provided (component) id.
entity overloadCreate an entity.
entity overloadGet id from an enum constant.
entity overloadCreate an entity that's associated with a type.
event overloadCreate a new event.
filterCreate a filter.
filter_builderCreate a filter builder.
get_pipelineGet pipeline.
get_target_fpsGet target FPS
get_threadsSet number of threads.
get_tickGet tick
get_time_scaleGet timescale
id overloadGet id from an enum constant.
id overloadGet id from a type.
id overloadId factory.
importImport a module.
interval overloadSet interval.
interval overloadGet interval.
member overloadAdd member.
member overloadAdd member with unit.
moduleCreate a module.
observer overloadUpcast entity to an observer
observer overloadCreate a new observer.
operator delete
operator new
pair overloadGet pair id from relationship, object
pipelineCreate a new pipeline.
plecs_from_fileLoad plecs from file.
plecs_from_strLoad plecs string.
prefab overloadCreate a prefab.
prefab overloadCreate a prefab that's associated with a type.
progressProgress world one tick.
quantity overloadAdd quantity to unit
quantity overloadMake entity a unity prefix
query overloadCreate a query.
query overloadCreate a subquery.
query_builderCreate a query builder.
rateSet system rate (system is its own tick source).
reset_clockReset simulation clock.
rule overloadCreate a rule.
rule overloadCreate a subrule.
rule_builderCreate a rule builder.
run_pipelineRun pipeline.
set_doc_brief
set_doc_color
set_doc_detail
set_doc_name

Mentioned in

set_pipeline overloadSet pipeline.
set_target_fpsSet target FPS
set_threadsSet number of threads.
set_tick_sourceSet external tick source.
set_time_scaleSet timescale
set_var overload

Mentioned in

snapshotCreate a snapshot.
startStart timer.
stopStop timer.
system overloadUpcast entity to a system
system overloadCreate a new system.
term overloadCreate a term.
term overloadCreate a term for a (component) type.
term overloadCreate a term for a pair.
timeout overloadSet timeout.
timeout overloadGet timeout.
to_constantConvert entity to enum cosnstant
to_entityConvert enum constant to entity
to_expr overload
to_json overload

Mentioned in

unit overloadMake entity a unit
unit overloadMake entity a derived unit
unit_prefixMake entity a derived unit

Defines

Defines (builder.hpp)

ECS_EVENT_DESC_ID_COUNT_MAX (8)

Defines (builder.hpp)

FLECS_TBUILDER template<typename ... Components> class

FLECS_IBUILDER template<typename IBase, typename ... Components> class

Defines (enum.hpp)

FLECS_ENUM_MAX(T)
_::to_constant<T, 128>::value

FLECS_ENUM_MAX_COUNT (FLECS_ENUM_MAX(int) + 1)

FLECS_ENUM_LAST(T,Last)
namespace flecs {
template<>
struct enum_last<T> {
static constexpr T value = Last;
};
}

ECS_SIZE_T_STR "constexpr size_t; size_t = long unsigned int"

Defines (utils.hpp)

FLECS_PLACEMENT_NEW(_ptr,_type)
::new(flecs::_::placement_new_tag, _ptr) _type

FLECS_NEW(_type)
FLECS_PLACEMENT_NEW(ecs_os_malloc(sizeof(_type)), _type)

FLECS_DELETE(_ptr)
do {
if (_ptr) {
flecs::_::destruct_obj(_ptr);
ecs_os_free(_ptr);
}
} while (false)

FLECS_MOV(...)
static_cast<flecs::remove_reference_t<decltype(__VA_ARGS__)>&&>(__VA_ARGS__)

FLECS_FWD(...)
static_cast<decltype(__VA_ARGS__)&&>(__VA_ARGS__)

flecs_static_assert(cond,str)
static_assert(cond, str)