LDK_ENTITY_MAX_COMPONENTS

#define LDK_ENTITY_MAX_COMPONENTS 16

LDK_ENTITY_NAME_MAX_LEN

#define LDK_ENTITY_NAME_MAX_LEN 32

LDK_ENTITY_INVALID_COMPONENT_INDEX

#define LDK_ENTITY_INVALID_COMPONENT_INDEX UINT32_MAX

LDKEntity

typedef XHandle LDKEntity;

LDKEntityInternalFlags

typedef enum LDKEntityInternalFlags{
  LDK_ENTITY_INTERNAL_NONE=0,
  LDK_ENTITY_INTERNAL_PENDING_DELETE=1<<0,
  LDK_ENTITY_INTERNAL_HAS_TRANSFORM=1<<1,
  LDK_ENTITY_INTERNAL_HAS_CAMERA=1<<2,
  LDK_ENTITY_INTERNAL_HAS_RENDERABLE=1<<3,
  LDK_ENTITY_INTERNAL_HAS_LIGHT=1<<4,
  LDK_ENTITY_INTERNAL_EDITOR=1<<5
}LDKEntityInternalFlags;

LDKComponentInstanceFlags

Serialized IDs of engine-owned components. These values are persistent: once assigned, a retired ID must not be reused for another component. User component IDs must stay below the engine-reserved high-ID range.

typedef enum LDKComponentInstanceFlags{
  LDK_COMPONENT_INSTANCE_FLAG_NONE=0,
  LDK_COMPONENT_INSTANCE_FLAG_HIDE_IN_EDITOR=1<<0,
  LDK_COMPONENT_INSTANCE_FLAG_DISABLED=1<<1
}LDKComponentInstanceFlags;

LDKBuiltinComponentType

typedef enum LDKBuiltinComponentType{
  LDK_COMPONENT_TYPE_TRANSFORM=UINT32_MAX-1,
  LDK_COMPONENT_TYPE_CAMERA=UINT32_MAX-2,
  LDK_COMPONENT_TYPE_MESH_SOURCE=UINT32_MAX-3,
  LDK_COMPONENT_TYPE_POINT_LIGHT=UINT32_MAX-4,
  LDK_COMPONENT_TYPE_SPOT_LIGHT=UINT32_MAX-5,
  LDK_COMPONENT_TYPE_DIRECTIONAL_LIGHT=UINT32_MAX-6,
  LDK_COMPONENT_TYPE_INSTANCED_MESH_SOURCE=UINT32_MAX-7,
  LDK_COMPONENT_TYPE_PARTICLE_EMITTER=UINT32_MAX-8,
  LDK_COMPONENT_TYPE_POST_PROCESSING=UINT32_MAX-9,
  LDK_COMPONENT_TYPE_TEXT3D=UINT32_MAX-10,
  LDK_COMPONENT_TYPE_AUDIO_SOURCE=UINT32_MAX-11,
  LDK_COMPONENT_TYPE_GRASS_INTERACT=UINT32_MAX-12,
  LDK_COMPONENT_TYPE_TERRAIN_FOLLOWER=UINT32_MAX-14,
  LDK_COMPONENT_TYPE_KEYFRAME_ANIMATION_SOURCE=UINT32_MAX-15,
  LDK_COMPONENT_TYPE_MATERIAL_INSTANCE=UINT32_MAX-16,
}LDKBuiltinComponentType;

LDKComponentDirectory

A list of all components and component types in an entity.

typedef struct LDKComponentDirectory{
  u32 component_type[LDK_ENTITY_MAX_COMPONENTS];
  u32 component_index[LDK_ENTITY_MAX_COMPONENTS];
  u16 component_flags[LDK_ENTITY_MAX_COMPONENTS];
  u16 component_count;
  u16 version;
}LDKComponentDirectory;

LDKComponentRef

Stable reference to a component through its owning entity.

typedef struct LDKComponentRef{
  LDKEntity entity;
  u16 version;
  u16 slot_index;
}LDKComponentRef;

LDKEntityIterFn

Callback visiting an entity during iteration.

typedef bool(*LDKEntityIterFn)(LDKEntity entity, LDKEntityInfo *info, void *user);

LDKEntityRegistry

typedef struct LDKEntityRegistry{
  XHPool pool;
  void(*component_state_changed)(void *user, LDKEntity entity);
  void *component_state_user;
}LDKEntityRegistry;

ldk_entity_module_initialize

Initialize the entity module.

LDK_API bool ldk_entity_module_initialize(
 LDKEntityRegistry *system,
 u32 page_capacity,
 u32 initial_pages
);

