Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kApiDef.h
Go to the documentation of this file.
1
10 #ifndef K_API_API_DEF_H
11 #define K_API_API_DEF_H
12
13 #include <kApi/kApiCfg.h>
14
15 kBeginHeader()
16
17 #define kCall kxCall
18 #define kDlCall kxDlCall
19
20 #if defined(K_EMIT)
21 # define kFx(TYPE) kExportFx(TYPE)
22 # define kDx(TYPE) kExportDx(TYPE)
23 #else
24 # define kFx(TYPE) kImportFx(TYPE)
25 # define kDx(TYPE) kImportDx(TYPE)
26 #endif
27
28 typedef void (kCall* kFunction)();
29
38 typedef kx8u k8u;
39
41 #define k8U_MIN (0)
42 #define k8U_MAX (255U)
43 #define k8U_NULL (k8U_MAX)
44
54 typedef kx16u k16u;
55
57 #define k16U_MIN (0)
58 #define k16U_MAX (65535U)
59 #define k16U_NULL (k16U_MAX)
60
70 typedef kx32u k32u;
71
73 #define k32U_MIN (0)
74 #define k32U_MAX (4294967295U)
75 #define k32U_NULL (k32U_MAX)
76
86 typedef kx64u k64u;
87
89 #define k64U(CONST) kx64U(CONST)
90 #define k64U_MIN k64U(0)
91 #define k64U_MAX k64U(18446744073709551615)
92 #define k64U_NULL (k64U_MAX)
93
95 #define kINFINITE k64U_MAX
96
97
105 typedef kx8s k8s;
106
108 #define k8S_MAX (127)
109 #define k8S_MIN (-k8S_MAX -1)
110 #define k8S_NULL (k8S_MIN)
111
121 typedef kx16s k16s;
122
124 #define k16S_MAX (32767)
125 #define k16S_MIN (-k16S_MAX -1)
126 #define k16S_NULL (k16S_MIN)
127
137 typedef kx32s k32s;
138
140 #define k32S_MAX (2147483647)
141 #define k32S_MIN (-k32S_MAX -1)
142 #define k32S_NULL (k32S_MIN)
143
153 typedef kx64s k64s;
154
156 #define k64S(CONST) kx64S(CONST)
157 #define k64S_MAX k64S(9223372036854775807)
158 #define k64S_MIN (-k64S_MAX -1)
159 #define k64S_NULL (k64S_MIN)
160
170 typedef kx32f k32f;
171
173 #define k32F_MIN (1.175494351e-38F)
174 #define k32F_MAX (3.402823466e+38F)
175 #define k32F_NULL (-k32F_MAX)
176
186 typedef kx64f k64f;
187
189 #define k64F_MIN (2.2250738585072014e-308)
190 #define k64F_MAX (1.7976931348623157e+308)
191 #define k64F_NULL (-k64F_MAX)
192
202 typedef kxByte kByte;
203
212 typedef kxSize kSize;
213
215 #define kSIZE_MAX kxSIZE_MAX
216 #define kSIZE_NULL kSIZE_MAX
217
225 typedef kxSSize kSSize;
226
228 #define kSSIZE_MIN kxSSIZE_MIN
229 #define kSSIZE_MAX kxSSIZE_MAX
230 #define kSSIZE_NULL kSSIZE_MIN
231
240 typedef void* kPointer;
241
242 #define kNULL (0)
243
244
250 #define kIsNull(POINTER) kIsNull_(POINTER)
251
260 typedef k32s kBool;
261
263 #define kFALSE (0)
264 #define kTRUE (1)
265
275 typedef kxChar kChar;
276
285 typedef kChar kText16[16];
286
295 typedef kChar kText32[32];
296
305 typedef kChar kText64[64];
306
315 typedef kChar kText128[128];
316
325 typedef kChar kText256[256];
326
335 typedef k32s kStatus;
336
338 #define kERROR_STATE (-1000)
339 #define kERROR_NOT_FOUND (-999)
340 #define kERROR_COMMAND (-998)
341 #define kERROR_PARAMETER (-997)
342 #define kERROR_UNIMPLEMENTED (-996)
343 #define kERROR_MEMORY (-994)
344 #define kERROR_TIMEOUT (-993)
345 #define kERROR_INCOMPLETE (-992)
346 #define kERROR_STREAM (-991)
347 #define kERROR_CLOSED (-990)
348 #define kERROR_VERSION (-989)
349 #define kERROR_ABORT (-988)
350 #define kERROR_ALREADY_EXISTS (-987)
351 #define kERROR_NETWORK (-986)
352 #define kERROR_HEAP (-985)
353 #define kERROR_FORMAT (-984)
354 #define kERROR_READ_ONLY (-983)
355 #define kERROR_WRITE_ONLY (-982)
356 #define kERROR_BUSY (-981)
357 #define kERROR_CONFLICT (-980)
358 #define kERROR_OS (-979)
359 #define kERROR_DEVICE (-978)
360 #define kERROR_FULL (-977)
361 #define kERROR_IN_PROGRESS (-976)
362 #define kERROR (0)
363 #define kOK (1)
364
375 kFx(const kChar*) kStatus_Name(kStatus status);
376
386 #define kIsError(EXPRESSION) kIsError_(EXPRESSION)
387
397 #define kSuccess(EXPRESSION) kSuccess_(EXPRESSION)
398
409 #define kCheck(EXPRESSION) kCheck_(EXPRESSION)
410
422 #define kCheckTrue(EXPRESSION, STATUS) kCheckTrue_(EXPRESSION, STATUS)
423
434 #define kCheckArgs(EXPRESSION) kCheckArgs_(EXPRESSION)
435
446 #define kCheckState(EXPRESSION) kCheckState_(EXPRESSION)
447
453 #define kTry kTry_
454
463 #define kThrow(EXPRESSION) kThrow_(EXPRESSION)
464
476 #define kTest(EXPRESSION) kTest_(EXPRESSION)
477
490 #define kTestTrue(EXPRESSION, STATUS) kTestTrue_(EXPRESSION, STATUS)
491
503 #define kTestArgs(EXPRESSION) kTestArgs_(EXPRESSION)
504
516 #define kTestState(EXPRESSION) kTestState_(EXPRESSION)
517
526 #define kCatch(STATUS_POINTER) kCatch_(STATUS_POINTER)
527
538 #define kEndCatch(STATUS) kEndCatch_(STATUS)
539
545 #define kFinally kFinally_
546
555 #define kEndFinally() kEndFinally_()
556
565 #define kCatchEx(STATUS_POINTER) kCatchEx_(STATUS_POINTER)
566
579 #define kEndCatchEx(STATUS) kEndCatchEx_(STATUS)
580
586 #define kFinallyEx kFinallyEx_
587
596 #define kEndFinallyEx() kEndFinallyEx_()
597
605 #define kAssert(EXPRESSION) kAssert_(EXPRESSION)
606
617 #define kAssertType(OBJECT, SYMBOL) kAssertType_(OBJECT, SYMBOL)
618
628 #define kTrace(TAG) kTrace_(TAG)
629
638 typedef k32u kVersion;
639
650 kFx(kVersion) kVersion_Create(k32u major, k32u minor, k32u release, k32u build);
651
660 kFx(kStatus) kVersion_Parse(kVersion* version, const kChar* buffer);
661
671 kFx(kStatus) kVersion_Format(kVersion version, kChar* buffer, kSize capacity);
672
684 kFx(k32s) kVersion_Compare(kVersion version1, kVersion version2);
685
693 kFx(k8u) kVersion_Major(kVersion version);
694
702 kFx(k8u) kVersion_Minor(kVersion version);
703
711 kFx(k8u) kVersion_Release(kVersion version);
712
720 kFx(k8u) kVersion_Build(kVersion version);
721
728 typedef k32s kEndianness;
729
731 #define kENDIANNESS_LITTLE (1)
732 #define kENDIANNESS_BIG (2)
733
740 #define kEndianness_Host_() \
741 (K_ENDIANNESS)
742
749 #define kEndianness_ShouldSwap_(E) \
750 ((E) != kEndianness_Host_())
751
766 kFx(kStatus) k8u_Format(k8u value, kChar* buffer, kSize capacity);
767
776 kFx(kStatus) k8u_Parse(k8u* value, const kChar* str);
777
792 kFx(kStatus) k8s_Format(k8s value, kChar* buffer, kSize capacity);
793
802 kFx(kStatus) k8s_Parse(k8s* value, const kChar* str);
803
818 kFx(kStatus) k16u_Format(k16u value, kChar* buffer, kSize capacity);
819
828 kFx(kStatus) k16u_Parse(k16u* value, const kChar* str);
829
844 kFx(kStatus) k16s_Format(k16s value, kChar* buffer, kSize capacity);
845
854 kFx(kStatus) k16s_Parse(k16s* value, const kChar* str);
855
870 kFx(kStatus) k32u_Format(k32u value, kChar* buffer, kSize capacity);
871
880 kFx(kStatus) k32u_Parse(k32u* value, const kChar* str);
881
896 kFx(kStatus) k32s_Format(k32s value, kChar* buffer, kSize capacity);
897
906 kFx(kStatus) k32s_Parse(k32s* value, const kChar* str);
907
922 kFx(kStatus) k64u_Format(k64u value, kChar* buffer, kSize capacity);
923
932 kFx(kStatus) k64u_Parse(k64u* value, const kChar* str);
933
948 kFx(kStatus) k64s_Format(k64s value, kChar* buffer, kSize capacity);
949
958 kFx(kStatus) k64s_Parse(k64s* value, const kChar* str);
959
974 kFx(kStatus) kBool_Format(kBool value, kChar* buffer, kSize capacity);
975
984 kFx(kStatus) kBool_Parse(kBool* value, const kChar* str);
985
1000 kFx(kStatus) kSize_Format(kSize value, kChar* buffer, kSize capacity);
1001
1010 kFx(kStatus) kSize_Parse(kSize* value, const kChar* str);
1011
1026 kFx(kStatus) kSSize_Format(kSSize value, kChar* buffer, kSize capacity);
1027
1036 kFx(kStatus) kSSize_Parse(kSSize* value, const kChar* str);
1037
1052 kFx(kStatus) k32f_Format(k32f value, kChar* buffer, kSize capacity);
1053
1062 kFx(kStatus) k32f_Parse(k32f* value, const kChar* str);
1063
1078 kFx(kStatus) k64f_Format(k64f value, kChar* buffer, kSize capacity);
1079
1088 kFx(kStatus) k64f_Parse(k64f* value, const kChar* str);
1089
1098 typedef struct kPoint16s
1099 {
1100 k16s x;
1101 k16s y;
1102 } kPoint16s;
1103
1112 typedef struct kPoint32s
1113 {
1114 k32s x;
1115 k32s y;
1116 } kPoint32s;
1117
1126 typedef struct kPoint32f
1127 {
1128 k32f x;
1129 k32f y;
1130 } kPoint32f;
1131
1140 typedef struct kPoint64f
1141 {
1142 k64f x;
1143 k64f y;
1144 } kPoint64f;
1145
1153 #define kPoint_Init_(POINT, X, Y) kxPoint_Init_(POINT, X, Y)
1154
1163 typedef struct kPoint3d16s
1164 {
1165 k16s x;
1166 k16s y;
1167 k16s z;
1168 } kPoint3d16s;
1169
1178 typedef struct kPoint3d32s
1179 {
1180 k32s x;
1181 k32s y;
1182 k32s z;
1183 } kPoint3d32s;
1184
1193 typedef struct kPoint3d32f
1194 {
1195 k32f x;
1196 k32f y;
1197 k32f z;
1198 } kPoint3d32f;
1199
1208 typedef struct kPoint3d64f
1209 {
1210 k64f x;
1211 k64f y;
1212 k64f z;
1213 } kPoint3d64f;
1214
1223 #define kPoint3d_Init_(POINT, X, Y, Z) kxPoint3d_Init_(POINT, X, Y, Z)
1224
1233 typedef struct kRect16s
1234 {
1235 k16s x;
1236 k16s y;
1237 k16s width;
1238 k16s height;
1239 } kRect16s;
1240
1249 typedef struct kRect32s
1250 {
1251 k32s x;
1252 k32s y;
1253 k32s width;
1254 k32s height;
1255 } kRect32s;
1256
1265 typedef struct kRect32f
1266 {
1267 k32f x;
1268 k32f y;
1269 k32f width;
1270 k32f height;
1271 } kRect32f;
1272
1281 typedef struct kRect64f
1282 {
1283 k64f x;
1284 k64f y;
1285 k64f width;
1286 k64f height;
1287 } kRect64f;
1288
1298 #define kRect_Init_(RECT, X, Y, W, H) kxRect_Init_(RECT, X, Y, W, H)
1299
1308 typedef struct kRect3d64f
1309 {
1310 k64f x;
1311 k64f y;
1312 k64f z;
1313 k64f width;
1314 k64f height;
1315 k64f depth;
1316 } kRect3d64f;
1317
1329 #define kRect3d_Init_(RECT, X, Y, Z, W, H, D) kxRect3d_Init_(RECT, X, Y, Z, W, H, D)
1330
1339 typedef struct kRotatedRect32s
1340 {
1341 k32s xc;
1342 k32s yc;
1343 k32s width;
1344 k32s height;
1345 k32s angle;
1346 } kRotatedRect32s;
1347
1356 typedef struct kRotatedRect32f
1357 {
1358 k32f xc;
1359 k32f yc;
1360 k32f width;
1361 k32f height;
1362 k32f angle;
1363 } kRotatedRect32f;
1364
1375 #define kRotatedRect_Init_(RECT, XC, YC, W, H, A) kxRotatedRect_Init_(RECT, XC, YC, W, H, A)
1376
1385 typedef k32s kPixelFormat;
1386
1388 #define kPIXEL_FORMAT_NULL (0)
1389 #define kPIXEL_FORMAT_8BPP_GREYSCALE (1)
1390 #define kPIXEL_FORMAT_8BPP_CFA (2)
1391 #define kPIXEL_FORMAT_8BPC_BGRX (3)
1392 #define kPIXEL_FORMAT_1BPP_GREYSCALE (4)
1393
1403 typedef k32s kCfa;
1404
1406 #define kCFA_NONE (0)
1407 #define kCFA_BAYER_BGGR (1)
1408 #define kCFA_BAYER_GBRG (2)
1409 #define kCFA_BAYER_RGGB (3)
1410 #define kCFA_BAYER_GRBG (4)
1411
1421 typedef struct kRgb
1422 {
1423 k8u b;
1424 k8u g;
1425 k8u r;
1426 k8u x;
1427 } kRgb;
1428
1438 #define kRgb_Init_(RGB, R, G, B) kxRgb_Init_(RGB, R, G, B)
1439
1448 typedef struct kArgb
1449 {
1450 k8u b;
1451 k8u g;
1452 k8u r;
1453 k8u a;
1454 } kArgb;
1455
1466 #define kArgb_Init_(ARGB, A, R, G, B) kxArgb_Init_(ARGB, A, R, G, B)
1467
1474 typedef k32s kComparison;
1475
1476 #define kCOMPARISON_EQ (0)
1477 #define kCOMPARISON_NEQ (1)
1478 #define kCOMPARISON_LT (2)
1479 #define kCOMPARISON_LTE (3)
1480 #define kCOMPARISON_GT (4)
1481 #define kCOMPARISON_GTE (5)
1482
1483
1490 typedef kBool (kCall* kEqualsFx)(const void* item1, const void* item2);
1491
1498 typedef kSize (kCall* kHashFx)(const void* item);
1499
1508 typedef kStatus (kCall* kCallbackFx)(kPointer receiver, kPointer sender, void* args);
1509
1516 typedef struct kCallback
1517 {
1518 kCallbackFx function;
1519 kPointer receiver;
1520 } kCallback;
1521
1528 typedef k32s kFileMode;
1529
1531 #define kFILE_MODE_READ (0x1)
1532 #define kFILE_MODE_WRITE (0x2)
1533 #define kFILE_MODE_UPDATE (0x4)
1534
1542 typedef k32s kSeekOrigin;
1543
1544 #define kSEEK_ORIGIN_BEGIN (0)
1545 #define kSEEK_ORIGIN_CURRENT (1)
1546 #define kSEEK_ORIGIN_END (2)
1547
1548
1556 #define kCountOf(CARRAY) kCountOf_(CARRAY)
1557
1569 #define kCast(TYPE, ITEM) kCast_(TYPE, ITEM)
1570
1578 #define kMin_(A, B) kxMin_(A, B)
1579
1587 #define kMax_(A, B) kxMax_(A, B)
1588
1597 #define kClamp_(V, VMIN, VMAX) kxClamp_((V), (VMIN), (VMAX))
1598
1605 #define kAbs_(A) kxAbs_(A)
1606
1612 #define kZero_(VALUE) kxZero_(VALUE)
1613
1621 #define kItemCopy_(DEST, SRC, SIZE) kxItemCopy_(DEST, SRC, SIZE)
1622
1630 #define kItemSet_(DEST, FILL, SIZE) kxItemSet_(DEST, FILL, SIZE)
1631
1638 #define kItemZero_(DEST, SIZE) kItemSet_(DEST, 0, SIZE)
1639
1647 #define kItemAt_(BASE, INDEX, SIZE) kAt_((BASE), (INDEX)*(SIZE))
1648
1649
1675 #define kTypeOf(SYMBOL) kTypeOf_(SYMBOL)
1676
1702 #define kAssemblyOf(SYMBOL) kAssemblyOf_(SYMBOL)
1703
1712 #define kStaticOf(SYMBOL) kStaticOf_(SYMBOL)
1713
1720 #define kStaticInitialized(SYMBOL) kStaticInitialized_(SYMBOL)
1721
1729 #define kDeclareAssembly(PREFIX, SYMBOL) kDeclareAssembly_(PREFIX, SYMBOL)
1730
1740 #define kBeginAssembly(PREFIX, SYMBOL, VERSION, PLATFORM_VERSION) kBeginAssembly_(PREFIX, SYMBOL, VERSION, PLATFORM_VERSION)
1741
1747 #define kEndAssembly() kEndAssembly_()
1748
1757 #define kDeclareValue(PREFIX, SYMBOL, BASE) kDeclareValue_(PREFIX, SYMBOL, BASE)
1758
1767 #define kBeginValue(PREFIX, SYMBOL, BASE) kBeginValue_(PREFIX, SYMBOL, BASE)
1768
1774 #define kEndValue() kEndValue_()
1775
1784 #define kDeclareEnum(PREFIX, SYMBOL, BASE) kDeclareEnum_(PREFIX, SYMBOL, BASE)
1785
1794 #define kBeginEnum(PREFIX, SYMBOL, BASE) kBeginEnum_(PREFIX, SYMBOL, BASE)
1795
1801 #define kEndEnum() kEndEnum_()
1802
1811 #define kDeclareBitEnum(PREFIX, SYMBOL, BASE) kDeclareBitEnum_(PREFIX, SYMBOL, BASE)
1812
1821 #define kBeginBitEnum(PREFIX, SYMBOL, BASE) kBeginBitEnum_(PREFIX, SYMBOL, BASE)
1822
1828 #define kEndBitEnum() kEndBitEnum_()
1829
1838 #define kDeclareArrayValue(PREFIX, SYMBOL, BASE) kDeclareArrayValue_(PREFIX, SYMBOL, BASE)
1839
1849 #define kBeginArrayValue(PREFIX, SYMBOL, TYPE, BASE) kBeginArrayValue_(PREFIX, SYMBOL, TYPE, BASE)
1850
1856 #define kEndArrayValue() kEndArrayValue_()
1857
1866 #define kDeclareInterface(PREFIX, SYMBOL, BASE) kDeclareInterface_(PREFIX, SYMBOL, BASE)
1867
1876 #define kBeginInterface(PREFIX, SYMBOL, BASE) kBeginInterface_(PREFIX, SYMBOL, BASE)
1877
1883 #define kEndInterface() kEndInterface_()
1884
1893 #define kDeclareFullClass(PREFIX, SYMBOL, BASE) kDeclareFullClass_(PREFIX, SYMBOL, BASE)
1894
1903 #define kBeginFullClass(PREFIX, SYMBOL, BASE) kBeginFullClass_(PREFIX, SYMBOL, BASE)
1904
1910 #define kEndFullClass() kEndFullClass_()
1911
1920 #define kDeclareVirtualClass(PREFIX, SYMBOL, BASE) kDeclareVirtualClass_(PREFIX, SYMBOL, BASE)
1921
1930 #define kBeginVirtualClass(PREFIX, SYMBOL, BASE) kBeginVirtualClass_(PREFIX, SYMBOL, BASE)
1931
1937 #define kEndVirtualClass() kEndVirtualClass_()
1938
1946 #define kDeclareStaticClass(PREFIX, SYMBOL) kDeclareStaticClass_(PREFIX, SYMBOL)
1947
1955 #define kBeginStaticClass(PREFIX, SYMBOL) kBeginStaticClass_(PREFIX, SYMBOL)
1956
1962 #define kEndStaticClass() kEndStaticClass_()
1963
1972 #define kDeclareClass(PREFIX, SYMBOL, BASE) kDeclareClass_(PREFIX, SYMBOL, BASE)
1973
1982 #define kBeginClass(PREFIX, SYMBOL, BASE) kBeginClass_(PREFIX, SYMBOL, BASE)
1983
1989 #define kEndClass() kEndClass_()
1990
1997 #define kAddDependency(SYMBOL) kAddDependency_(SYMBOL)
1998
2005 #define kAddType(SYMBOL) kAddType_(SYMBOL)
2006
2017 #define kAddPriority(SYMBOL) kAddPriority_(SYMBOL)
2018
2026 #define kAddInterface(SYMBOL, IFACE) kAddInterface_(SYMBOL, IFACE)
2027
2035 #define kAddMethod(SYMBOL, METHOD) kAddMethod_(SYMBOL, METHOD)
2036
2045 #define kAddVMethod(IN_TYPE, FROM_TYPE, METHOD) kAddVMethod_(IN_TYPE, FROM_TYPE, METHOD)
2046
2056 #define kAddIVMethod(IN_TYPE, FROM_IFACE, IMETHOD, CMETHOD) kAddIVMethod_(IN_TYPE, FROM_IFACE, IMETHOD, CMETHOD)
2057
2066 #define kAddField(VALUE, FIELD_TYPE, FIELD) kAddField_(VALUE, FIELD_TYPE, FIELD)
2067
2075 #define kAddEnumerator kAddEnumerator_
2076
2088 #define kAddVersion(TYPE, FORMAT, FORMAT_VER, GUID, WRITE_METHOD, READ_METHOD) \
2089 kAddVersion_(TYPE, FORMAT, FORMAT_VER, GUID, WRITE_METHOD, READ_METHOD)
2090
2104 #define kAddAbstractVersion(TYPE, FORMAT, FORMAT_VER, GUID) \
2105 kAddAbstractVersion_(TYPE, FORMAT, FORMAT_VER, GUID)
2106
2114 #define kAddFlags(TYPE, FLAGS) kAddFlags_(TYPE, FLAGS)
2115
2116
2138 #define kDefineDebugHints() kDefineDebugHints_()
2139
2140 kEndHeader()
2141
2142 #include <kApi/kApiDef.x.h>
2143
2144 #endif
kPoint32f::y
k32f y
Y-coordinate value.
Definition: kApiDef.h:1129
k32s::k32s_Parse
kStatus k32s_Parse(k32s *value, const kChar *str)
Converts string to k32s value.
kRect3d64f::height
k64f height
Height of the rectangular cuboid.
Definition: kApiDef.h:1314
kText64
Represents a 64-unit, null-terminated, kChar sequence.
k32u
Represents a 32-bit unsigned integer.
kRect32s::y
k32s y
Y-coordinate of the origin.
Definition: kApiDef.h:1252
kBool::kBool_Parse
kStatus kBool_Parse(kBool *value, const kChar *str)
Converts string to kBool value.
kRect64f::height
k64f height
Height of the rectangle.
Definition: kApiDef.h:1286
kRect32f::x
k32f x
X-coordinate of the origin.
Definition: kApiDef.h:1267
kRect32s
Rectangle structure with 32-bit signed integer fields.
Definition: kApiDef.h:1249
kPoint3d32f
3D point structure with 32-bit floating-point fields.
Definition: kApiDef.h:1193
kRect64f::x
k64f x
X-coordinate of the origin.
Definition: kApiDef.h:1283
kRotatedRect32s::width
k32s width
Width of the rectangle.
Definition: kApiDef.h:1343
kRgb::b
k8u b
Blue component value.
Definition: kApiDef.h:1423
kPoint3d32s::y
k32s y
Y-coordinate value.
Definition: kApiDef.h:1181
kRect16s::width
k16s width
Width of the rectangle.
Definition: kApiDef.h:1237
kArgb
32-bit color pixel structure (B/G/R/A).
Definition: kApiDef.h:1448
kRect16s::y
k16s y
Y-coordinate of the origin.
Definition: kApiDef.h:1236
kPoint16s
2D point structure with 16-bit signed integer fields.
Definition: kApiDef.h:1098
k64u
Represents a 64-bit unsigned integer.
kApiCfg.h
Architecture/compiler-specific definitions.
kText256
Represents a 256-unit, null-terminated, kChar sequence.
kCallback::receiver
kPointer receiver
Callback receiver context pointer.
Definition: kApiDef.h:1519
kRotatedRect32f
Rotated rectangle structure with 32-bit floating-point fields.
Definition: kApiDef.h:1356
kRect64f::y
k64f y
Y-coordinate of the origin.
Definition: kApiDef.h:1284
kPoint3d32s::z
k32s z
Z-coordinate value.
Definition: kApiDef.h:1182
kPointer
Represents a void pointer.
kRgb
32-bit color pixel structure (B/G/R/X).
Definition: kApiDef.h:1421
kSize::kSize_Parse
kStatus kSize_Parse(kSize *value, const kChar *str)
Converts string to kSize value.
kPoint32f::x
k32f x
X-coordinate value.
Definition: kApiDef.h:1128
kSSize::kSSize_Parse
kStatus kSSize_Parse(kSSize *value, const kChar *str)
Converts string to kSSize value.
kPoint3d16s::z
k16s z
Z-coordinate value.
Definition: kApiDef.h:1167
k32f::k32f_Format
kStatus k32f_Format(k32f value, kChar *buffer, kSize capacity)
Converts k32f value to string.
k16u
Represents a 16-bit unsigned integer.
k32u::k32u_Format
kStatus k32u_Format(k32u value, kChar *buffer, kSize capacity)
Converts k32u value to string.
kRotatedRect32s::xc
k32s xc
X-coordinate of the rectangle center.
Definition: kApiDef.h:1341
kRotatedRect32s
Rotated rectangle structure with 32-bit signed integer fields.
Definition: kApiDef.h:1339
kRotatedRect32f::yc
k32f yc
Y-coordinate of the rectangle center.
Definition: kApiDef.h:1359
kBool::kBool_Format
kStatus kBool_Format(kBool value, kChar *buffer, kSize capacity)
Converts kBool value to string.
kSize
Represents an unsigned integer that can store a pointer address.
kRotatedRect32s::angle
k32s angle
Rotation angle of the rectangle.
Definition: kApiDef.h:1345
kRect3d64f::width
k64f width
Width of the rectangular cuboid.
Definition: kApiDef.h:1313
k8u
Represents an 8-bit unsigned integer.
kRect3d64f::x
k64f x
X-coordinate of the origin.
Definition: kApiDef.h:1310
kRect3d64f::depth
k64f depth
Depth of the rectangular cuboid.
Definition: kApiDef.h:1315
kPoint3d64f::y
k64f y
Y-coordinate value.
Definition: kApiDef.h:1211
kPoint3d64f::x
k64f x
X-coordinate value.
Definition: kApiDef.h:1210
kChar
Represents a single unit (byte) in a UTF-8 character.
k64s::k64s_Format
kStatus k64s_Format(k64s value, kChar *buffer, kSize capacity)
Converts k64s value to string.
k16u::k16u_Parse
kStatus k16u_Parse(k16u *value, const kChar *str)
Converts string to k16u value.
kPoint16s::x
k16s x
X-coordinate value.
Definition: kApiDef.h:1100
kPoint3d16s::y
k16s y
Y-coordinate value.
Definition: kApiDef.h:1166
kSSize::kSSize_Format
kStatus kSSize_Format(kSSize value, kChar *buffer, kSize capacity)
Converts kSSize value to string.
kHashFx
kSize(kCall * kHashFx)(const void *item)
Callback signature to determine hash code of an item.
Definition: kApiDef.h:1498
k64f::k64f_Parse
kStatus k64f_Parse(k64f *value, const kChar *str)
Converts string to k64f value.
kRotatedRect32f::angle
k32f angle
Rotation angle of the rectangle.
Definition: kApiDef.h:1362
kSSize
Represents a signed integer that can store a pointer address.
kRect32s::height
k32s height
Height of the rectangle.
Definition: kApiDef.h:1254
kRect32f
Rectangle structure with 32-bit floating-point fields.
Definition: kApiDef.h:1265
kVersion::kVersion_Compare
k32s kVersion_Compare(kVersion version1, kVersion version2)
Returns an integral value indicating the relationship between the versions.
kRect32s::width
k32s width
Width of the rectangle.
Definition: kApiDef.h:1253
k32u::k32u_Parse
kStatus k32u_Parse(k32u *value, const kChar *str)
Converts string to k32u value.
kPoint32s::x
k32s x
X-coordinate value.
Definition: kApiDef.h:1114
kPixelFormat
Pixel format descriptor.
kRotatedRect32s::height
k32s height
Height of the rectangle.
Definition: kApiDef.h:1344
kRect64f
Rectangle structure with 64-bit floating-point fields.
Definition: kApiDef.h:1281
kText128
Represents a 128-unit, null-terminated, kChar sequence.
kPoint3d32f::x
k32f x
X-coordinate value.
Definition: kApiDef.h:1195
kVersion::kVersion_Minor
k8u kVersion_Minor(kVersion version)
Returns the minor part of a version number.
k16s::k16s_Format
kStatus k16s_Format(k16s value, kChar *buffer, kSize capacity)
Converts k16s value to string.
kEqualsFx
kBool(kCall * kEqualsFx)(const void *item1, const void *item2)
Callback signature to determine equality of two items.
Definition: kApiDef.h:1490
kVersion::kVersion_Major
k8u kVersion_Major(kVersion version)
Returns the major part of a version number.
kStatus
typedef kStatus(kCall *kMsgQueueDropFx)(kPointer receiver
Defines the signature of a callback function to handle dropped items.
kPoint16s::y
k16s y
Y-coordinate value.
Definition: kApiDef.h:1101
kPoint3d16s::x
k16s x
X-coordinate value.
Definition: kApiDef.h:1165
kPoint3d32f::z
k32f z
Z-coordinate value.
Definition: kApiDef.h:1197
k32f::k32f_Parse
kStatus k32f_Parse(k32f *value, const kChar *str)
Converts string to k32f value.
kRect64f::width
k64f width
Width of the rectangle.
Definition: kApiDef.h:1285
kPoint3d64f::z
k64f z
Z-coordinate value.
Definition: kApiDef.h:1212
kCallback
Represents a callback function and context pointer.
Definition: kApiDef.h:1516
kVersion::kVersion_Build
k8u kVersion_Build(kVersion version)
Returns the build part of a version number.
kArgb::r
k8u r
Red component value.
Definition: kApiDef.h:1452
kPoint32f
2D point structure with 32-bit floating-point fields.
Definition: kApiDef.h:1126
kRect3d64f::y
k64f y
Y-coordinate of the origin.
Definition: kApiDef.h:1311
k32s::k32s_Format
kStatus k32s_Format(k32s value, kChar *buffer, kSize capacity)
Converts k32s value to string.
kRotatedRect32s::yc
k32s yc
Y-coordinate of the rectangle center.
Definition: kApiDef.h:1342
k32s
Represents a 32-bit signed integer.
kFunction
void(kCall * kFunction)()
Generic pointer to function.
Definition: kApiDef.h:28
kRgb::r
k8u r
Red component value.
Definition: kApiDef.h:1425
kRotatedRect32f::height
k32f height
Height of the rectangle.
Definition: kApiDef.h:1361
kPoint64f::x
k64f x
X-coordinate value.
Definition: kApiDef.h:1142
kVersion::kVersion_Create
kVersion kVersion_Create(k32u major, k32u minor, k32u release, k32u build)
Creates a version value from its constituent parts.
kVersion::kVersion_Release
k8u kVersion_Release(kVersion version)
Returns the release part of a version number.
k16s::k16s_Parse
kStatus k16s_Parse(k16s *value, const kChar *str)
Converts string to k16s value.
kPoint64f
2D point structure with 64-bit floating-point fields.
Definition: kApiDef.h:1140
kCallbackFx
kStatus(kCall * kCallbackFx)(kPointer receiver, kPointer sender, void *args)
Callback signature for a generic event handler.
Definition: kApiDef.h:1508
kRgb::g
k8u g
Green component value.
Definition: kApiDef.h:1424
k64s
Represents a 64-bit signed integer.
kSize::kSize_Format
kStatus kSize_Format(kSize value, kChar *buffer, kSize capacity)
Converts kSize value to string.
kVersion::kVersion_Format
kStatus kVersion_Format(kVersion version, kChar *buffer, kSize capacity)
Formats a version to a string buffer.
kText16
Represents a 16-unit, null-terminated, kChar sequence.
kFileMode
Flags that control how a file is opened.
k8s
Represents an 8-bit signed integer.
kEndianness
Represents the byte-ordering of primative data types.
kRotatedRect32f::width
k32f width
Width of the rectangle.
Definition: kApiDef.h:1360
kArgb::b
k8u b
Blue component value.
Definition: kApiDef.h:1450
kRect16s::height
k16s height
Height of the rectangle.
Definition: kApiDef.h:1238
k8s::k8s_Format
kStatus k8s_Format(k8s value, kChar *buffer, kSize capacity)
Converts k8s value to string.
kArgb::g
k8u g
Green component value.
Definition: kApiDef.h:1451
k64s::k64s_Parse
kStatus k64s_Parse(k64s *value, const kChar *str)
Converts string to k64s value.
kPoint3d32s::x
k32s x
X-coordinate value.
Definition: kApiDef.h:1180
kVersion::kVersion_Parse
kStatus kVersion_Parse(kVersion *version, const kChar *buffer)
Parses a version from a formatted string.
kText32
Represents a 32-unit, null-terminated, kChar sequence.
kPoint3d16s
3D point structure with 16-bit signed integer fields.
Definition: kApiDef.h:1163
k16s
Represents a 16-bit signed integer.
kRect32f::y
k32f y
Y-coordinate of the origin.
Definition: kApiDef.h:1268
k32f
Represents a 32-bit floating-point number.
kPoint64f::y
k64f y
Y-coordinate value.
Definition: kApiDef.h:1143
kVersion
Represents a version number.
kArgb::a
k8u a
Alpha component value.
Definition: kApiDef.h:1453
kRect3d64f::z
k64f z
Z-coordinate of the origin.
Definition: kApiDef.h:1312
k64u::k64u_Format
kStatus k64u_Format(k64u value, kChar *buffer, kSize capacity)
Converts k64u value to string.
kRgb::x
k8u x
Undefined.
Definition: kApiDef.h:1426
kPoint32s::y
k32s y
Y-coordinate value.
Definition: kApiDef.h:1115
kCall
#define kCall
kApi standard function calling convention.
Definition: kApiDef.h:17
kRect32f::width
k32f width
Width of the rectangle.
Definition: kApiDef.h:1269
k16u::k16u_Format
kStatus k16u_Format(k16u value, kChar *buffer, kSize capacity)
Converts k16u value to string.
kRect3d64f
Rectangular cuboid structure with 64-bit floating-point fields.
Definition: kApiDef.h:1308
k64f::k64f_Format
kStatus k64f_Format(k64f value, kChar *buffer, kSize capacity)
Converts k64f value to string.
kRect16s
Rectangle structure with 16-bit signed integer fields.
Definition: kApiDef.h:1233
k8u::k8u_Format
kStatus k8u_Format(k8u value, kChar *buffer, kSize capacity)
Converts k8u value to string.
k64f
Represents a 64-bit floating-point number.
kComparison
Represents a comparison type.
kRect32s::x
k32s x
X-coordinate of the origin.
Definition: kApiDef.h:1251
kRotatedRect32f::xc
k32f xc
X-coordinate of the rectangle center.
Definition: kApiDef.h:1358
kPoint32s
2D point structure with 32-bit signed integer fields.
Definition: kApiDef.h:1112
kBool
Represents a boolean value.
k64u::k64u_Parse
kStatus k64u_Parse(k64u *value, const kChar *str)
Converts string to k64u value.
kRect16s::x
k16s x
X-coordinate of the origin.
Definition: kApiDef.h:1235
kRect32f::height
k32f height
Height of the rectangle.
Definition: kApiDef.h:1270
kPoint3d64f
3D point structure with 64-bit floating-point fields.
Definition: kApiDef.h:1208
kPoint3d32s
3D point structure with 32-bit signed integer fields.
Definition: kApiDef.h:1178
k8u::k8u_Parse
kStatus k8u_Parse(k8u *value, const kChar *str)
Converts string to k8u value.
kPoint3d32f::y
k32f y
Y-coordinate value.
Definition: kApiDef.h:1196
k8s::k8s_Parse
kStatus k8s_Parse(k8s *value, const kChar *str)
Converts string to k8s value.