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