ldk_entity_module_terminate

Shut down the entity module.

LDK_API void ldk_entity_module_terminate(LDKEntityRegistry *system);

ldk_entity_module_clear

Clear the state of the entity module.

LDK_API void ldk_entity_module_clear(LDKEntityRegistry *system);

ldk_entity_create

Create the entity.

LDK_API LDKEntity ldk_entity_create(LDKEntityRegistry *system);

ldk_entity_destroy

Destroy the entity.

LDK_API void ldk_entity_destroy(
 LDKEntityRegistry *system,
 LDKEntity entity
);

ldk_entity_is_alive

Check whether the entity refers to a live resource.

LDK_API bool ldk_entity_is_alive(
 LDKEntityRegistry *system,
 LDKEntity entity
);

ldk_entity_info_get

Get the entity info.

LDK_API LDKEntityInfo * ldk_entity_info_get(
 LDKEntityRegistry *system,
 LDKEntity entity
);

ldk_entity_get_info_const

Get read-only information about an entity.

LDK_API const LDKEntityInfo * ldk_entity_get_info_const(
 LDKEntityRegistry *system,
 LDKEntity entity
);

ldk_entity_alive_count

Count the entity alive.

LDK_API u32 ldk_entity_alive_count(LDKEntityRegistry *system);

ldk_entity_flags_set

Set the entity flags.

LDK_API void ldk_entity_flags_set(
 LDKEntityRegistry *system,
 LDKEntity entity,
 u16 flags
);

ldk_entity_flags_get

Get the entity flags.

LDK_API u16 ldk_entity_flags_get(
 LDKEntityRegistry *system,
 LDKEntity entity
);

ldk_entity_flags_add

Add the entity flags.

LDK_API void ldk_entity_flags_add(
 LDKEntityRegistry *system,
 LDKEntity entity,
 u16 flags
);

ldk_entity_flags_remove

Remove the entity flags.

LDK_API void ldk_entity_flags_remove(
 LDKEntityRegistry *system,
 LDKEntity entity,
 u16 flags
);

ldk_entity_flags_has

Check whether an entity has the requested flags.

LDK_API bool ldk_entity_flags_has(
 LDKEntityRegistry *system,
 LDKEntity entity,
 u16 flags
);

ldk_entity_internal_flags_get

Get the entity internal flags.

LDK_API u16 ldk_entity_internal_flags_get(
 LDKEntityRegistry *system,
 LDKEntity entity
);

ldk_entity_internal_flags_has

Check whether an entity has the requested internal flags.

LDK_API bool ldk_entity_internal_flags_has(
 LDKEntityRegistry *system,
 LDKEntity entity,
 u16 flags
);

ldk_entity_name_set

Set the entity name.

LDK_API bool ldk_entity_name_set(
 LDKEntityRegistry *system,
 LDKEntity entity,
 const char *name
);

ldk_entity_name_get

Get the entity name.

LDK_API const char * ldk_entity_name_get(
 LDKEntityRegistry *system,
 LDKEntity entity
);

ldk_entity_name_hash

Compute an entity name hash.

LDK_API u64 ldk_entity_name_hash(const char *name);

ldk_entity_name_hash_set

Set the entity name hash.

LDK_API bool ldk_entity_name_hash_set(
 LDKEntityRegistry *registry,
 LDKEntity entity,
 u64 hash
);

ldk_entity_name_hash_get

Get the entity name hash.

LDK_API u64 ldk_entity_name_hash_get(
 LDKEntityRegistry *registry,
 LDKEntity entity
);

ldk_entity_component_count

Count the entity component.

LDK_API u32 ldk_entity_component_count(
 LDKEntityRegistry *system,
 LDKEntity entity
);

ldk_entity_transform_get

Get the entity transform.

LDK_API LDKTransform * ldk_entity_transform_get(
 LDKEntityRegistry *entity_module,
 LDKComponentRegistry *component_module,
 LDKEntity entity
);

ldk_entity_transform_get_const

Get read-only access to the entity transform.

LDK_API const LDKTransform * ldk_entity_transform_get_const(
 LDKEntityRegistry *entity_module,
 LDKComponentRegistry *component_module,
 LDKEntity entity
);

ldk_entity_component_has

Check whether an entity owns a specific component.

LDK_API bool ldk_entity_component_has(
 LDKEntityRegistry *system,
 LDKEntity entity,
 u32 component_type
);

ldk_entity_component_flags_get

Get the entity component flags.

