khrplatform.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  1. #ifndef __khrplatform_h_
  2. #define __khrplatform_h_
  3. /*
  4. ** Copyright (c) 2008-2018 The Khronos Group Inc.
  5. **
  6. ** Permission is hereby granted, free of charge, to any person obtaining a
  7. ** copy of this software and/or associated documentation files (the
  8. ** "Materials"), to deal in the Materials without restriction, including
  9. ** without limitation the rights to use, copy, modify, merge, publish,
  10. ** distribute, sublicense, and/or sell copies of the Materials, and to
  11. ** permit persons to whom the Materials are furnished to do so, subject to
  12. ** the following conditions:
  13. **
  14. ** The above copyright notice and this permission notice shall be included
  15. ** in all copies or substantial portions of the Materials.
  16. **
  17. ** THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  18. ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19. ** MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  20. ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  21. ** CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  22. ** TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  23. ** MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
  24. */
  25. /* Khronos platform-specific types and definitions.
  26. *
  27. * The master copy of khrplatform.h is maintained in the Khronos EGL
  28. * Registry repository at https://github.com/KhronosGroup/EGL-Registry
  29. * The last semantic modification to khrplatform.h was at commit ID:
  30. * 67a3e0864c2d75ea5287b9f3d2eb74a745936692
  31. *
  32. * Adopters may modify this file to suit their platform. Adopters are
  33. * encouraged to submit platform specific modifications to the Khronos
  34. * group so that they can be included in future versions of this file.
  35. * Please submit changes by filing pull requests or issues on
  36. * the EGL Registry repository linked above.
  37. *
  38. *
  39. * See the Implementer's Guidelines for information about where this file
  40. * should be located on your system and for more details of its use:
  41. * http://www.khronos.org/registry/implementers_guide.pdf
  42. *
  43. * This file should be included as
  44. * #include <KHR/khrplatform.h>
  45. * by Khronos client API header files that use its types and defines.
  46. *
  47. * The types in khrplatform.h should only be used to define API-specific types.
  48. *
  49. * Types defined in khrplatform.h:
  50. * khronos_int8_t signed 8 bit
  51. * khronos_uint8_t unsigned 8 bit
  52. * khronos_int16_t signed 16 bit
  53. * khronos_uint16_t unsigned 16 bit
  54. * khronos_int32_t signed 32 bit
  55. * khronos_uint32_t unsigned 32 bit
  56. * khronos_int64_t signed 64 bit
  57. * khronos_uint64_t unsigned 64 bit
  58. * khronos_intptr_t signed same number of bits as a pointer
  59. * khronos_uintptr_t unsigned same number of bits as a pointer
  60. * khronos_ssize_t signed size
  61. * khronos_usize_t unsigned size
  62. * khronos_float_t signed 32 bit floating point
  63. * khronos_time_ns_t unsigned 64 bit time in nanoseconds
  64. * khronos_utime_nanoseconds_t unsigned time interval or absolute time in
  65. * nanoseconds
  66. * khronos_stime_nanoseconds_t signed time interval in nanoseconds
  67. * khronos_boolean_enum_t enumerated boolean type. This should
  68. * only be used as a base type when a client API's boolean type is
  69. * an enum. Client APIs which use an integer or other type for
  70. * booleans cannot use this as the base type for their boolean.
  71. *
  72. * Tokens defined in khrplatform.h:
  73. *
  74. * KHRONOS_FALSE, KHRONOS_TRUE Enumerated boolean false/true values.
  75. *
  76. * KHRONOS_SUPPORT_INT64 is 1 if 64 bit integers are supported; otherwise 0.
  77. * KHRONOS_SUPPORT_FLOAT is 1 if floats are supported; otherwise 0.
  78. *
  79. * Calling convention macros defined in this file:
  80. * KHRONOS_APICALL
  81. * KHRONOS_APIENTRY
  82. * KHRONOS_APIATTRIBUTES
  83. *
  84. * These may be used in function prototypes as:
  85. *
  86. * KHRONOS_APICALL void KHRONOS_APIENTRY funcname(
  87. * int arg1,
  88. * int arg2) KHRONOS_APIATTRIBUTES;
  89. */
  90. #if defined(__SCITECH_SNAP__) && !defined(KHRONOS_STATIC)
  91. # define KHRONOS_STATIC 1
  92. #endif
  93. /*-------------------------------------------------------------------------
  94. * Definition of KHRONOS_APICALL
  95. *-------------------------------------------------------------------------
  96. * This precedes the return type of the function in the function prototype.
  97. */
  98. #if defined(KHRONOS_STATIC)
  99. /* If the preprocessor constant KHRONOS_STATIC is defined, make the
  100. * header compatible with static linking. */
  101. # define KHRONOS_APICALL
  102. #elif defined(_WIN32)
  103. # define KHRONOS_APICALL __declspec(dllimport)
  104. #elif defined (__SYMBIAN32__)
  105. # define KHRONOS_APICALL IMPORT_C
  106. #elif (defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 303) \
  107. || (defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590))
  108. /* KHRONOS_APIATTRIBUTES is not used by the client API headers yet */
  109. # define KHRONOS_APICALL __attribute__((visibility("default")))
  110. #else
  111. # define KHRONOS_APICALL
  112. #endif
  113. /*-------------------------------------------------------------------------
  114. * Definition of KHRONOS_APIENTRY
  115. *-------------------------------------------------------------------------
  116. * This follows the return type of the function and precedes the function
  117. * name in the function prototype.
  118. */
  119. #if defined(_WIN32) && !defined(_WIN32_WCE) && !defined(KHRONOS_STATIC)
  120. /* Win32 but not WinCE */
  121. # define KHRONOS_APIENTRY __stdcall
  122. #else
  123. # define KHRONOS_APIENTRY
  124. #endif
  125. /*-------------------------------------------------------------------------
  126. * Definition of KHRONOS_APIATTRIBUTES
  127. *-------------------------------------------------------------------------
  128. * This follows the closing parenthesis of the function prototype arguments.
  129. */
  130. #if defined (__ARMCC_2__)
  131. #define KHRONOS_APIATTRIBUTES __softfp
  132. #else
  133. #define KHRONOS_APIATTRIBUTES
  134. #endif
  135. /*-------------------------------------------------------------------------
  136. * basic type definitions
  137. *-----------------------------------------------------------------------*/
  138. #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || defined(__GNUC__) || defined(__SCO__) || defined(__USLC__)
  139. /*
  140. * Using <stdint.h>
  141. */
  142. #include <stdint.h>
  143. typedef int32_t khronos_int32_t;
  144. typedef uint32_t khronos_uint32_t;
  145. typedef int64_t khronos_int64_t;
  146. typedef uint64_t khronos_uint64_t;
  147. #define KHRONOS_SUPPORT_INT64 1
  148. #define KHRONOS_SUPPORT_FLOAT 1
  149. #elif defined(__VMS ) || defined(__sgi)
  150. /*
  151. * Using <inttypes.h>
  152. */
  153. #include <inttypes.h>
  154. typedef int32_t khronos_int32_t;
  155. typedef uint32_t khronos_uint32_t;
  156. typedef int64_t khronos_int64_t;
  157. typedef uint64_t khronos_uint64_t;
  158. #define KHRONOS_SUPPORT_INT64 1
  159. #define KHRONOS_SUPPORT_FLOAT 1
  160. #elif defined(_WIN32) && !defined(__SCITECH_SNAP__)
  161. /*
  162. * Win32
  163. */
  164. typedef __int32 khronos_int32_t;
  165. typedef unsigned __int32 khronos_uint32_t;
  166. typedef __int64 khronos_int64_t;
  167. typedef unsigned __int64 khronos_uint64_t;
  168. #define KHRONOS_SUPPORT_INT64 1
  169. #define KHRONOS_SUPPORT_FLOAT 1
  170. #elif defined(__sun__) || defined(__digital__)
  171. /*
  172. * Sun or Digital
  173. */
  174. typedef int khronos_int32_t;
  175. typedef unsigned int khronos_uint32_t;
  176. #if defined(__arch64__) || defined(_LP64)
  177. typedef long int khronos_int64_t;
  178. typedef unsigned long int khronos_uint64_t;
  179. #else
  180. typedef long long int khronos_int64_t;
  181. typedef unsigned long long int khronos_uint64_t;
  182. #endif /* __arch64__ */
  183. #define KHRONOS_SUPPORT_INT64 1
  184. #define KHRONOS_SUPPORT_FLOAT 1
  185. #elif 0
  186. /*
  187. * Hypothetical platform with no float or int64 support
  188. */
  189. typedef int khronos_int32_t;
  190. typedef unsigned int khronos_uint32_t;
  191. #define KHRONOS_SUPPORT_INT64 0
  192. #define KHRONOS_SUPPORT_FLOAT 0
  193. #else
  194. /*
  195. * Generic fallback
  196. */
  197. #include <stdint.h>
  198. typedef int32_t khronos_int32_t;
  199. typedef uint32_t khronos_uint32_t;
  200. typedef int64_t khronos_int64_t;
  201. typedef uint64_t khronos_uint64_t;
  202. #define KHRONOS_SUPPORT_INT64 1
  203. #define KHRONOS_SUPPORT_FLOAT 1
  204. #endif
  205. /*
  206. * Types that are (so far) the same on all platforms
  207. */
  208. typedef signed char khronos_int8_t;
  209. typedef unsigned char khronos_uint8_t;
  210. typedef signed short int khronos_int16_t;
  211. typedef unsigned short int khronos_uint16_t;
  212. /*
  213. * Types that differ between LLP64 and LP64 architectures - in LLP64,
  214. * pointers are 64 bits, but 'long' is still 32 bits. Win64 appears
  215. * to be the only LLP64 architecture in current use.
  216. */
  217. #ifdef _WIN64
  218. typedef signed long long int khronos_intptr_t;
  219. typedef unsigned long long int khronos_uintptr_t;
  220. typedef signed long long int khronos_ssize_t;
  221. typedef unsigned long long int khronos_usize_t;
  222. #else
  223. typedef signed long int khronos_intptr_t;
  224. typedef unsigned long int khronos_uintptr_t;
  225. typedef signed long int khronos_ssize_t;
  226. typedef unsigned long int khronos_usize_t;
  227. #endif
  228. #if KHRONOS_SUPPORT_FLOAT
  229. /*
  230. * Float type
  231. */
  232. typedef float khronos_float_t;
  233. #endif
  234. #if KHRONOS_SUPPORT_INT64
  235. /* Time types
  236. *
  237. * These types can be used to represent a time interval in nanoseconds or
  238. * an absolute Unadjusted System Time. Unadjusted System Time is the number
  239. * of nanoseconds since some arbitrary system event (e.g. since the last
  240. * time the system booted). The Unadjusted System Time is an unsigned
  241. * 64 bit value that wraps back to 0 every 584 years. Time intervals
  242. * may be either signed or unsigned.
  243. */
  244. typedef khronos_uint64_t khronos_utime_nanoseconds_t;
  245. typedef khronos_int64_t khronos_stime_nanoseconds_t;
  246. #endif
  247. /*
  248. * Dummy value used to pad enum types to 32 bits.
  249. */
  250. #ifndef KHRONOS_MAX_ENUM
  251. #define KHRONOS_MAX_ENUM 0x7FFFFFFF
  252. #endif
  253. /*
  254. * Enumerated boolean type
  255. *
  256. * Values other than zero should be considered to be true. Therefore
  257. * comparisons should not be made against KHRONOS_TRUE.
  258. */
  259. typedef enum {
  260. KHRONOS_FALSE = 0,
  261. KHRONOS_TRUE = 1,
  262. KHRONOS_BOOLEAN_ENUM_FORCE_SIZE = KHRONOS_MAX_ENUM
  263. } khronos_boolean_enum_t;
  264. #endif /* __khrplatform_h_ */