Flecs reflection framework. More...

Classes
struct	flecs::cursor
	Class for reading/writing dynamic values. More...
struct	flecs::bitmask
	Base type for bitmasks. More...
struct	flecs::opaque< T, ElemType >
	Type-safe interface for opaque types. More...

Typedefs
using	flecs::bool_t = ecs_bool_t
	Primitive type aliases.
using	flecs::char_t = ecs_char_t
using	flecs::u8_t = ecs_u8_t
using	flecs::u16_t = ecs_u16_t
using	flecs::u32_t = ecs_u32_t
using	flecs::u64_t = ecs_u64_t
using	flecs::uptr_t = ecs_uptr_t
using	flecs::i8_t = ecs_i8_t
using	flecs::i16_t = ecs_i16_t
using	flecs::i32_t = ecs_i32_t
using	flecs::i64_t = ecs_i64_t
using	flecs::iptr_t = ecs_iptr_t
using	flecs::f32_t = ecs_f32_t
using	flecs::f64_t = ecs_f64_t
using	flecs::member_t = ecs_member_t
	Embedded type aliases.
using	flecs::enum_constant_t = ecs_enum_constant_t
using	flecs::bitmask_constant_t = ecs_bitmask_constant_t
using	flecs::Type = EcsType
	Components.
using	flecs::TypeSerializer = EcsTypeSerializer
using	flecs::Primitive = EcsPrimitive
using	flecs::Enum = EcsEnum
using	flecs::Bitmask = EcsBitmask
using	flecs::Member = EcsMember
using	flecs::MemberRanges = EcsMemberRanges
using	flecs::Struct = EcsStruct
using	flecs::Array = EcsArray
using	flecs::Vector = EcsVector
using	flecs::Unit = EcsUnit
using	flecs::meta::type_kind_t = ecs_type_kind_t
	Type kinds supported by the reflection system.
using	flecs::meta::primitive_kind_t = ecs_primitive_kind_t
	Primitive type kinds supported by the reflection system.
using	flecs::meta::op_t = ecs_meta_op_t
using	flecs::serializer = ecs_serializer_t
	Serializer object, used for serializing opaque types.
using	flecs::serialize_t = ecs_meta_serialize_t
	Serializer function, used to serialize opaque types.
template<typename T>
using	flecs::serialize = int()(const serializer , const T*)
	Type-safe variant of the serializer function.
template<typename T>
using	flecs::serialize_member = int()(const serializer , const T, const char name)
	Type-safe variant of the serialize_member() function.
template<typename T>
using	flecs::serialize_element = int()(const serializer , const T*, size_t element)
	Type-safe variant of the serialize_element() function.

Variables
uint32_t	flecs::bitmask::value
untyped_component &	flecs::untyped_component::member (flecs::entity_t type_id, flecs::entity_t unit, const char *name, int32_t count=0, size_t offset=SIZE_MAX)
untyped_component &	member (flecs::entity_t type_id, const char *name, int32_t count=0, size_t offset=SIZE_MAX)
template<typename MemberType, typename UnitType = void>
untyped_component &	member (const char *name, int32_t count=0, size_t offset=SIZE_MAX)
template<typename MemberType>
untyped_component &	member (flecs::entity_t unit, const char *name, int32_t count=0, size_t offset=SIZE_MAX)
template<typename MemberType, typename ComponentType, typename RealType = std::remove_extent_t<MemberType>>
untyped_component &	member (const MemberType ComponentType::ptr, const char name, flecs::entity_t unit=0)
template<typename UnitType, typename MemberType, typename ComponentType, typename RealType = std::remove_extent_t<MemberType>>
untyped_component &	member (const MemberType ComponentType::ptr, const char name)
template<typename T = int32_t>
untyped_component &	constant (const char *name, T value)
	Add a constant.
template<typename T = uint32_t>
untyped_component &	bit (const char *name, T value)
	Add a bitmask constant.
template<typename Elem>
untyped_component &	array (int32_t elem_count)
	Register array metadata for a component.
untyped_component &	range (double min, double max)
untyped_component &	warning_range (double min, double max)
untyped_component &	error_range (double min, double max)
const Self &	flecs::entity_builder< Self >::unit (const char *symbol, flecs::entity_t prefix=0, flecs::entity_t base=0, flecs::entity_t over=0, int32_t factor=0, int32_t power=0) const
	Make an entity a unit.