LDK_API u16 ldk_entity_component_flags_get(
 LDKEntityRegistry *system,
 LDKEntity entity,
 u32 component_type
);

ldk_entity_component_flags_set

Set the entity component flags.

LDK_API bool ldk_entity_component_flags_set(
 LDKEntityRegistry *system,
 LDKEntity entity,
 u32 component_type,
 u16 flags
);

ldk_entity_component_flags_add

Add the entity component flags.

LDK_API bool ldk_entity_component_flags_add(
 LDKEntityRegistry *system,
 LDKEntity entity,
 u32 component_type,
 u16 flags
);

ldk_entity_component_flags_remove

Remove the entity component flags.

LDK_API bool ldk_entity_component_flags_remove(
 LDKEntityRegistry *system,
 LDKEntity entity,
 u32 component_type,
 u16 flags
);

ldk_entity_component_flags_has

Check whether a component instance has requested flags.

LDK_API bool ldk_entity_component_flags_has(
 LDKEntityRegistry *system,
 LDKEntity entity,
 u32 component_type,
 u16 flags
);

ldk_component_ref_is_valid

Check whether the component ref is valid.

LDK_API bool ldk_component_ref_is_valid(
 LDKEntityRegistry *system,
 LDKComponentRef ref
);

ldk_entity_foreach

Visit each living entity using a callback.

LDK_API void ldk_entity_foreach(
 LDKEntityRegistry *system,
 LDKEntityIterFn fn,
 void *user
);

ldk_entity_component_ref_get

Get the entity component ref.

LDK_API bool ldk_entity_component_ref_get(
 LDKEntityRegistry *system,
 LDKEntity entity,
 u32 component_type,
 LDKComponentRef *out_ref
);

ldk_entity_component_find

Find the entity component.

LDK_API bool ldk_entity_component_find(
 LDKEntityRegistry *system,
 LDKEntity entity,
 u32 component_type,
 u32 *out_slot,
 u32 *out_component_index
);

ldk_component_ref_get

Resolve a component reference to its data.

LDK_API void * ldk_component_ref_get(
 LDKEntityRegistry *entity_system,
 struct LDKComponentRegistry *component_registry,
 LDKComponentRef ref
);

ldk_component_ref_get_const

Resolve a component reference as read-only data.

LDK_API const void * ldk_component_ref_get_const(
 LDKEntityRegistry *entity_system,
 struct LDKComponentRegistry *component_registry,
 LDKComponentRef ref
);

ldk_entity_component_add

Add the entity component.

LDK_API void * ldk_entity_component_add(
 LDKEntityRegistry *entity_module,
 LDKComponentRegistry *component_module,
 LDKEntity entity,
 u32 component_type,
 const void *initial_value
);

ldk_entity_component_get

Get the entity component.

LDK_API void * ldk_entity_component_get(
 LDKEntityRegistry *entity_module,
 LDKComponentRegistry *component_module,
 LDKEntity entity,
 u32 component_type
);

ldk_entity_component_remove

Remove the entity component.

LDK_API bool ldk_entity_component_remove(
 LDKEntityRegistry *entity_module,
 LDKComponentRegistry *component_module,
 LDKEntity entity,
 u32 component_type
);

LDKEntityIterator

typedef struct LDKEntityIterator{
  LDKEntityRegistry *registry;
  XHPoolIter iter;
  LDKEntity current;
  u8 has_current;
}LDKEntityIterator;

ldk_entity_iterator_begin

Begin the entity iterator.

LDK_API LDKEntityIterator ldk_entity_iterator_begin(LDKEntityRegistry *registry);

ldk_entity_iterator_next

Advance an entity iterator to the next entity.

LDK_API bool ldk_entity_iterator_next(
 LDKEntityIterator *iterator,
 LDKEntity *out_entity
);

ldk_entity_iterator_end

Finish the entity iterator.

LDK_API void ldk_entity_iterator_end(LDKEntityIterator *iterator);

ldk_entity_internal_flags_set

Set the entity internal flags.

LDK_API void ldk_entity_internal_flags_set(
 LDKEntityRegistry *system,
 LDKEntity entity,
 u16 flags
);

ldk_entity_internal_flags_add

Add the entity internal flags.

LDK_API void ldk_entity_internal_flags_add(
 LDKEntityRegistry *system,
 LDKEntity entity,
 u16 flags
);

ldk_entity_internal_flags_remove

Remove the entity internal flags.

LDK_API void ldk_entity_internal_flags_remove(
 LDKEntityRegistry *system,
 LDKEntity entity,
 u16 flags
);