C/C++ SDK / C ABI / Basic types

Basic types

Constants and types of this part of kroys/kroys_plugin.h.

Headerkroys/kroys_plugin.h

SDK2.2.0

Structs and enums

KroysVersionA semantic version (major.minor.patch).KroysGuidA 128-bit GUID: the persistent identity of entities and assets.KroysTransformA local transform: position, Euler rotation and scale.

REFERENCE

Constants and types

Constants

##define KROYS_OK 0

Not documented yet.

constant

##define KROYS_E_FAILED (-1)

Not documented yet.

constant

##define KROYS_E_INVALID_ARGUMENT (-2)

Not documented yet.

constant

##define KROYS_E_NOT_FOUND (-3)

Not documented yet.

constant

##define KROYS_E_EXISTS (-4)

Not documented yet.

constant

##define KROYS_E_DENIED (-5)

capability or permission missing from the manifest

constant

##define KROYS_E_UNSUPPORTED (-6)

not available on this host or target

constant

##define KROYS_E_WRONG_THREAD (-7)

Not documented yet.

constant

##define KROYS_E_STATE (-8)

e.g. UI call outside a draw, document edit during Play

constant

##define KROYS_E_BUFFER_TOO_SMALL (-9)

Not documented yet.

constant

##define KROYS_E_CANCELLED (-10)

Not documented yet.

constant

##define KROYS_E_LIMIT (-11)

an engine limit was reached

constant

##define KROYS_TARGET_EDITOR 1u

Not documented yet.

constant

##define KROYS_TARGET_RUNTIME 2u

Not documented yet.

constant

##define KROYS_SEVERITY_INFO 0

Not documented yet.

constant

##define KROYS_SEVERITY_WARNING 1

Not documented yet.

constant

##define KROYS_SEVERITY_ERROR 2

Not documented yet.

constant

##define KROYS_SEVERITY_SUCCESS 3

notifications only

constant

Aliases

#typedef int32_t KroysResult;

Result of a host function or plugin callback: KROYS_OK (0) or a negative KROYS_E_* code (core->LastError has the message).

typedef

#typedef uint64_t KroysHandle;

a registration; 0 is invalid

typedef

#typedef uint64_t KroysEntity;

an entity of a world; 0 is none

typedef

#typedef uint64_t KroysComponentType;

a component type; 0 is none

typedef

#typedef struct KroysWorldOpaque* KroysWorld;

a scene (editor document or a running game)

typedef

#typedef struct KroysContextOpaque* KroysContext;

one plugin instance in one host

typedef

kroys_plugin.h

#define KROYS_OK 0
#define KROYS_E_FAILED (-1)
#define KROYS_E_INVALID_ARGUMENT (-2)
#define KROYS_E_NOT_FOUND (-3)
#define KROYS_E_EXISTS (-4)
#define KROYS_E_DENIED (-5)
#define KROYS_E_UNSUPPORTED (-6)
#define KROYS_E_WRONG_THREAD (-7)
#define KROYS_E_STATE (-8)
#define KROYS_E_BUFFER_TOO_SMALL (-9)
#define KROYS_E_CANCELLED (-10)
#define KROYS_E_LIMIT (-11)
#define KROYS_TARGET_EDITOR 1u
#define KROYS_TARGET_RUNTIME 2u
#define KROYS_SEVERITY_INFO 0
#define KROYS_SEVERITY_WARNING 1
#define KROYS_SEVERITY_ERROR 2
#define KROYS_SEVERITY_SUCCESS 3
typedef int32_t KroysResult;
typedef uint64_t KroysHandle;
typedef uint64_t KroysEntity;
typedef uint64_t KroysComponentType;
typedef struct KroysWorldOpaque* KroysWorld;
typedef struct KroysContextOpaque* KroysContext;

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.