Query descriptor types.

Types used to describe queries. More...

Collaboration diagram for Query descriptor types.:

Classes
struct	ecs_term_ref_t
	Type that describes a reference to an entity or variable in a term. More...
struct	ecs_term_t
	Type that describes a term (single element in a query). More...
struct	ecs_query_t
	Queries are lists of constraints (terms) that match entities. More...
struct	ecs_observer_t
	An observer reacts to events matching a query. More...

Typedefs
typedef enum ecs_inout_kind_t	ecs_inout_kind_t
	Specify read/write access for term.
typedef enum ecs_oper_kind_t	ecs_oper_kind_t
	Specify operator for term.
typedef enum ecs_query_cache_kind_t	ecs_query_cache_kind_t
	Specify cache policy for query.
typedef struct ecs_term_ref_t	ecs_term_ref_t
	Type that describes a reference to an entity or variable in a term.

Enumerations
enum	ecs_inout_kind_t {   EcsInOutDefault , EcsInOutNone , EcsInOutFilter , EcsInOut ,   EcsIn , EcsOut }
	Specify read/write access for term. More...
enum	ecs_oper_kind_t {   EcsAnd , EcsOr , EcsNot , EcsOptional ,   EcsAndFrom , EcsOrFrom , EcsNotFrom }
	Specify operator for term. More...
enum	ecs_query_cache_kind_t { EcsQueryCacheDefault , EcsQueryCacheAuto , EcsQueryCacheAll , EcsQueryCacheNone }
	Specify cache policy for query. More...

Detailed Description

Types used to describe queries.

Enumeration Type Documentation

ecs_inout_kind_t

enum ecs_inout_kind_t

Specify read/write access for term.

Enumerator
EcsInOutDefault	InOut for regular terms, In for shared terms.
EcsInOutNone	Term is neither read nor written.
EcsInOutFilter	Same as InOutNone + prevents term from triggering observers.
EcsInOut	Term is both read and written.
EcsIn	Term is only read.
EcsOut	Term is only written.

Definition at line 683 of file flecs.h.

ecs_oper_kind_t

enum ecs_oper_kind_t

Specify operator for term.

Enumerator
EcsAnd	The term must match.
EcsOr	One of the terms in an or chain must match.
EcsNot	The term must not match.
EcsOptional	The term may match.
EcsAndFrom	Term must match all components from term id.
EcsOrFrom	Term must match at least one component from term id.
EcsNotFrom	Term must match none of the components from term id.

Definition at line 693 of file flecs.h.

ecs_query_cache_kind_t

enum ecs_query_cache_kind_t

Specify cache policy for query.

Enumerator
EcsQueryCacheDefault	Behavior determined by query creation context.
EcsQueryCacheAuto	Cache query terms that are cacheable.
EcsQueryCacheAll	Require that all query terms can be cached.
EcsQueryCacheNone	No caching.

Definition at line 704 of file flecs.h.