khrplatform.h 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272
  1. #ifndef __khrplatform_h_
  2. #define __khrplatform_h_
  3. /*
  4. ** Copyright (c) 2008-2009 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. * $Revision: 9356 $ on $Date: 2009-10-21 02:52:25 -0700 (Wed, 21 Oct 2009) $
  28. *
  29. * Adopters may modify this file to suit their platform. Adopters are
  30. * encouraged to submit platform specific modifications to the Khronos
  31. * group so that they can be included in future versions of this file.
  32. * Please submit changes by sending them to the public Khronos Bugzilla
  33. * (http://khronos.org/bugzilla) by filing a bug against product
  34. * "Khronos (general)" component "Registry".
  35. *
  36. * A predefined template which fills in some of the bug fields can be
  37. * reached using http://tinyurl.com/khrplatform-h-bugreport, but you
  38. * must create a Bugzilla login first.
  39. *
  40. *
  41. * See the Implementer's Guidelines for information about where this file
  42. * should be located on your system and for more details of its use:
  43. * http://www.khronos.org/registry/implementers_guide.pdf
  44. *
  45. * This file should be included as
  46. * #include <KHR/khrplatform.h>
  47. * by Khronos client API header files that use its types and defines.
  48. *
  49. * The types in khrplatform.h should only be used to define API-specific types.
  50. *
  51. * Types defined in khrplatform.h:
  52. * khronos_int8_t signed 8 bit
  53. * khronos_uint8_t unsigned 8 bit
  54. * khronos_int16_t signed 16 bit
  55. * khronos_uint16_t unsigned 16 bit
  56. * khronos_int32_t signed 32 bit
  57. * khronos_uint32_t unsigned 32 bit
  58. * khronos_int64_t signed 64 bit
  59. * khronos_uint64_t unsigned 64 bit
  60. * khronos_intptr_t signed same number of bits as a pointer
  61. * khronos_uintptr_t unsigned same number of bits as a pointer
  62. * khronos_ssize_t signed size
  63. * khronos_usize_t unsigned size
  64. * khronos_float_t signed 32 bit floating point
  65. * khronos_time_ns_t unsigned 64 bit time in nanoseconds
  66. * khronos_utime_nanoseconds_t unsigned time interval or absolute time in
  67. * nanoseconds
  68. * khronos_stime_nanoseconds_t signed time interval in nanoseconds
  69. * khronos_boolean_enum_t enumerated boolean type. This should
  70. * only be used as a base type when a client API's boolean type is
  71. * an enum. Client APIs which use an integer or other type for
  72. * booleans cannot use this as the base type for their boolean.
  73. *
  74. * Tokens defined in khrplatform.h:
  75. *
  76. * KHRONOS_FALSE, KHRONOS_TRUE Enumerated boolean false/true values.
  77. *
  78. * KHRONOS_SUPPORT_INT64 is 1 if 64 bit integers are supported; otherwise 0.
  79. * KHRONOS_SUPPORT_FLOAT is 1 if floats are supported; otherwise 0.
  80. *
  81. * Calling convention macros defined in this file:
  82. * KHRONOS_APICALL
  83. * KHRONOS_APIENTRY
  84. * KHRONOS_APIATTRIBUTES
  85. *
  86. * These may be used in function prototypes as:
  87. *
  88. * KHRONOS_APICALL void KHRONOS_APIENTRY funcname(
  89. * int arg1,
  90. * int arg2) KHRONOS_APIATTRIBUTES;
  91. */
  92. /*-------------------------------------------------------------------------
  93. * Definition of KHRONOS_APICALL
  94. *-------------------------------------------------------------------------
  95. * This precedes the return type of the function in the function prototype.
  96. */
  97. #if defined(_WIN32) && !defined(__SCITECH_SNAP__)
  98. # define KHRONOS_APICALL __declspec(dllimport)
  99. #elif defined (__SYMBIAN32__)
  100. # define KHRONOS_APICALL IMPORT_C
  101. #elif defined(ANDROID)
  102. # define KHRONOS_APICALL __attribute__((visibility("default")))
  103. #else
  104. # define KHRONOS_APICALL
  105. #endif
  106. /*-------------------------------------------------------------------------
  107. * Definition of KHRONOS_APIENTRY
  108. *-------------------------------------------------------------------------
  109. * This follows the return type of the function and precedes the function
  110. * name in the function prototype.
  111. */
  112. #if defined(_WIN32) && !defined(_WIN32_WCE) && !defined(__SCITECH_SNAP__)
  113. /* Win32 but not WinCE */
  114. # define KHRONOS_APIENTRY __stdcall
  115. #else
  116. # define KHRONOS_APIENTRY
  117. #endif
  118. /*-------------------------------------------------------------------------
  119. * Definition of KHRONOS_APIATTRIBUTES
  120. *-------------------------------------------------------------------------
  121. * This follows the closing parenthesis of the function prototype arguments.
  122. */
  123. #if defined (__ARMCC_2__)
  124. #define KHRONOS_APIATTRIBUTES __softfp
  125. #else
  126. #define KHRONOS_APIATTRIBUTES
  127. #endif
  128. /*-------------------------------------------------------------------------
  129. * basic type definitions
  130. *-----------------------------------------------------------------------*/
  131. #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || defined(__GNUC__) || defined(__SCO__) || defined(__USLC__)
  132. /*
  133. * Using <stdint.h>
  134. */
  135. #include <stdint.h>
  136. typedef int32_t khronos_int32_t;
  137. typedef uint32_t khronos_uint32_t;
  138. typedef int64_t khronos_int64_t;
  139. typedef uint64_t khronos_uint64_t;
  140. #define KHRONOS_SUPPORT_INT64 1
  141. #define KHRONOS_SUPPORT_FLOAT 1
  142. #elif defined(__VMS ) || defined(__sgi)
  143. /*
  144. * Using <inttypes.h>
  145. */
  146. #include <inttypes.h>
  147. typedef int32_t khronos_int32_t;
  148. typedef uint32_t khronos_uint32_t;
  149. typedef int64_t khronos_int64_t;
  150. typedef uint64_t khronos_uint64_t;
  151. #define KHRONOS_SUPPORT_INT64 1
  152. #define KHRONOS_SUPPORT_FLOAT 1
  153. #elif defined(_WIN32) && !defined(__SCITECH_SNAP__)
  154. /*
  155. * Win32
  156. */
  157. typedef __int32 khronos_int32_t;
  158. typedef unsigned __int32 khronos_uint32_t;
  159. typedef __int64 khronos_int64_t;
  160. typedef unsigned __int64 khronos_uint64_t;
  161. #define KHRONOS_SUPPORT_INT64 1
  162. #define KHRONOS_SUPPORT_FLOAT 1
  163. #elif defined(__sun__) || defined(__digital__)
  164. /*
  165. * Sun or Digital
  166. */
  167. typedef int khronos_int32_t;
  168. typedef unsigned int khronos_uint32_t;
  169. #if defined(__arch64__) || defined(_LP64)
  170. typedef long int khronos_int64_t;
  171. typedef unsigned long int khronos_uint64_t;
  172. #else
  173. typedef long long int khronos_int64_t;
  174. typedef unsigned long long int khronos_uint64_t;
  175. #endif /* __arch64__ */
  176. #define KHRONOS_SUPPORT_INT64 1
  177. #define KHRONOS_SUPPORT_FLOAT 1
  178. #elif 0
  179. /*
  180. * Hypothetical platform with no float or int64 support
  181. */
  182. typedef int khronos_int32_t;
  183. typedef unsigned int khronos_uint32_t;
  184. #define KHRONOS_SUPPORT_INT64 0
  185. #define KHRONOS_SUPPORT_FLOAT 0
  186. #else
  187. /*
  188. * Generic fallback
  189. */
  190. #include <stdint.h>
  191. typedef int32_t khronos_int32_t;
  192. typedef uint32_t khronos_uint32_t;
  193. typedef int64_t khronos_int64_t;
  194. typedef uint64_t khronos_uint64_t;
  195. #define KHRONOS_SUPPORT_INT64 1
  196. #define KHRONOS_SUPPORT_FLOAT 1
  197. #endif
  198. /*
  199. * Types that are (so far) the same on all platforms
  200. */
  201. typedef signed char khronos_int8_t;
  202. typedef unsigned char khronos_uint8_t;
  203. typedef signed short int khronos_int16_t;
  204. typedef unsigned short int khronos_uint16_t;
  205. typedef signed long int khronos_intptr_t;
  206. typedef unsigned long int khronos_uintptr_t;
  207. typedef signed long int khronos_ssize_t;
  208. typedef unsigned long int khronos_usize_t;
  209. #if KHRONOS_SUPPORT_FLOAT
  210. /*
  211. * Float type
  212. */
  213. typedef float khronos_float_t;
  214. #endif
  215. #if KHRONOS_SUPPORT_INT64
  216. /* Time types
  217. *
  218. * These types can be used to represent a time interval in nanoseconds or
  219. * an absolute Unadjusted System Time. Unadjusted System Time is the number
  220. * of nanoseconds since some arbitrary system event (e.g. since the last
  221. * time the system booted). The Unadjusted System Time is an unsigned
  222. * 64 bit value that wraps back to 0 every 584 years. Time intervals
  223. * may be either signed or unsigned.
  224. */
  225. typedef khronos_uint64_t khronos_utime_nanoseconds_t;
  226. typedef khronos_int64_t khronos_stime_nanoseconds_t;
  227. #endif
  228. /*
  229. * Dummy value used to pad enum types to 32 bits.
  230. */
  231. #ifndef KHRONOS_MAX_ENUM
  232. #define KHRONOS_MAX_ENUM 0x7FFFFFFF
  233. #endif
  234. /*
  235. * Enumerated boolean type
  236. *
  237. * Values other than zero should be considered to be true. Therefore
  238. * comparisons should not be made against KHRONOS_TRUE.
  239. */
  240. typedef enum {
  241. KHRONOS_FALSE = 0,
  242. KHRONOS_TRUE = 1,
  243. KHRONOS_BOOLEAN_ENUM_FORCE_SIZE = KHRONOS_MAX_ENUM
  244. } khronos_boolean_enum_t;
  245. #endif /* __khrplatform_h_ */