Used with ecs_query_init().
More...
#include <flecs.h>
Used with ecs_query_init().
Definition at line 1201 of file flecs.h.
◆ _canary
int32_t ecs_query_desc_t::_canary |
Used for validity testing.
Must be 0.
Definition at line 1203 of file flecs.h.
◆ binding_ctx
void* ecs_query_desc_t::binding_ctx |
Context to be used for language bindings.
Definition at line 1259 of file flecs.h.
◆ binding_ctx_free
Callback to free binding_ctx.
Definition at line 1265 of file flecs.h.
◆ cache_kind
Caching policy of query.
Definition at line 1212 of file flecs.h.
◆ ctx
void* ecs_query_desc_t::ctx |
User context to pass to callback.
Definition at line 1256 of file flecs.h.
◆ ctx_free
Callback to free ctx.
Definition at line 1262 of file flecs.h.
◆ entity
Entity associated with query (optional)
Definition at line 1268 of file flecs.h.
◆ expr
const char* ecs_query_desc_t::expr |
Query DSL expression (optional)
Definition at line 1209 of file flecs.h.
◆ flags
ecs_flags32_t ecs_query_desc_t::flags |
Flags for enabling query features.
Definition at line 1215 of file flecs.h.
◆ group_by
Component id to be used for grouping.
Used together with the group_by_callback.
Definition at line 1232 of file flecs.h.
◆ group_by_callback
Callback used for grouping results.
If the callback is not set, results will not be grouped. When set, this callback will be used to calculate a "rank" for each entity (table) based on its components. This rank is then used to sort entities (tables), so that entities (tables) of the same rank are "grouped" together when iterated.
Definition at line 1239 of file flecs.h.
◆ group_by_ctx
void* ecs_query_desc_t::group_by_ctx |
Context to pass to group_by.
Definition at line 1250 of file flecs.h.
◆ group_by_ctx_free
Function to free group_by_ctx.
Definition at line 1253 of file flecs.h.
◆ on_group_create
Callback that is invoked when a new group is created.
The return value of the callback is stored as context for a group.
Definition at line 1243 of file flecs.h.
◆ on_group_delete
Callback that is invoked when an existing group is deleted.
The return value of the on_group_create callback is passed as context parameter.
Definition at line 1247 of file flecs.h.
◆ order_by
Component to sort on, used together with order_by_callback or order_by_table_callback.
Definition at line 1228 of file flecs.h.
◆ order_by_callback
Callback used for ordering query results.
If order_by_id is 0, the pointer provided to the callback will be NULL. If the callback is not set, results will not be ordered.
Definition at line 1220 of file flecs.h.
◆ order_by_table_callback
Callback used for ordering query results.
Same as order_by_callback, but more efficient.
Definition at line 1224 of file flecs.h.
◆ terms
The documentation for this struct was generated from the following file: