Struct in ldk_ecs.h

LDKGroupingDesc

typedef struct LDKGroupingDesc{
  u64 id;
  const char *name;
  const u32 *component_types;
  u32 component_count;
}LDKGroupingDesc;
Function in ldk_ecs.h

ldk_ecs_grouping_at

Get a registered ECS grouping by index.

LDK_API bool ldk_ecs_grouping_at(
 u32 index,
 LDKGroupingDesc *out
);

Parameters

u32 index
Zero-based index of the selected item.
LDKGroupingDesc *out
Output object or buffer receiving the result.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_ecs.h

ldk_ecs_grouping_configure_file

Legacy compatibility no-op. Project [groupings] sections are ignored.

LDK_API bool ldk_ecs_grouping_configure_file(const char *ini_path);

Parameters

const char *ini_path
Path to the INI configuration.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_ecs.h

ldk_ecs_grouping_count

Count the registered ECS group descriptions.

LDK_API u32 ldk_ecs_grouping_count(void);

Returns

Number of matching entries.

Function in ldk_ecs.h

ldk_ecs_grouping_find_by_id

Find a registered ECS grouping by its stable ID.

LDK_API bool ldk_ecs_grouping_find_by_id(
 u64 id,
 LDKGroupingDesc *out
);

Parameters

u64 id
Identifier of the target object.
LDKGroupingDesc *out
Output object or buffer receiving the result.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_ecs.h

ldk_ecs_grouping_get

Get the runtime entity group matching a registered grouping ID.

LDK_API const LDKEntityGroup * ldk_ecs_grouping_get(u64 id);

Parameters

u64 id
Identifier of the target object.

Returns

Pointer to the requested object or data; NULL when unavailable.

Function in ldk_ecs.h

ldk_ecs_grouping_id

Zero means an empty requirement set (or an invalid declaration). Hashes count and sorted unique u32 IDs in fixed little-endian byte order.

LDK_API u64 ldk_ecs_grouping_id(
 const u32 *component_types,
 u32 component_count
);

Parameters

const u32 *component_types
Array of registered ECS component type identifiers.
u32 component_count
Number of component identifiers in the array.

Returns

Computed identifier or hash.

Function in ldk_ecs.h

ldk_ecs_grouping_is_config_defined

True when a grouping originated in the current configuration file.

LDK_API bool ldk_ecs_grouping_is_config_defined(u64 id);

Parameters

u64 id
Identifier of the target object.

Returns

True when the queried condition holds; false otherwise.

Function in ldk_ecs.h

ldk_ecs_grouping_register

Register the ECS grouping.

LDK_API bool ldk_ecs_grouping_register(const LDKGroupingDesc *desc);

Parameters

const LDKGroupingDesc *desc
Description or configuration for this operation.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_ecs.h

ldk_ecs_grouping_runtime_reset

Clear all runtime membership state for registered Entity Groups while preserving their definitions. Intended for full scene/ECS entity resets.

LDK_API bool ldk_ecs_grouping_runtime_reset(void);

Returns

True if the operation succeeds; false otherwise.

Function in ldk_ecs.h

ldk_ecs_grouping_unregister

Unregister the ECS grouping.

LDK_API bool ldk_ecs_grouping_unregister(u64 id);

Parameters

u64 id
Identifier of the target object.

Returns

True if the operation succeeds; false otherwise.