KHR/khrplatform.h

   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  * 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 /*-------------------------------------------------------------------------
  94  * Definition of KHRONOS_APICALL
  95  *-------------------------------------------------------------------------
  96  * This precedes the return type of the function in the function prototype.
  97  */
  98 #   define KHRONOS_APICALL
  99
 100 /*-------------------------------------------------------------------------
 101  * Definition of KHRONOS_APIENTRY
 102  *-------------------------------------------------------------------------
 103  * This follows the return type of the function  and precedes the function
 104  * name in the function prototype.
 105  */
 106 #   define KHRONOS_APIENTRY
 107
 108 /*-------------------------------------------------------------------------
 109  * Definition of KHRONOS_APIATTRIBUTES
 110  *-------------------------------------------------------------------------
 111  * This follows the closing parenthesis of the function prototype arguments.
 112  */
 113 #if defined (__ARMCC_2__)
 114 #define KHRONOS_APIATTRIBUTES __softfp
 115 #else
 116 #define KHRONOS_APIATTRIBUTES
 117 #endif
 118
 119 /*-------------------------------------------------------------------------
 120  * basic type definitions
 121  *-----------------------------------------------------------------------*/
 122 #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || defined(__GNUC__) || defined(__SCO__) || defined(__USLC__)
 123
 124
 125 /*
 126  * Using <stdint.h>
 127  */
 128 #include <stdint.h>
 129 typedef int32_t                 khronos_int32_t;
 130 typedef uint32_t                khronos_uint32_t;
 131 typedef int64_t                 khronos_int64_t;
 132 typedef uint64_t                khronos_uint64_t;
 133 #define KHRONOS_SUPPORT_INT64   1
 134 #define KHRONOS_SUPPORT_FLOAT   1
 135
 136 #else
 137 #if defined(__VMS ) || defined(__sgi)
 138
 139 /*
 140  * Using <inttypes.h>
 141  */
 142 #include <inttypes.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
 150 #else
 151 #if defined(__sun__) || defined(__digital__)
 152
 153 /*
 154  * Sun or Digital
 155  */
 156 typedef int                     khronos_int32_t;
 157 typedef unsigned int            khronos_uint32_t;
 158 #if defined(__arch64__) || defined(_LP64)
 159 typedef long int                khronos_int64_t;
 160 typedef unsigned long int       khronos_uint64_t;
 161 #else
 162 typedef long long int           khronos_int64_t;
 163 typedef unsigned long long int  khronos_uint64_t;
 164 #endif /* __arch64__ */
 165 #define KHRONOS_SUPPORT_INT64   1
 166 #define KHRONOS_SUPPORT_FLOAT   1
 167
 168 #else
 169 #if 0
 170
 171 /*
 172  * Hypothetical platform with no float or int64 support
 173  */
 174 typedef int                     khronos_int32_t;
 175 typedef unsigned int            khronos_uint32_t;
 176 #define KHRONOS_SUPPORT_INT64   0
 177 #define KHRONOS_SUPPORT_FLOAT   0
 178
 179 #else
 180
 181 /*
 182  * Generic fallback
 183  */
 184 #include <stdint.h>
 185 typedef int32_t                 khronos_int32_t;
 186 typedef uint32_t                khronos_uint32_t;
 187 typedef int64_t                 khronos_int64_t;
 188 typedef uint64_t                khronos_uint64_t;
 189 #define KHRONOS_SUPPORT_INT64   1
 190 #define KHRONOS_SUPPORT_FLOAT   1
 191
 192 #endif
 193 #endif
 194 #endif
 195 #endif
 196
 197 /*
 198  * Types that are (so far) the same on all platforms
 199  */
 200 typedef signed   char          khronos_int8_t;
 201 typedef unsigned char          khronos_uint8_t;
 202 typedef signed   short int     khronos_int16_t;
 203 typedef unsigned short int     khronos_uint16_t;
 204 typedef signed   long  int     khronos_intptr_t;
 205 typedef unsigned long  int     khronos_uintptr_t;
 206 typedef signed   long  int     khronos_ssize_t;
 207 typedef unsigned long  int     khronos_usize_t;
 208
 209 #if KHRONOS_SUPPORT_FLOAT
 210 /*
 211  * Float type
 212  */
 213 typedef          float         khronos_float_t;
 214 #endif
 215
 216 #if KHRONOS_SUPPORT_INT64
 217 /* Time types
 218  *
 219  * These types can be used to represent a time interval in nanoseconds or
 220  * an absolute Unadjusted System Time.  Unadjusted System Time is the number
 221  * of nanoseconds since some arbitrary system event (e.g. since the last
 222  * time the system booted).  The Unadjusted System Time is an unsigned
 223  * 64 bit value that wraps back to 0 every 584 years.  Time intervals
 224  * may be either signed or unsigned.
 225  */
 226 typedef khronos_uint64_t       khronos_utime_nanoseconds_t;
 227 typedef khronos_int64_t        khronos_stime_nanoseconds_t;
 228 #endif
 229
 230 /*
 231  * Dummy value used to pad enum types to 32 bits.
 232  */
 233 #ifndef KHRONOS_MAX_ENUM
 234 #define KHRONOS_MAX_ENUM 0x7FFFFFFF
 235 #endif
 236
 237 /*
 238  * Enumerated boolean type
 239  *
 240  * Values other than zero should be considered to be true.  Therefore
 241  * comparisons should not be made against KHRONOS_TRUE.
 242  */
 243 typedef enum {
 244     KHRONOS_FALSE = 0,
 245     KHRONOS_TRUE  = 1,
 246     KHRONOS_BOOLEAN_ENUM_FORCE_SIZE = KHRONOS_MAX_ENUM
 247 } khronos_boolean_enum_t;
 248
 249 #endif /* __khrplatform_h_ */