ldk_scene_systems.h

home

Scene system configuration

System associations stored in a scene file.

Function in ldk_scene_systems.h

ldk_scene_systems_clear

Stop and unbind owned data instances before releasing their memory. Do not call while the registry is executing a callback.

LDK_API void ldk_scene_systems_clear(LDKSceneSystems *systems);

Parameters

LDKSceneSystems *systems
Scene systems configuration being read or written.
Function in ldk_scene_systems.h

ldk_scene_systems_contains

Test whether the scene systems contains the requested value.

LDK_API bool ldk_scene_systems_contains(
 const LDKSceneSystems *systems,
 u64 id
);

Parameters

const LDKSceneSystems *systems
Scene systems configuration being read or written.
u64 id
Identifier of the target object.

Returns

True when the queried condition holds; false otherwise.

Function in ldk_scene_systems.h

ldk_scene_systems_add

Adds a system and allocates its data when registered.

LDK_API bool ldk_scene_systems_add(
 LDKSceneSystems *systems,
 u64 id
);

Parameters

LDKSceneSystems *systems
Scene systems configuration being read or written.
u64 id
Identifier of the target object.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_scene_systems.h

ldk_scene_systems_add_with_grouping

Deprecated: grouping_id is ignored.

LDK_API bool ldk_scene_systems_add_with_grouping(
 LDKSceneSystems *systems,
 u64 id,
 u64 grouping_id
);

Parameters

LDKSceneSystems *systems
Scene systems configuration being read or written.
u64 id
Identifier of the target object.
u64 grouping_id
Identifier of the grouping.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_scene_systems.h

ldk_scene_systems_remove

Remove the scene systems.

LDK_API bool ldk_scene_systems_remove(
 LDKSceneSystems *systems,
 u64 id
);

Parameters

LDKSceneSystems *systems
Scene systems configuration being read or written.
u64 id
Identifier of the target object.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_scene_systems.h

ldk_scene_systems_grouping_set

Deprecated: validates membership only; grouping_id is ignored.

LDK_API bool ldk_scene_systems_grouping_set(
 LDKSceneSystems *systems,
 u64 system_id,
 u64 grouping_id
);

Parameters

LDKSceneSystems *systems
Scene systems configuration being read or written.
u64 system_id
Identifier of the system.
u64 grouping_id
Identifier of the grouping.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_scene_systems.h

ldk_scene_systems_grouping_get

Returns the registered system requirement hash, or zero if unavailable.

LDK_API u64 ldk_scene_systems_grouping_get(
 const LDKSceneSystems *systems,
 u64 system_id
);

Parameters

const LDKSceneSystems *systems
Scene systems configuration being read or written.
u64 system_id
Identifier of the system.

Returns

The resulting numeric value.

Function in ldk_scene_systems.h

ldk_scene_systems_prepare

Allocate zero-initialized data for registered systems. No callbacks run. Existing instances keep their values; a descriptor size change is rejected.

LDK_API bool ldk_scene_systems_prepare(
 LDKSystemRegistry *registry,
 LDKSceneSystems *systems
);

Parameters

LDKSystemRegistry *registry
Registry on which the operation is performed.
LDKSceneSystems *systems
Scene systems configuration being read or written.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_scene_systems.h

ldk_scene_systems_data_get

Get the scene systems data.

LDK_API void * ldk_scene_systems_data_get(
 const LDKSceneSystems *systems,
 u64 system_id
);

Parameters

const LDKSceneSystems *systems
Scene systems configuration being read or written.
u64 system_id
Identifier of the system.

Returns

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

Function in ldk_scene_systems.h

ldk_scene_systems_from_tml

Reads the optional scene.systems node without creating ECS entities. This is association preflight only; use ldk_scene_from_tml_with_systems or ldk_scene_load_tml_file_with_systems to load fields and entity references. An absent node produces an empty list. On failure, out is unchanged. Accepted ids are positive signed integers or strings representing u64s. The writer uses quoted hexadecimal strings to support the full u64 range. Legacy grouping entries are ignored. scene: systems: - id: "0x0000000000000100"

LDK_API bool ldk_scene_systems_from_tml(
 const char *source,
 LDKSceneSystems *out,
 LDKSceneResult *result
);

Parameters

const char *source
Source object or source data for this operation.
LDKSceneSystems *out
Output object or buffer receiving the result.
LDKSceneResult *result
Optional result structure populated with error details.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_scene_systems.h

ldk_scene_systems_load_tml_file

Load scene system settings from a TML file.

LDK_API bool ldk_scene_systems_load_tml_file(
 const char *path,
 LDKSceneSystems *out,
 LDKSceneResult *result
);

Parameters

const char *path
Path identifying the file or resource.
LDKSceneSystems *out
Output object or buffer receiving the result.
LDKSceneResult *result
Optional result structure populated with error details.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_scene_systems.h

ldk_scene_systems_validate_bindings

Validate registered system/grouping bindings without changing runtime state.

LDK_API bool ldk_scene_systems_validate_bindings(
 LDKSystemRegistry *registry,
 const LDKSceneSystems *systems
);

Parameters

LDKSystemRegistry *registry
Registry on which the operation is performed.
const LDKSceneSystems *systems
Scene systems configuration being read or written.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_scene_systems.h

ldk_scene_systems_stop_missing

Stop systems not present in the requested scene configuration.

LDK_API bool ldk_scene_systems_stop_missing(
 LDKSystemRegistry *registry,
 const LDKSceneSystems *systems
);

Parameters

LDKSystemRegistry *registry
Registry on which the operation is performed.
const LDKSceneSystems *systems
Scene systems configuration being read or written.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_scene_systems.h

ldk_scene_systems_to_tml

Serializes the current ECS and the supplied scene associations. The existing entity serializer remains responsible for entities/components.

LDK_API bool ldk_scene_systems_to_tml(
 XStrBuilder *out,
 const LDKSceneSystems *systems,
 LDKSceneResult *result
);

Parameters

XStrBuilder *out
Output object or buffer receiving the result.
const LDKSceneSystems *systems
Scene systems configuration being read or written.
LDKSceneResult *result
Optional result structure populated with error details.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_scene_systems.h

ldk_scene_systems_save_tml_file

Write scene system settings to a TML file.

LDK_API bool ldk_scene_systems_save_tml_file(
 const char *path,
 const LDKSceneSystems *systems,
 LDKSceneResult *result
);

Parameters

const char *path
Path identifying the file or resource.
const LDKSceneSystems *systems
Scene systems configuration being read or written.
LDKSceneResult *result
Optional result structure populated with error details.

Returns

True if the operation succeeds; false otherwise.