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