Struct in ldk_project.h

LDKProjectCreateDesc

typedef struct LDKProjectCreateDesc{
  const char *project_name;
  const char *project_root_path;
  const char *cmake_generator;
  const char *cmake_arch;
}LDKProjectCreateDesc;
Struct in ldk_project.h

LDKProjectBuildDesc

typedef struct LDKProjectBuildDesc{
  const char *cmake_path;
  const char *ldk_root_path;
  const char *config;
  bool new_console;
}LDKProjectBuildDesc;
Struct in ldk_project.h

LDKProject

typedef struct LDKProject{
  bool loaded;
  bool play_current_scene;
  bool build_on_play;
  XSmallstr name;
  XSmallstr game_name;
  XSmallstr build_config;
  XSmallstr cmake_generator;
  XSmallstr cmake_arch;
  XFSPath icon_path;
  XFSPath assets_path;
  XFSPath cache_path;
  XFSPath cmake_root_path;
  XFSPath game_cmake_path;
  XFSPath game_dll_path;
  XFSPath project_file_path;
  XFSPath project_root_path;
  XFSPath run_root_path;
  XFSPath runtime_ini_path;
  XFSPath source_root_path;
  i32 project_resolution_width;
  i32 project_resolution_height;
  u32 shadow_map_resolution;
  float shadow_distance;
}LDKProject;
Typedef in ldk_project.h

LDKProjectDiagnosticFn

Callback for reporting a project diagnostic.

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

Parameters

message
Message displayed to the user.
user
Opaque caller-supplied data passed to the callback.
Function in ldk_project.h

ldk_project_diagnostic_handler_set

Set the project diagnostic handler.

LDK_API void ldk_project_diagnostic_handler_set(
 LDKProjectDiagnosticFn handler,
 void *user
);

Parameters

LDKProjectDiagnosticFn handler
Handler called for the corresponding event or diagnostic.
void *user
Opaque caller-supplied data passed to the callback.
Function in ldk_project.h

ldk_project_load

Load the project.

LDK_API bool ldk_project_load(
 LDKProject *project,
 const char *project_file_path
);

Parameters

LDKProject *project
Project whose settings or files are used.
const char *project_file_path
Path to the LDK project manifest.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_project.h

ldk_project_save

Save the project.

LDK_API bool ldk_project_save(LDKProject *project);

Parameters

LDKProject *project
Project whose settings or files are used.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_project.h

ldk_project_write_runtime_ini

Write project runtime INI.

LDK_API bool ldk_project_write_runtime_ini(const LDKProject *project);

Parameters

const LDKProject *project
Project whose settings or files are used.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_project.h

ldk_project_scene_catalog_save

Replace only [scenes] and export public sections. No ECS operations.

LDK_API bool ldk_project_scene_catalog_save(
 const LDKProject *project,
 const LDKScene *scenes,
 u32 count,
 LDKSceneResult *result
);

Parameters

const LDKProject *project
Project whose settings or files are used.
const LDKScene *scenes
Scenes used by this operation.
u32 count
Number of items to process.
LDKSceneResult *result
Optional result structure populated with error details.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_project.h

ldk_project_generate_game_module

Generate build files for a game module.

LDK_API bool ldk_project_generate_game_module(
 const LDKProject *project,
 const LDKProjectBuildDesc *desc
);

Parameters

const LDKProject *project
Project whose settings or files are used.
const LDKProjectBuildDesc *desc
Description or configuration for this operation.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_project.h

ldk_project_build_game_module

Build the project game module.

LDK_API bool ldk_project_build_game_module(
 const LDKProject *project,
 const LDKProjectBuildDesc *desc
);

Parameters

const LDKProject *project
Project whose settings or files are used.
const LDKProjectBuildDesc *desc
Description or configuration for this operation.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_project.h

ldk_project_generate_game_launcher

Generate build files for the standalone game launcher.

LDK_API bool ldk_project_generate_game_launcher(
 const LDKProject *project,
 const LDKProjectBuildDesc *desc
);

