Enum in ldk_system.h

LDKBuiltinSystemId

IDs of builtin systems.

typedef enum LDKBuiltinSystemId{
  LDK_SYSTEM_ID_SCENEGRAPH=0x1,
  LDK_SYSTEM_ID_USER=0x100
}LDKBuiltinSystemId;
Enum in ldk_system.h

LDKSystemFlags

typedef enum LDKSystemFlags{
  LDK_SYSTEM_FLAG_NONE=0,
  LDK_SYSTEM_FLAG_ENABLED=1<<0,
  LDK_SYSTEM_FLAG_ENGINE_NATIVE=1<<1,
  LDK_SYSTEM_FLAG_RUN_WHEN_PAUSED=1<<2
}LDKSystemFlags;
Struct in ldk_system.h

LDKSystemRegistry

typedef struct LDKSystemRegistry{
  void *internal;
  struct LDKRoot *root;
  u8 is_initialized;
  u8 is_started;
  u8 is_paused;
}LDKSystemRegistry;
Function in ldk_system.h

ldk_engine_system_descriptor_count

Descriptors for systems implemented by the engine. Games own registration.

LDK_API u32 ldk_engine_system_descriptor_count(void);

Returns

Number of matching entries.

Function in ldk_system.h

ldk_engine_system_descriptor_get

Get the engine system descriptor.

LDK_API bool ldk_engine_system_descriptor_get(
 u32 index,
 LDKSystemDesc *out
);

Parameters

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

Returns

True if the operation succeeds; false otherwise.

Function in ldk_system.h

ldk_system_registry_at

Get a system registered at a particular index.

LDK_API bool ldk_system_registry_at(
 const LDKSystemRegistry *registry,
 u32 index,
 LDKSystemDesc *out
);

Parameters

const LDKSystemRegistry *registry
Registry on which the operation is performed.
u32 index
Zero-based index of the selected item.
LDKSystemDesc *out
Output object or buffer receiving the result.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_system.h

ldk_system_registry_clear

Clear the state of the system registry.

LDK_API bool ldk_system_registry_clear(LDKSystemRegistry *registry);

Parameters

LDKSystemRegistry *registry
Registry on which the operation is performed.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_system.h

ldk_system_registry_count

Count registered systems.

LDK_API u32 ldk_system_registry_count(const LDKSystemRegistry *registry);

Parameters

const LDKSystemRegistry *registry
Registry on which the operation is performed.

Returns

Number of matching entries.

Function in ldk_system.h

ldk_system_registry_find_by_id

Find a registered system by its stable ID.

LDK_API bool ldk_system_registry_find_by_id(
 LDKSystemRegistry *registry,
 u64 id,
 LDKSystemDesc *out
);

Parameters

LDKSystemRegistry *registry
Registry on which the operation is performed.
u64 id
Identifier of the target object.
LDKSystemDesc *out
Output object or buffer receiving the result.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_system.h

ldk_system_registry_has

Check whether a system ID is registered.

LDK_API bool ldk_system_registry_has(
 const LDKSystemRegistry *registry,
 u64 id
);

Parameters

const LDKSystemRegistry *registry
Registry on which the operation is performed.
u64 id
Identifier of the target object.

Returns

True when the queried condition holds; false otherwise.

Function in ldk_system.h

ldk_system_registry_initialize

Initialize the system registry.

LDK_API bool ldk_system_registry_initialize(LDKSystemRegistry *registry);

Parameters

LDKSystemRegistry *registry
Registry on which the operation is performed.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_system.h

ldk_system_registry_is_busy

True while a bucket or a system lifecycle callback is executing.

LDK_API bool ldk_system_registry_is_busy(const LDKSystemRegistry *registry);

Parameters

const LDKSystemRegistry *registry
Registry on which the operation is performed.

Returns

True when the queried condition holds; false otherwise.

Function in ldk_system.h

ldk_system_registry_register

Register the system registry.

LDK_API bool ldk_system_registry_register(
 LDKSystemRegistry *registry,
 const LDKSystemDesc *desc
);

Parameters

LDKSystemRegistry *registry
Registry on which the operation is performed.
const LDKSystemDesc *desc
Description or configuration for this operation.

Returns

True if the operation succeeds; false otherwise.

Function in ldk_system.h

ldk_system_registry_unregister

Unregister the system registry.

LDK_API bool ldk_system_registry_unregister(
 LDKSystemRegistry *registry,
 u64 id
);

Parameters

LDKSystemRegistry *registry
Registry on which the operation is performed.
u64 id
Identifier of the target object.

Returns

True if the operation succeeds; false otherwise.