Flecs v3.1
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. More...
 
ecs_term_tterms_buffer
 For filters with lots of terms an outside array can be provided. More...
 
int32_t terms_buffer_count
 Number of terms in array provided in terms_buffer. More...
 
ecs_filter_tstorage
 External storage to prevent allocation of the filter object. More...
 
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. More...
 
ecs_flags32_t flags
 Flags for advanced usage. More...
 
const char * expr
 Filter expression. More...
 
ecs_entity_t entity
 Entity associated with query (optional) More...
 

Detailed Description

Used with ecs_filter_init.

Definition at line 770 of file flecs.h.

Member Data Documentation

◆ _canary

int32_t ecs_filter_desc_t::_canary

Definition at line 771 of file flecs.h.

◆ entity

ecs_entity_t ecs_filter_desc_t::entity

Entity associated with query (optional)

Definition at line 800 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 797 of file flecs.h.

◆ flags

ecs_flags32_t ecs_filter_desc_t::flags

Flags for advanced usage.

Definition at line 794 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 791 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 784 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 ECS_TERM_DESC_CACHE_SIZE use terms_buffer

Definition at line 775 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 778 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 781 of file flecs.h.


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