const Self &	unit (flecs::entity_t prefix=0, flecs::entity_t base=0, flecs::entity_t over=0, int32_t factor=0, int32_t power=0) const
	Make an entity a derived unit.
const Self &	unit_prefix (const char *symbol, int32_t factor=0, int32_t power=0) const
	Make an entity a unit prefix.
const Self &	quantity (flecs::entity_t quantity) const
	Add a quantity to a unit.
template<typename Quantity>
const Self &	quantity () const
	Add a quantity to a unit.
const Self &	quantity () const
	Make an entity a quantity.
flecs::cursor	flecs::world::cursor (flecs::entity_t tid, void *ptr)
	Return a meta cursor to a value.
template<typename T>
flecs::cursor	cursor (void *ptr)
	Return a meta cursor to a value.
flecs::entity	primitive (flecs::meta::primitive_kind_t kind)
	Create a primitive type.
flecs::entity	array (flecs::entity_t elem_id, int32_t array_count)
	Create an array type.
template<typename T>
flecs::entity	array (int32_t array_count)
	Create an array type.
flecs::entity	vector (flecs::entity_t elem_id)
	Create a vector type.
template<typename T>
flecs::entity	vector ()
	Create a vector type.
untyped_component &	flecs::component< T >::member (flecs::entity_t type_id, flecs::entity_t unit, const char *name, int32_t count=0, size_t offset=SIZE_MAX)
untyped_component &	member (flecs::entity_t type_id, const char *name, int32_t count=0, size_t offset=SIZE_MAX)
template<typename MemberType, typename UnitType = void>
untyped_component &	member (const char *name, int32_t count=0, size_t offset=SIZE_MAX)
template<typename MemberType>
untyped_component &	member (flecs::entity_t unit, const char *name, int32_t count=0, size_t offset=SIZE_MAX)
template<typename MemberType, typename ComponentType, typename RealType = std::remove_extent_t<MemberType>>
untyped_component &	member (const MemberType ComponentType::ptr, const char name, flecs::entity_t unit=0)
template<typename UnitType, typename MemberType, typename ComponentType, typename RealType = std::remove_extent_t<MemberType>>
untyped_component &	member (const MemberType ComponentType::ptr, const char name)
template<typename T = int32_t>
untyped_component &	constant (const char *name, T value)
	Add a constant.
template<typename T = uint32_t>
untyped_component &	bit (const char *name, T value)
	Add a bitmask constant.
template<typename Elem>
untyped_component &	array (int32_t elem_count)
	Register array metadata for a component.
untyped_component &	range (double min, double max)
untyped_component &	warning_range (double min, double max)
untyped_component &	error_range (double min, double max)

Detailed Description

Flecs reflection framework.

Typedef Documentation

◆ Array

using flecs::Array = EcsArray

Definition at line 48 of file decl.hpp.

◆ Bitmask

using flecs::Bitmask = EcsBitmask

Definition at line 44 of file decl.hpp.

◆ bitmask_constant_t

using flecs::bitmask_constant_t = ecs_bitmask_constant_t

Definition at line 37 of file decl.hpp.

◆ bool_t

using flecs::bool_t = ecs_bool_t

Primitive type aliases.

Definition at line 19 of file decl.hpp.

◆ char_t

using flecs::char_t = ecs_char_t

Definition at line 20 of file decl.hpp.

◆ Enum

using flecs::Enum = EcsEnum

Definition at line 43 of file decl.hpp.

◆ enum_constant_t

using flecs::enum_constant_t = ecs_enum_constant_t

Definition at line 36 of file decl.hpp.

◆ f32_t

using flecs::f32_t = ecs_f32_t

Definition at line 31 of file decl.hpp.

◆ f64_t

using flecs::f64_t = ecs_f64_t

Definition at line 32 of file decl.hpp.

◆ i16_t

using flecs::i16_t = ecs_i16_t

Definition at line 27 of file decl.hpp.

◆ i32_t

using flecs::i32_t = ecs_i32_t

Definition at line 28 of file decl.hpp.

◆ i64_t

using flecs::i64_t = ecs_i64_t

Definition at line 29 of file decl.hpp.

◆ i8_t

using flecs::i8_t = ecs_i8_t

Definition at line 26 of file decl.hpp.

◆ iptr_t

using flecs::iptr_t = ecs_iptr_t

