Used with ecs_query_init.
More...
#include <flecs.h>
Used with ecs_query_init.
Definition at line 998 of file flecs.h.
◆ _canary
int32_t ecs_query_desc_t::_canary |
◆ binding_ctx
void* ecs_query_desc_t::binding_ctx |
Context to be used for language bindings.
Definition at line 1054 of file flecs.h.
◆ binding_ctx_free
Callback to free binding_ctx.
Definition at line 1060 of file flecs.h.
◆ ctx
void* ecs_query_desc_t::ctx |
User context to pass to callback.
Definition at line 1051 of file flecs.h.
◆ ctx_free
Callback to free ctx.
Definition at line 1057 of file flecs.h.
◆ filter
Filter for the query.
Definition at line 1002 of file flecs.h.
◆ group_by
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 1026 of file flecs.h.
◆ group_by_ctx
void* ecs_query_desc_t::group_by_ctx |
Context to pass to group_by.
Definition at line 1037 of file flecs.h.
◆ group_by_ctx_free
Function to free group_by_ctx.
Definition at line 1040 of file flecs.h.
◆ group_by_id
Id to be used by group_by.
This id is passed to the group_by function and can be used identify the part of an entity type that should be used for grouping.
Definition at line 1019 of file flecs.h.
◆ on_group_create
ecs_group_create_action_t ecs_query_desc_t::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 1030 of file flecs.h.
◆ on_group_delete
ecs_group_delete_action_t ecs_query_desc_t::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 1034 of file flecs.h.
◆ order_by
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 1010 of file flecs.h.
◆ order_by_component
Component to be used by order_by.
Definition at line 1005 of file flecs.h.
◆ parent
If set, the query will be created as a subquery.
A subquery matches at most a subset of its parent query. Subqueries do not directly receive (table) notifications from the world. Instead parent queries forward results to subqueries. This can improve matching performance, as fewer queries need to be matched with new tables. Subqueries can be nested.
Definition at line 1048 of file flecs.h.
◆ sort_table
Callback used for ordering query results.
Same as order_by, but more efficient.
Definition at line 1014 of file flecs.h.
The documentation for this struct was generated from the following file: