LDKSceneSystems

struct LDKSceneSystems;

LDK_SCENE_TML_VERSION

#define LDK_SCENE_TML_VERSION 1

LDK_SCENE_NULL_ENTITY_ID

#define LDK_SCENE_NULL_ENTITY_ID(-1)

LDKScene

Entry in the Scene Manager catalog. Scene pointers returned by the Scene Manager refer to its internal catalog and remain valid until the catalog is overridden or the manager is terminated.

typedef struct LDKScene{
  LDKAssetPath path;
  XSmallstr name;
  u32 index;
}LDKScene;

LDKSceneProperties

typedef struct LDKSceneProperties{
  rgba32 ambient_color;
  float ambient_intensity;
}LDKSceneProperties;

LDKSceneResult

typedef struct LDKSceneResult{
  bool ok;
  char error[256];
}LDKSceneResult;

ldk_scene_properties_defaults

Set default values for scene properties.

LDK_API void ldk_scene_properties_defaults(LDKSceneProperties *properties);

ldk_scene_properties_get

Get the scene properties.

LDK_API const LDKSceneProperties * ldk_scene_properties_get(void);

ldk_scene_properties_set

Set the scene properties.

LDK_API bool ldk_scene_properties_set(const LDKSceneProperties *properties);

ldk_scene_properties_reset

Reset the state of the scene properties.

LDK_API void ldk_scene_properties_reset(void);

ldk_scene_result_clear

Clear the state of the scene result.

LDK_API void ldk_scene_result_clear(LDKSceneResult *result);

ldk_scene_result_set_error

Store a scene diagnostic message in the result.

LDK_API void ldk_scene_result_set_error(
 LDKSceneResult *result,
 const char *error
);

LDKSceneDiagnosticFn

Callback for reporting a scene diagnostic.

typedef void(*LDKSceneDiagnosticFn)(const char *message, void *user);

ldk_scene_diagnostic_handler_set

Set the scene diagnostic handler.

LDK_API void ldk_scene_diagnostic_handler_set(
 LDKSceneDiagnosticFn handler,
 void *user
);

ldk_scene_from_tml

Loads entities and components from a TML string into the current ECS. This function does not clear existing entities and does not roll back entities created before an error. A caller performing a full scene replace is responsible for clearing the ECS before the call and after a failed call.

LDK_API bool ldk_scene_from_tml(
 const char *source,
 LDKSceneResult *result
);

ldk_scene_load_tml_file

Reads a TML file and loads it into the current ECS. This function has the same ECS ownership semantics as ldk_scene_from_tml().

LDK_API bool ldk_scene_load_tml_file(
 const char *path,
 LDKSceneResult *result
);

ldk_scene_from_tml_with_systems

Load entities and scene-owned system data together, resolving references with the same entity map. Systems is initialized with {0}; on failure its previous contents are unchanged. The caller owns ECS cleanup on failure, and must stop old systems before replacing a scene. No initialize runs.

LDK_API bool ldk_scene_from_tml_with_systems(
 const char *source,
 struct LDKSceneSystems *systems,
 LDKSceneResult *result
);

ldk_scene_load_tml_file_with_systems

Load scene TML file with systems.

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

ldk_scene_to_tml_with_systems

Serialize a scene and its system configuration to TML.

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

ldk_scene_to_tml

Serializes the current ECS contents to TML.

LDK_API bool ldk_scene_to_tml(
 XStrBuilder *out,
 LDKSceneResult *result
);

ldk_scene_save_tml_file

Serializes the current ECS contents and writes them to a TML file.

LDK_API bool ldk_scene_save_tml_file(
 const char *path,
 LDKSceneResult *result
);

ldk_scene_component_meta_runtime_type

Resolve the runtime component type for reflected scene metadata.

LDK_API u32 ldk_scene_component_meta_runtime_type(const LDKComponentMeta *meta);

ldk_scene_component_meta_find_by_type

Find serialized component metadata for a runtime type.

LDK_API const LDKComponentMeta * ldk_scene_component_meta_find_by_type(
 LDKGame *game,
 u32 component_type
);

ldk_scene_component_field_find

Find the scene component field.

LDK_API const LDKComponentFieldMeta * ldk_scene_component_field_find(
 const LDKComponentMeta *meta,
 const char *field_name
);

ldk_scene_component_field_is_serializable

Check whether a component field may be saved in a scene.

LDK_API bool ldk_scene_component_field_is_serializable(
 const LDKComponentMeta *meta,
 const LDKComponentFieldMeta *field
);