Definition at line 30 of file decl.hpp.

◆ Member

using flecs::Member = EcsMember

Definition at line 45 of file decl.hpp.

◆ member_t

using flecs::member_t = ecs_member_t

Embedded type aliases.

Definition at line 35 of file decl.hpp.

◆ MemberRanges

using flecs::MemberRanges = EcsMemberRanges

Definition at line 46 of file decl.hpp.

◆ op_t

using flecs::meta::op_t = ecs_meta_op_t

Definition at line 113 of file decl.hpp.

◆ Primitive

using flecs::Primitive = EcsPrimitive

Definition at line 42 of file decl.hpp.

◆ primitive_kind_t

using flecs::meta::primitive_kind_t = ecs_primitive_kind_t

Primitive type kinds supported by the reflection system.

Definition at line 93 of file decl.hpp.

◆ serialize

template<typename T>

using flecs::serialize = int(*)(const serializer *, const T*)

Type-safe variant of the serializer function.

Definition at line 26 of file opaque.hpp.

◆ serialize_element

template<typename T>

using flecs::serialize_element = int(*)(const serializer *, const T*, size_t element)

Type-safe variant of the serialize_element() function.

Definition at line 34 of file opaque.hpp.

◆ serialize_member

template<typename T>

using flecs::serialize_member = int(*)(const serializer *, const T*, const char* name)

Type-safe variant of the serialize_member() function.

Definition at line 30 of file opaque.hpp.

◆ serialize_t

using flecs::serialize_t = ecs_meta_serialize_t

Serializer function, used to serialize opaque types.

Definition at line 22 of file opaque.hpp.

◆ serializer

using flecs::serializer = ecs_serializer_t

Serializer object, used for serializing opaque types.

Definition at line 19 of file opaque.hpp.

◆ Struct

using flecs::Struct = EcsStruct

Definition at line 47 of file decl.hpp.

◆ Type

using flecs::Type = EcsType

Components.

Definition at line 40 of file decl.hpp.

◆ type_kind_t

using flecs::meta::type_kind_t = ecs_type_kind_t

Type kinds supported by the reflection system.

Definition at line 80 of file decl.hpp.

◆ TypeSerializer

using flecs::TypeSerializer = EcsTypeSerializer

Definition at line 41 of file decl.hpp.

◆ u16_t

using flecs::u16_t = ecs_u16_t

Definition at line 22 of file decl.hpp.

◆ u32_t

using flecs::u32_t = ecs_u32_t

Definition at line 23 of file decl.hpp.

◆ u64_t

using flecs::u64_t = ecs_u64_t

Definition at line 24 of file decl.hpp.

◆ u8_t

using flecs::u8_t = ecs_u8_t

Definition at line 21 of file decl.hpp.

◆ Unit

using flecs::Unit = EcsUnit

Definition at line 50 of file decl.hpp.

◆ uptr_t

using flecs::uptr_t = ecs_uptr_t

Definition at line 25 of file decl.hpp.

◆ Vector

using flecs::Vector = EcsVector

Definition at line 49 of file decl.hpp.

Function Documentation

◆ array() [1/4]

template<typename Elem>

untyped_component & array ( int32_t elem_count )

Register array metadata for a component.

Definition at line 108 of file untyped_component.inl.

◆ array() [2/4]

template<typename Elem>

untyped_component & array ( int32_t elem_count )

Register array metadata for a component.

Definition at line 109 of file component.hpp.

◆ array() [3/4]

flecs::entity flecs::world::array	(	flecs::entity_t	elem_id,
		int32_t	array_count )

Create an array type.

Definition at line 117 of file impl.hpp.

◆ array() [4/4]

template<typename T>

flecs::entity flecs::world::array ( int32_t array_count )

Create an array type.

Definition at line 128 of file impl.hpp.

◆ bit() [1/2]

template<typename T = uint32_t>

untyped_component & bit	(	const char *	name,
		T	value )

Add a bitmask constant.

Definition at line 87 of file untyped_component.inl.

◆ bit() [2/2]

template<typename T = uint32_t>

untyped_component & bit	(	const char *	name,
		T	value )

Add a bitmask constant.

Definition at line 88 of file component.hpp.

◆ constant() [1/2]

template<typename T = int32_t>

untyped_component & constant	(	const char *	name,
		T	value )

Add a constant.

Definition at line 66 of file untyped_component.inl.

