Flecs v3.2
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
ecs_filter_desc_t Struct Reference

Used with ecs_filter_init(). More...

#include <flecs.h>

Public Attributes

int32_t _canary
 
ecs_term_t terms [(16)]
 Terms of the filter.
 
ecs_term_tterms_buffer
 For filters with lots of terms an outside array can be provided.
 
int32_t terms_buffer_count
 Number of terms in array provided in terms_buffer.
 
ecs_filter_tstorage
 External storage to prevent allocation of the filter object.
 
bool instanced
 When true, terms returned by an iterator may either contain 1 or N elements, where terms with N elements are owned, and terms with 1 element are shared, for example from a parent or base entity.
 
ecs_flags32_t flags
 Flags for advanced usage.
 
const char * expr
 Filter expression.
 
ecs_entity_t entity
 Entity associated with query (optional)
 

Detailed Description

Used with ecs_filter_init().

Definition at line 983 of file flecs.h.

Member Data Documentation

◆ _canary

int32_t ecs_filter_desc_t::_canary

Definition at line 984 of file flecs.h.

◆ entity

ecs_entity_t ecs_filter_desc_t::entity

Entity associated with query (optional)

Definition at line 1013 of file flecs.h.

◆ expr

const char* ecs_filter_desc_t::expr

Filter expression.

Should not be set at the same time as terms array

Definition at line 1010 of file flecs.h.

◆ flags

ecs_flags32_t ecs_filter_desc_t::flags

Flags for advanced usage.

Definition at line 1007 of file flecs.h.

◆ instanced

bool ecs_filter_desc_t::instanced

When true, terms returned by an iterator may either contain 1 or N elements, where terms with N elements are owned, and terms with 1 element are shared, for example from a parent or base entity.

When false, the iterator will at most return 1 element when the result contains both owned and shared terms.

Definition at line 1004 of file flecs.h.

◆ storage

ecs_filter_t* ecs_filter_desc_t::storage

External storage to prevent allocation of the filter object.

Definition at line 997 of file flecs.h.

◆ terms

ecs_term_t ecs_filter_desc_t::terms[(16)]

Terms of the filter.

If a filter has more terms than FLECS_TERM_DESC_MAX use terms_buffer

Definition at line 988 of file flecs.h.

◆ terms_buffer

ecs_term_t* ecs_filter_desc_t::terms_buffer

For filters with lots of terms an outside array can be provided.

Definition at line 991 of file flecs.h.

◆ terms_buffer_count

int32_t ecs_filter_desc_t::terms_buffer_count

Number of terms in array provided in terms_buffer.

Definition at line 994 of file flecs.h.


The documentation for this struct was generated from the following file: