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
421 #define kCheckArgs(EXPRESSION) kCheckArgs_(EXPRESSION)
422
433 #define kCheckState(EXPRESSION) kCheckState_(EXPRESSION)
434
440 #define kTry kTry_
441
450 #define kThrow(EXPRESSION) kThrow_(EXPRESSION)
451
463 #define kTest(EXPRESSION) kTest_(EXPRESSION)
464
476 #define kTestArgs(EXPRESSION) kTestArgs_(EXPRESSION)
477
489 #define kTestState(EXPRESSION) kTestState_(EXPRESSION)
490
499 #define kCatch(STATUS_POINTER) kCatch_(STATUS_POINTER)
500
511 #define kEndCatch(STATUS) kEndCatch_(STATUS)
512
518 #define kFinally kFinally_
519
528 #define kEndFinally() kEndFinally_()
529
538 #define kCatchEx(STATUS_POINTER) kCatchEx_(STATUS_POINTER)
539
552 #define kEndCatchEx(STATUS) kEndCatchEx_(STATUS)
553
559 #define kFinallyEx kFinallyEx_
560
569 #define kEndFinallyEx() kEndFinallyEx_()
570
578 #define kAssert(EXPRESSION) kAssert_(EXPRESSION)
579
590 #define kAssertType(OBJECT, SYMBOL) kAssertType_(OBJECT, SYMBOL)
591
601 #define kTrace(TAG) kTrace_(TAG)
602
611 typedef k32u kVersion;
612
623 kFx(kVersion) kVersion_Create(k32u major, k32u minor, k32u release, k32u build);
624
633 kFx(kStatus) kVersion_Parse(kVersion* version, const kChar* buffer);
634
644 kFx(kStatus) kVersion_Format(kVersion version, kChar* buffer, kSize capacity);
645
657 kFx(k32s) kVersion_Compare(kVersion version1, kVersion version2);
658
666 kFx(k8u) kVersion_Major(kVersion version);
667
675 kFx(k8u) kVersion_Minor(kVersion version);
676
684 kFx(k8u) kVersion_Release(kVersion version);
685
693 kFx(k8u) kVersion_Build(kVersion version);
694
701 typedef k32s kEndianness;
702
704 #define kENDIANNESS_LITTLE (1)
705 #define kENDIANNESS_BIG (2)
706
713 #define kEndianness_Host_() \
714 (K_ENDIANNESS)
715
722 #define kEndianness_ShouldSwap_(E) \
723 ((E) != kEndianness_Host_())
724
739 kFx(kStatus) k8u_Format(k8u value, kChar* buffer, kSize capacity);
740
749 kFx(kStatus) k8u_Parse(k8u* value, const kChar* str);
750
765 kFx(kStatus) k8s_Format(k8s value, kChar* buffer, kSize capacity);
766
775 kFx(kStatus) k8s_Parse(k8s* value, const kChar* str);
776
791 kFx(kStatus) k16u_Format(k16u value, kChar* buffer, kSize capacity);
792
801 kFx(kStatus) k16u_Parse(k16u* value, const kChar* str);
802
817 kFx(kStatus) k16s_Format(k16s value, kChar* buffer, kSize capacity);
818
827 kFx(kStatus) k16s_Parse(k16s* value, const kChar* str);
828
843 kFx(kStatus) k32u_Format(k32u value, kChar* buffer, kSize capacity);
844
853 kFx(kStatus) k32u_Parse(k32u* value, const kChar* str);
854
869 kFx(kStatus) k32s_Format(k32s value, kChar* buffer, kSize capacity);
870
879 kFx(kStatus) k32s_Parse(k32s* value, const kChar* str);
880
895 kFx(kStatus) k64u_Format(k64u value, kChar* buffer, kSize capacity);
896
905 kFx(kStatus) k64u_Parse(k64u* value, const kChar* str);
906
921 kFx(kStatus) k64s_Format(k64s value, kChar* buffer, kSize capacity);
922
931 kFx(kStatus) k64s_Parse(k64s* value, const kChar* str);
932
947 kFx(kStatus) kBool_Format(kBool value, kChar* buffer, kSize capacity);
948
957 kFx(kStatus) kBool_Parse(kBool* value, const kChar* str);
958
973 kFx(kStatus) kSize_Format(kSize value, kChar* buffer, kSize capacity);
974
983 kFx(kStatus) kSize_Parse(kSize* value, const kChar* str);
984
999 kFx(kStatus) kSSize_Format(kSSize value, kChar* buffer, kSize capacity);
1000
1009 kFx(kStatus) kSSize_Parse(kSSize* value, const kChar* str);
1010
1025 kFx(kStatus) k32f_Format(k32f value, kChar* buffer, kSize capacity);
1026
1035 kFx(kStatus) k32f_Parse(k32f* value, const kChar* str);
1036
1051 kFx(kStatus) k64f_Format(k64f value, kChar* buffer, kSize capacity);
1052
1061 kFx(kStatus) k64f_Parse(k64f* value, const kChar* str);
1062
1071 typedef struct kPoint16s
1072 {
1073 k16s x;
1074 k16s y;
1075 } kPoint16s;
1076
1085 typedef struct kPoint32s
1086 {
1087 k32s x;
1088 k32s y;
1089 } kPoint32s;
1090
1099 typedef struct kPoint32f
1100 {
1101 k32f x;
1102 k32f y;
1103 } kPoint32f;
1104
1113 typedef struct kPoint64f
1114 {
1115 k64f x;
1116 k64f y;
1117 } kPoint64f;
1118
1126 #define kPoint_Init_(POINT, X, Y) kxPoint_Init_(POINT, X, Y)
1127
1136 typedef struct kPoint3d16s
1137 {
1138 k16s x;
1139 k16s y;
1140 k16s z;
1141 } kPoint3d16s;
1142
1151 typedef struct kPoint3d32s
1152 {
1153 k32s x;
1154 k32s y;
1155 k32s z;
1156 } kPoint3d32s;
1157
1166 typedef struct kPoint3d32f
1167 {
1168 k32f x;
1169 k32f y;
1170 k32f z;
1171 } kPoint3d32f;
1172
1181 typedef struct kPoint3d64f
1182 {
1183 k64f x;
1184 k64f y;
1185 k64f z;
1186 } kPoint3d64f;
1187
1196 #define kPoint3d_Init_(POINT, X, Y, Z) kxPoint3d_Init_(POINT, X, Y, Z)
1197
1206 typedef struct kRect16s
1207 {
1208 k16s x;
1209 k16s y;
1210 k16s width;
1211 k16s height;
1212 } kRect16s;
1213
1222 typedef struct kRect32s
1223 {
1224 k32s x;
1225 k32s y;
1226 k32s width;
1227 k32s height;
1228 } kRect32s;
1229
1238 typedef struct kRect32f
1239 {
1240 k32f x;
1241 k32f y;
1242 k32f width;
1243 k32f height;
1244 } kRect32f;
1245
1254 typedef struct kRect64f
1255 {
1256 k64f x;
1257 k64f y;
1258 k64f width;
1259 k64f height;
1260 } kRect64f;
1261
1271 #define kRect_Init_(RECT, X, Y, W, H) kxRect_Init_(RECT, X, Y, W, H)
1272
1281 typedef struct kRect3d64f
1282 {
1283 k64f x;
1284 k64f y;
1285 k64f z;
1286 k64f width;
1287 k64f height;
1288 k64f depth;
1289 } kRect3d64f;
1290
1302 #define kRect3d_Init_(RECT, X, Y, Z, W, H, D) kxRect3d_Init_(RECT, X, Y, Z, W, H, D)
1303
1312 typedef struct kRotatedRect32s
1313 {
1314 k32s xc;
1315 k32s yc;
1316 k32s width;
1317 k32s height;
1318 k32s angle;
1319 } kRotatedRect32s;
1320
1329 typedef struct kRotatedRect32f
1330 {
1331 k32f xc;
1332 k32f yc;
1333 k32f width;
1334 k32f height;
1335 k32f angle;
1336 } kRotatedRect32f;
1337
1348 #define kRotatedRect_Init_(RECT, XC, YC, W, H, A) kxRotatedRect_Init_(RECT, XC, YC, W, H, A)
1349
1358 typedef k32s kPixelFormat;
1359
1361 #define kPIXEL_FORMAT_NULL (0)
1362 #define kPIXEL_FORMAT_8BPP_GREYSCALE (1)
1363 #define kPIXEL_FORMAT_8BPP_CFA (2)
1364 #define kPIXEL_FORMAT_8BPC_BGRX (3)
1365
1375 typedef k32s kCfa;
1376
1378 #define kCFA_NONE (0)
1379 #define kCFA_BAYER_BGGR (1)
1380 #define kCFA_BAYER_GBRG (2)
1381 #define kCFA_BAYER_RGGB (3)
1382 #define kCFA_BAYER_GRBG (4)
1383
1393 typedef struct kRgb
1394 {
1395 k8u b;
1396 k8u g;
1397 k8u r;
1398 k8u x;
1399 } kRgb;
1400
1410 #define kRgb_Init_(RGB, R, G, B) kxRgb_Init_(RGB, R, G, B)
1411
1420 typedef struct kArgb
1421 {
1422 k8u b;
1423 k8u g;
1424 k8u r;
1425 k8u a;
1426 } kArgb;
1427
1438 #define kArgb_Init_(ARGB, A, R, G, B) kxArgb_Init_(ARGB, A, R, G, B)
1439
1446 typedef k32s kComparison;
1447
1448 #define kCOMPARISON_EQ (0)
1449 #define kCOMPARISON_NEQ (1)
1450 #define kCOMPARISON_LT (2)
1451 #define kCOMPARISON_LTE (3)
1452 #define kCOMPARISON_GT (4)
1453 #define kCOMPARISON_GTE (5)
1454
1455
1462 typedef kBool (kCall* kEqualsFx)(const void* item1, const void* item2);
1463
1470 typedef kSize (kCall* kHashFx)(const void* item);
1471
1480 typedef kStatus (kCall* kCallbackFx)(kPointer receiver, kPointer sender, void* args);
1481
1488 typedef struct kCallback
1489 {
1490 kCallbackFx function;
1491 kPointer receiver;
1492 } kCallback;
1493
1500 typedef k32s kFileMode;
1501
1503 #define kFILE_MODE_READ (0x1)
1504 #define kFILE_MODE_WRITE (0x2)
1505 #define kFILE_MODE_UPDATE (0x4)
1506
1514 typedef k32s kSeekOrigin;
1515
1516 #define kSEEK_ORIGIN_BEGIN (0)
1517 #define kSEEK_ORIGIN_CURRENT (1)
1518 #define kSEEK_ORIGIN_END (2)
1519
1520
1528 #define kCountOf(CARRAY) kCountOf_(CARRAY)
1529
1541 #define kCast(TYPE, ITEM) kCast_(TYPE, ITEM)
1542
1550 #define kMin_(A, B) kxMin_(A, B)
1551
1559 #define kMax_(A, B) kxMax_(A, B)
1560
1569 #define kClamp_(V, VMIN, VMAX) kxClamp_((V), (VMIN), (VMAX))
1570
1577 #define kAbs_(A) kxAbs_(A)
1578
1584 #define kZero_(VALUE) kxZero_(VALUE)
1585
1593 #define kItemCopy_(DEST, SRC, SIZE) kxItemCopy_(DEST, SRC, SIZE)
1594
1602 #define kItemSet_(DEST, FILL, SIZE) kxItemSet_(DEST, FILL, SIZE)
1603
1610 #define kItemZero_(DEST, SIZE) kItemSet_(DEST, 0, SIZE)
1611
1619 #define kItemAt_(BASE, INDEX, SIZE) kAt_((BASE), (INDEX)*(SIZE))
1620
1621
1647 #define kTypeOf(SYMBOL) kTypeOf_(SYMBOL)
1648
1674 #define kAssemblyOf(SYMBOL) kAssemblyOf_(SYMBOL)
1675
1684 #define kStaticOf(SYMBOL) kStaticOf_(SYMBOL)
1685
1692 #define kStaticInitialized(SYMBOL) kStaticInitialized_(SYMBOL)
1693
1701 #define kDeclareAssembly(PREFIX, SYMBOL) kDeclareAssembly_(PREFIX, SYMBOL)
1702
1711 #define kBeginAssembly(PREFIX, SYMBOL, VERSION) kBeginAssembly_(PREFIX, SYMBOL, VERSION)
1712
1718 #define kEndAssembly() kEndAssembly_()
1719
1728 #define kDeclareValue(PREFIX, SYMBOL, BASE) kDeclareValue_(PREFIX, SYMBOL, BASE)
1729
1738 #define kBeginValue(PREFIX, SYMBOL, BASE) kBeginValue_(PREFIX, SYMBOL, BASE)
1739
1745 #define kEndValue() kEndValue_()
1746
1755 #define kDeclareEnum(PREFIX, SYMBOL, BASE) kDeclareEnum_(PREFIX, SYMBOL, BASE)
1756
1765 #define kBeginEnum(PREFIX, SYMBOL, BASE) kBeginEnum_(PREFIX, SYMBOL, BASE)
1766
1772 #define kEndEnum() kEndEnum_()
1773
1782 #define kDeclareBitEnum(PREFIX, SYMBOL, BASE) kDeclareBitEnum_(PREFIX, SYMBOL, BASE)
1783
1792 #define kBeginBitEnum(PREFIX, SYMBOL, BASE) kBeginBitEnum_(PREFIX, SYMBOL, BASE)
1793
1799 #define kEndBitEnum() kEndBitEnum_()
1800
1809 #define kDeclareArrayValue(PREFIX, SYMBOL, BASE) kDeclareArrayValue_(PREFIX, SYMBOL, BASE)
1810
1820 #define kBeginArrayValue(PREFIX, SYMBOL, TYPE, BASE) kBeginArrayValue_(PREFIX, SYMBOL, TYPE, BASE)
1821
1827 #define kEndArrayValue() kEndArrayValue_()
1828
1837 #define kDeclareInterface(PREFIX, SYMBOL, BASE) kDeclareInterface_(PREFIX, SYMBOL, BASE)
1838
1847 #define kBeginInterface(PREFIX, SYMBOL, BASE) kBeginInterface_(PREFIX, SYMBOL, BASE)
1848
1854 #define kEndInterface() kEndInterface_()
1855
1864 #define kDeclareFullClass(PREFIX, SYMBOL, BASE) kDeclareFullClass_(PREFIX, SYMBOL, BASE)
1865
1874 #define kBeginFullClass(PREFIX, SYMBOL, BASE) kBeginFullClass_(PREFIX, SYMBOL, BASE)
1875
1881 #define kEndFullClass() kEndFullClass_()
1882
1891 #define kDeclareVirtualClass(PREFIX, SYMBOL, BASE) kDeclareVirtualClass_(PREFIX, SYMBOL, BASE)
1892
1901 #define kBeginVirtualClass(PREFIX, SYMBOL, BASE) kBeginVirtualClass_(PREFIX, SYMBOL, BASE)
1902
1908 #define kEndVirtualClass() kEndVirtualClass_()
1909
1917 #define kDeclareStaticClass(PREFIX, SYMBOL) kDeclareStaticClass_(PREFIX, SYMBOL)
1918
1926 #define kBeginStaticClass(PREFIX, SYMBOL) kBeginStaticClass_(PREFIX, SYMBOL)
1927
1933 #define kEndStaticClass() kEndStaticClass_()
1934
1943 #define kDeclareClass(PREFIX, SYMBOL, BASE) kDeclareClass_(PREFIX, SYMBOL, BASE)
1944
1953 #define kBeginClass(PREFIX, SYMBOL, BASE) kBeginClass_(PREFIX, SYMBOL, BASE)
1954
1960 #define kEndClass() kEndClass_()
1961
1968 #define kAddDependency(SYMBOL) kAddDependency_(SYMBOL)
1969
1976 #define kAddType(SYMBOL) kAddType_(SYMBOL)
1977
1988 #define kAddPriority(SYMBOL) kAddPriority_(SYMBOL)
1989
1997 #define kAddInterface(SYMBOL, IFACE) kAddInterface_(SYMBOL, IFACE)
1998
2006 #define kAddMethod(SYMBOL, METHOD) kAddMethod_(SYMBOL, METHOD)
2007
2016 #define kAddVMethod(IN_TYPE, FROM_TYPE, METHOD) kAddVMethod_(IN_TYPE, FROM_TYPE, METHOD)
2017
2027 #define kAddIVMethod(IN_TYPE, FROM_IFACE, IMETHOD, CMETHOD) kAddIVMethod_(IN_TYPE, FROM_IFACE, IMETHOD, CMETHOD)
2028
2037 #define kAddField(VALUE, FIELD_TYPE, FIELD) kAddField_(VALUE, FIELD_TYPE, FIELD)
2038
2046 #define kAddEnumerator kAddEnumerator_
2047
2059 #define kAddVersion(TYPE, FORMAT, FORMAT_VER, GUID, WRITE_METHOD, READ_METHOD) \
2060 kAddVersion_(TYPE, FORMAT, FORMAT_VER, GUID, WRITE_METHOD, READ_METHOD)
2061
2069 #define kAddFlags(TYPE, FLAGS) kAddFlags_(TYPE, FLAGS)
2070
2071
2093 #define kDefineDebugHints() kDefineDebugHints_()
2094
2095 kEndHeader()
2096
2097 #include <kApi/kApiDef.x.h>
2098
2099 #endif
kPoint32f::y
k32f y
Y-coordinate value.
Definition: kApiDef.h:1102
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:1287
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:1225
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:1259
kRect32f::x
k32f x
X-coordinate of the origin.
Definition: kApiDef.h:1240
kRect32s
Rectangle structure with 32-bit signed integer fields.
Definition: kApiDef.h:1222
kPoint3d32f
3D point structure with 32-bit floating-point fields.
Definition: kApiDef.h:1166
kRect64f::x
k64f x
X-coordinate of the origin.
Definition: kApiDef.h:1256
kRotatedRect32s::width
k32s width
Width of the rectangle.
Definition: kApiDef.h:1316
kRgb::b
k8u b
Blue component value.
Definition: kApiDef.h:1395
kPoint3d32s::y
k32s y
Y-coordinate value.
Definition: kApiDef.h:1154
kRect16s::width
k16s width
Width of the rectangle.
Definition: kApiDef.h:1210
kArgb
32-bit color pixel structure (B/G/R/A).
Definition: kApiDef.h:1420
kRect16s::y
k16s y
Y-coordinate of the origin.
Definition: kApiDef.h:1209
kPoint16s
2D point structure with 16-bit signed integer fields.
Definition: kApiDef.h:1071
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:1491
kRotatedRect32f
Rotated rectangle structure with 32-bit floating-point fields.
Definition: kApiDef.h:1329
kRect64f::y
k64f y
Y-coordinate of the origin.
Definition: kApiDef.h:1257
kPoint3d32s::z
k32s z
Z-coordinate value.
Definition: kApiDef.h:1155
kPointer
Represents a void pointer.
kRgb
32-bit color pixel structure (B/G/R/X).
Definition: kApiDef.h:1393
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:1101
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:1140
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:1314
kRotatedRect32s
Rotated rectangle structure with 32-bit signed integer fields.
Definition: kApiDef.h:1312
kRotatedRect32f::yc
k32f yc
Y-coordinate of the rectangle center.
Definition: kApiDef.h:1332
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:1318
kRect3d64f::width
k64f width
Width of the rectangular cuboid.
Definition: kApiDef.h:1286
k8u
Represents an 8-bit unsigned integer.
kRect3d64f::x
k64f x
X-coordinate of the origin.
Definition: kApiDef.h:1283
kRect3d64f::depth
k64f depth
Depth of the rectangular cuboid.
Definition: kApiDef.h:1288
kPoint3d64f::y
k64f y
Y-coordinate value.
Definition: kApiDef.h:1184
kPoint3d64f::x
k64f x
X-coordinate value.
Definition: kApiDef.h:1183
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:1073
kPoint3d16s::y
k16s y
Y-coordinate value.
Definition: kApiDef.h:1139
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:1470
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:1335
kSSize
Represents a signed integer that can store a pointer address.
kRect32s::height
k32s height
Height of the rectangle.
Definition: kApiDef.h:1227
kRect32f
Rectangle structure with 32-bit floating-point fields.
Definition: kApiDef.h:1238
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:1226
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:1087
kPixelFormat
Pixel format descriptor.
kRotatedRect32s::height
k32s height
Height of the rectangle.
Definition: kApiDef.h:1317
kRect64f
Rectangle structure with 64-bit floating-point fields.
Definition: kApiDef.h:1254
kText128
Represents a 128-unit, null-terminated, kChar sequence.
kPoint3d32f::x
k32f x
X-coordinate value.
Definition: kApiDef.h:1168
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:1462
kVersion::kVersion_Major
k8u kVersion_Major(kVersion version)
Returns the major part of a version number.
kPoint16s::y
k16s y
Y-coordinate value.
Definition: kApiDef.h:1074
kPoint3d16s::x
k16s x
X-coordinate value.
Definition: kApiDef.h:1138
kPoint3d32f::z
k32f z
Z-coordinate value.
Definition: kApiDef.h:1170
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:1258
kPoint3d64f::z
k64f z
Z-coordinate value.
Definition: kApiDef.h:1185
kCallback
Represents a callback function and context pointer.
Definition: kApiDef.h:1488
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:1424
kPoint32f
2D point structure with 32-bit floating-point fields.
Definition: kApiDef.h:1099
kRect3d64f::y
k64f y
Y-coordinate of the origin.
Definition: kApiDef.h:1284
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:1315
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:1397
kRotatedRect32f::height
k32f height
Height of the rectangle.
Definition: kApiDef.h:1334
kPoint64f::x
k64f x
X-coordinate value.
Definition: kApiDef.h:1115
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:1113
kCallbackFx
kStatus(kCall * kCallbackFx)(kPointer receiver, kPointer sender, void *args)
Callback signature for a generic event handler.
Definition: kApiDef.h:1480
kRgb::g
k8u g
Green component value.
Definition: kApiDef.h:1396
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:1333
kArgb::b
k8u b
Blue component value.
Definition: kApiDef.h:1422
kRect16s::height
k16s height
Height of the rectangle.
Definition: kApiDef.h:1211
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:1423
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:1153
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:1136
k16s
Represents a 16-bit signed integer.
kRect32f::y
k32f y
Y-coordinate of the origin.
Definition: kApiDef.h:1241
k32f
Represents a 32-bit floating-point number.
kPoint64f::y
k64f y
Y-coordinate value.
Definition: kApiDef.h:1116
kVersion
Represents a version number.
kArgb::a
k8u a
Alpha component value.
Definition: kApiDef.h:1425
kStatus
Represents an error code.
kRect3d64f::z
k64f z
Z-coordinate of the origin.
Definition: kApiDef.h:1285
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:1398
kPoint32s::y
k32s y
Y-coordinate value.
Definition: kApiDef.h:1088
kCall
#define kCall
kApi standard function calling convention.
Definition: kApiDef.h:17
kRect32f::width
k32f width
Width of the rectangle.
Definition: kApiDef.h:1242
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:1281
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:1206
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:1224
kRotatedRect32f::xc
k32f xc
X-coordinate of the rectangle center.
Definition: kApiDef.h:1331
kPoint32s
2D point structure with 32-bit signed integer fields.
Definition: kApiDef.h:1085
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:1208
kRect32f::height
k32f height
Height of the rectangle.
Definition: kApiDef.h:1243
kPoint3d64f
3D point structure with 64-bit floating-point fields.
Definition: kApiDef.h:1181
kPoint3d32s
3D point structure with 32-bit signed integer fields.
Definition: kApiDef.h:1151
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:1169
k8s::k8s_Parse
kStatus k8s_Parse(k8s *value, const kChar *str)
Converts string to k8s value.