◆ constant() [2/2]

template<typename T = int32_t>

untyped_component & constant	(	const char *	name,
		T	value )

Add a constant.

Definition at line 67 of file component.hpp.

◆ cursor() [1/2]

flecs::cursor cursor	(	flecs::entity_t	tid,
		void *	ptr )

inline

Return a meta cursor to a value.

Definition at line 15 of file world.hpp.

◆ cursor() [2/2]

template<typename T>

flecs::cursor cursor ( void * ptr )

Return a meta cursor to a value.

Definition at line 21 of file world.hpp.

◆ error_range() [1/2]

template<typename T>

untyped_component & error_range	(	double	min,
		double	max )

Definition at line 127 of file untyped_component.inl.

◆ error_range() [2/2]

untyped_component & error_range	(	double	min,
		double	max )

Definition at line 128 of file component.hpp.

◆ member() [1/12]

template<typename MemberType, typename UnitType = void>

untyped_component & member	(	const char *	name,
		int32_t	count = 0,
		size_t	offset = SIZE_MAX )

Definition at line 34 of file untyped_component.inl.

◆ member() [2/12]

template<typename UnitType, typename MemberType, typename ComponentType, typename RealType = std::remove_extent_t<MemberType>>

untyped_component & member	(	const MemberType ComponentType::*	ptr,
		const char *	name )

Definition at line 60 of file untyped_component.inl.

◆ member() [3/12]

template<typename MemberType, typename ComponentType, typename RealType = std::remove_extent_t<MemberType>>

untyped_component & member	(	const MemberType ComponentType::*	ptr,
		const char *	name,
		flecs::entity_t	unit = 0 )

Definition at line 51 of file untyped_component.inl.

◆ member() [4/12]

template<typename T>

untyped_component & member	(	flecs::entity_t	type_id,
		const char *	name,
		int32_t	count = 0,
		size_t	offset = SIZE_MAX )

Definition at line 27 of file untyped_component.inl.

◆ member() [5/12]

template<typename T>

untyped_component & member	(	flecs::entity_t	type_id,
		flecs::entity_t	unit,
		const char *	name,
		int32_t	count = 0,
		size_t	offset = SIZE_MAX )

Definition at line 13 of file untyped_component.inl.

◆ member() [6/12]

template<typename MemberType>

untyped_component & member	(	flecs::entity_t	unit,
		const char *	name,
		int32_t	count = 0,
		size_t	offset = SIZE_MAX )

Definition at line 43 of file untyped_component.inl.

◆ member() [7/12]

template<typename MemberType, typename UnitType = void>

untyped_component & member	(	const char *	name,
		int32_t	count = 0,
		size_t	offset = SIZE_MAX )

Definition at line 35 of file component.hpp.

◆ member() [8/12]

template<typename UnitType, typename MemberType, typename ComponentType, typename RealType = std::remove_extent_t<MemberType>>

untyped_component & member	(	const MemberType ComponentType::*	ptr,
		const char *	name )

Definition at line 61 of file component.hpp.

◆ member() [9/12]

template<typename MemberType, typename ComponentType, typename RealType = std::remove_extent_t<MemberType>>

untyped_component & member	(	const MemberType ComponentType::*	ptr,
		const char *	name,
		flecs::entity_t	unit = 0 )

Definition at line 52 of file component.hpp.

◆ member() [10/12]

untyped_component & member	(	flecs::entity_t	type_id,
		const char *	name,
		int32_t	count = 0,
		size_t	offset = SIZE_MAX )

Definition at line 28 of file component.hpp.

◆ member() [11/12]

untyped_component & member	(	flecs::entity_t	type_id,
		flecs::entity_t	unit,
		const char *	name,
		int32_t	count = 0,
		size_t	offset = SIZE_MAX )

inline

Definition at line 14 of file component.hpp.

◆ member() [12/12]

template<typename MemberType>

untyped_component & member	(	flecs::entity_t	unit,
		const char *	name,
		int32_t	count = 0,
		size_t	offset = SIZE_MAX )

Definition at line 44 of file component.hpp.

◆ primitive()

flecs::entity flecs::world::primitive ( flecs::meta::primitive_kind_t kind )

Create a primitive type.

Definition at line 108 of file impl.hpp.

◆ quantity() [1/3]

template<typename Self>

const Self & quantity ( ) const

Make an entity a quantity.

