C++ API

Namespaces

Functions

	app	Mentioned in REST API Manual / Enable the REST API
	bit	Add bitmask constant.
	component overload	Register a component.
	constant	Add constant.
	cursor overload
	doc_brief
	doc_color
	doc_detail
	doc_link
	doc_name	Mentioned in JSON format Manual / Label
	each overload	Iterate over all entities with components in argument list of function
	each overload	Iterate over all entities with provided component
	each overload	Iterate over all entities with provided (component) id.
	entity overload	Create an entity.
	entity overload	Get id from an enum constant.
	entity overload	Create an entity that's associated with a type.
	event overload	Create a new event.
	filter	Create a filter.
	filter_builder	Create a filter builder.
	get_pipeline	Get pipeline.
	get_target_fps	Get target FPS
	get_threads	Set number of threads.
	get_tick	Get tick
	get_time_scale	Get timescale
	id overload	Get id from an enum constant.
	id overload	Get id from a type.
	id overload	Id factory.
	import	Import a module.
	interval overload	Set interval.
	interval overload	Get interval.
	member overload	Add member.
	member overload	Add member with unit.
	module	Create a module.
	observer overload	Upcast entity to an observer
	observer overload	Create a new observer.
	operator delete
	operator new
	pair overload	Get pair id from relationship, object
	pipeline	Create a new pipeline.
	plecs_from_file	Load plecs from file.
	plecs_from_str	Load plecs string.
	prefab overload	Create a prefab.
	prefab overload	Create a prefab that's associated with a type.
	progress	Progress world one tick.
	quantity overload	Add quantity to unit
	quantity overload	Make entity a unity prefix
	query overload	Create a query.
	query overload	Create a subquery.
	query_builder	Create a query builder.
	rate	Set system rate (system is its own tick source).
	reset_clock	Reset simulation clock.
	rule overload	Create a rule.
	rule overload	Create a subrule.
	rule_builder	Create a rule builder.
	run_pipeline	Run pipeline.
	set_doc_brief
	set_doc_color
	set_doc_detail
	set_doc_link
	set_doc_name	Mentioned in Designing with Flecs / Entity Names
	set_pipeline overload	Set pipeline.
	set_target_fps	Set target FPS
	set_threads	Set number of threads.
	set_tick_source	Set external tick source.
	set_time_scale	Set timescale
	set_var overload	Mentioned in Query Manual / Query Builder (C++)
	snapshot	Create a snapshot.
	start	Start timer.
	stop	Stop timer.
	system overload	Upcast entity to a system
	system overload	Create a new system.
	term overload	Create a term.
	term overload	Create a term for a (component) type.
	term overload	Create a term for a pair.
	timeout overload	Set timeout.
	timeout overload	Get timeout.
	to_constant	Convert entity to enum cosnstant
	to_entity	Convert enum constant to entity
	to_expr overload
	to_json overload	Mentioned in JSON format Manual / Entity serializer
	unit overload	Make entity a unit
	unit overload	Make entity a derived unit
	unit_prefix	Make 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)