Skip to content
Flecs v4.2
Iterator API

Macros

#define ecs_field(it, T, index)
 Get field data for a component.
#define ecs_base_field(it, T, index)
 Get field data for a component matched through component inheritance.
#define ecs_field_self(it, T, index)
 Get field data for a self-owned component.
#define ecs_field_at(it, T, index, row)
 Get field data at a specific row.

Detailed Description

Macro Definition Documentation

◆ ecs_base_field

#define ecs_base_field ( it,
T,
index )
Value:
(ECS_CAST(T*, ecs_base_field_w_size(it, sizeof(T), index)))
void * ecs_base_field_w_size(const ecs_iter_t *it, size_t size, int8_t index)
Get data for a field matched through component inheritance.

Get field data for a component matched through component inheritance.

Use this instead of ecs_field() when a field is matched on a component that is derived from the queried (base) type. The data must be iterated with the stride returned by ecs_field_stride().

Definition at line 702 of file flecs_c.h.

◆ ecs_field

#define ecs_field ( it,
T,
index )
Value:
(ECS_CAST(T*, ecs_field_w_size(it, sizeof(T), index)))
void * ecs_field_w_size(const ecs_iter_t *it, size_t size, int8_t index)
Get data for a field.

Get field data for a component.

Definition at line 695 of file flecs_c.h.

◆ ecs_field_at

#define ecs_field_at ( it,
T,
index,
row )
Value:
(ECS_CAST(T*, ecs_field_at_w_size(it, sizeof(T), index, row)))
void * ecs_field_at_w_size(const ecs_iter_t *it, size_t size, int8_t index, int32_t row)
Get data for a field at a specified row.

Get field data at a specific row.

Definition at line 710 of file flecs_c.h.

◆ ecs_field_self

#define ecs_field_self ( it,
T,
index )
Value:
(ECS_CAST(T*, ecs_field_self_w_size(it, sizeof(T), index)))

Get field data for a self-owned component.

Definition at line 706 of file flecs_c.h.