KROYSDOCS
HomeWhat's newv0.1.0
C/C++ SDK / C ABI · Scene (all targets; permission scene.read / scene.write) / KroysFieldInfo

KroysFieldInfo

One reflected field of a component type (scene->GetFieldInfo, 2.2). Fields of nested reflected structs are listed with dotted paths. Set structSize before the call; the strings stay valid while the type is registered.

Kindstruct
Headerkroys/kroys_plugin.h
Members9
DECLARATION

Declaration

Declared in kroys/kroys_plugin.h.

kroys_plugin.h
typedef struct KroysFieldInfo { ... } KroysFieldInfo;
REFERENCE

Members

Fields
#uint32_t structSize;

Size of this struct as the writer compiled it (sizeof); the reader uses it to detect members appended by later minor versions.

field
#uint32_t type;

KroysValueType of GetField / SetField; KROYS_VALUE_NONE: not exposed

field
#uint32_t flags;

KROYS_FIELD_HIDDEN, _READ_ONLY, _COLOR, _DEGREES

field
#int32_t hasRange;

Nonzero: minimum and maximum bound the value in the inspector.

field
#const char* path;

Path for GetField / SetField ("intensity", "transform.position").

field
#const char* displayName;

Inspector label.

field
#const char* tooltip;

Inspector tooltip ("" when none).

field
#float minimum;

Range minimum (with hasRange).

field
#float maximum;

Range maximum (with hasRange).

field
Members
uint32_t structSize;
uint32_t type;
uint32_t flags;
int32_t hasRange;
const char* path;
const char* displayName;
const char* tooltip;
float minimum;
float maximum;

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