Parameters

const LDKProject *project
Project whose settings or files are used.
const LDKProjectBuildDesc *desc
Description or configuration for this operation.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_project.h

ldk_project_build_game_launcher

Build the standalone game launcher.

LDK_API bool ldk_project_build_game_launcher(
 const LDKProject *project,
 const LDKProjectBuildDesc *desc
);

Parameters

const LDKProject *project
Project whose settings or files are used.
const LDKProjectBuildDesc *desc
Description or configuration for this operation.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_project.h

ldk_project_generate_game_module_start

Start the project generate game module.

LDK_API LDKOSProcess * ldk_project_generate_game_module_start(
 const LDKProject *project,
 const LDKProjectBuildDesc *desc,
 LDKOSProcessResult *out_result
);

Parameters

const LDKProject *project
Project whose settings or files are used.
const LDKProjectBuildDesc *desc
Description or configuration for this operation.
LDKOSProcessResult *out_result
Receives additional status or diagnostic information.

Returns

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

Function in ldk_project.h

ldk_project_build_game_module_start

Start the project build game module.

LDK_API LDKOSProcess * ldk_project_build_game_module_start(
 const LDKProject *project,
 const LDKProjectBuildDesc *desc,
 LDKOSProcessResult *out_result
);

Parameters

const LDKProject *project
Project whose settings or files are used.
const LDKProjectBuildDesc *desc
Description or configuration for this operation.
LDKOSProcessResult *out_result
Receives additional status or diagnostic information.

Returns

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

Function in ldk_project.h

ldk_project_clean_game_module_start

Start the project clean game module.

LDK_API LDKOSProcess * ldk_project_clean_game_module_start(
 const LDKProject *project,
 const LDKProjectBuildDesc *desc,
 LDKOSProcessResult *out_result
);

Parameters

const LDKProject *project
Project whose settings or files are used.
const LDKProjectBuildDesc *desc
Description or configuration for this operation.
LDKOSProcessResult *out_result
Receives additional status or diagnostic information.

Returns

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

Function in ldk_project.h

ldk_project_generate_game_launcher_start

Start the project generate game launcher.

LDK_API LDKOSProcess * ldk_project_generate_game_launcher_start(
 const LDKProject *project,
 const LDKProjectBuildDesc *desc,
 LDKOSProcessResult *out_result
);

Parameters

const LDKProject *project
Project whose settings or files are used.
const LDKProjectBuildDesc *desc
Description or configuration for this operation.
LDKOSProcessResult *out_result
Receives additional status or diagnostic information.

Returns

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

Function in ldk_project.h

ldk_project_build_game_launcher_start

Start the project build game launcher.

LDK_API LDKOSProcess * ldk_project_build_game_launcher_start(
 const LDKProject *project,
 const LDKProjectBuildDesc *desc,
 LDKOSProcessResult *out_result
);

Parameters

const LDKProject *project
Project whose settings or files are used.
const LDKProjectBuildDesc *desc
Description or configuration for this operation.
LDKOSProcessResult *out_result
Receives additional status or diagnostic information.

Returns

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

Function in ldk_project.h

ldk_project_game_module_output_path_get

Get the project game module output path.

LDK_API bool ldk_project_game_module_output_path_get(
 const LDKProject *project,
 const char *config,
 XFSPath *out_path
);

Parameters

const LDKProject *project
Project whose settings or files are used.
const char *config
Configuration for this operation.
XFSPath *out_path
Receives the resulting path.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_project.h

ldk_project_game_launcher_output_path_get

Get the project game launcher output path.

LDK_API bool ldk_project_game_launcher_output_path_get(
 const LDKProject *project,
 const char *config,
 XFSPath *out_path
);

Parameters

const LDKProject *project
Project whose settings or files are used.
const char *config
Configuration for this operation.
XFSPath *out_path
Receives the resulting path.

Returns

True if the operation succeeds; false otherwise.