Definition at line 85 of file builder.hpp.

◆ quantity() [2/3]

template<typename Self>

template<typename Quantity>

const Self & quantity ( ) const

Add a quantity to a unit.

Definition at line 80 of file builder.hpp.

◆ quantity() [3/3]

template<typename Self>

const Self & quantity ( flecs::entity_t quantity ) const

Add a quantity to a unit.

Definition at line 73 of file builder.hpp.

◆ range() [1/2]

template<typename T>

untyped_component & range	(	double	min,
		double	max )

Definition at line 119 of file untyped_component.inl.

◆ range() [2/2]

untyped_component & range	(	double	min,
		double	max )

Definition at line 120 of file component.hpp.

◆ unit() [1/2]

template<typename Self>

const Self & unit	(	const char *	symbol,
		flecs::entity_t	prefix = 0,
		flecs::entity_t	base = 0,
		flecs::entity_t	over = 0,
		int32_t	factor = 0,
		int32_t	power = 0 ) const

inline

Make an entity a unit.

Definition at line 15 of file builder.hpp.

◆ unit() [2/2]

template<typename Self>

const Self & unit	(	flecs::entity_t	prefix = 0,
		flecs::entity_t	base = 0,
		flecs::entity_t	over = 0,
		int32_t	factor = 0,
		int32_t	power = 0 ) const

Make an entity a derived unit.

Definition at line 37 of file builder.hpp.

◆ unit_prefix()

template<typename Self>

const Self & unit_prefix	(	const char *	symbol,
		int32_t	factor = 0,
		int32_t	power = 0 ) const

Make an entity a unit prefix.

Definition at line 57 of file builder.hpp.

◆ vector() [1/2]

template<typename T>

flecs::entity flecs::world::vector ( )

Create a vector type.

Definition at line 141 of file impl.hpp.

◆ vector() [2/2]

flecs::entity flecs::world::vector ( flecs::entity_t elem_id )

Create a vector type.

Definition at line 132 of file impl.hpp.

◆ warning_range() [1/2]

template<typename T>

untyped_component & warning_range	(	double	min,
		double	max )

Definition at line 123 of file untyped_component.inl.

◆ warning_range() [2/2]

untyped_component & warning_range	(	double	min,
		double	max )

Definition at line 124 of file component.hpp.

Variable Documentation

◆ value

uint32_t flecs::bitmask::value

Definition at line 54 of file decl.hpp.

Classes

Typedefs

Variables

Detailed Description

Typedef Documentation

◆ Array

◆ Bitmask

◆ bitmask_constant_t

◆ bool_t

◆ char_t

◆ Enum

◆ enum_constant_t

◆ f32_t

◆ f64_t

◆ i16_t

◆ i32_t

◆ i64_t

◆ i8_t

◆ iptr_t

◆ Member

◆ member_t

◆ MemberRanges

◆ op_t

◆ Primitive

◆ primitive_kind_t

◆ serialize

◆ serialize_element

◆ serialize_member

◆ serialize_t

◆ serializer

◆ Struct

◆ Type

◆ type_kind_t

◆ TypeSerializer

◆ u16_t

◆ u32_t

◆ u64_t

◆ u8_t

◆ Unit

◆ uptr_t

◆ Vector

Function Documentation

◆ array() [1/4]

◆ array() [2/4]

◆ array() [3/4]

◆ array() [4/4]

◆ bit() [1/2]

◆ bit() [2/2]

◆ constant() [1/2]

◆ constant() [2/2]

◆ cursor() [1/2]

◆ cursor() [2/2]

◆ error_range() [1/2]

◆ error_range() [2/2]

◆ member() [1/12]

◆ member() [2/12]

◆ member() [3/12]

◆ member() [4/12]

◆ member() [5/12]

◆ member() [6/12]

◆ member() [7/12]

◆ member() [8/12]

◆ member() [9/12]

◆ member() [10/12]

◆ member() [11/12]

◆ member() [12/12]

◆ primitive()

◆ quantity() [1/3]

◆ quantity() [2/3]

◆ quantity() [3/3]

◆ range() [1/2]

◆ range() [2/2]

◆ unit() [1/2]

◆ unit() [2/2]

◆ unit_prefix()

◆ vector() [1/2]

◆ vector() [2/2]

◆ warning_range() [1/2]

◆ warning_range() [2/2]

Variable Documentation