Home | History | Annotate | Download | only in KHR
      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 /* Platform-specific types and definitions.
     28  * $Revision: 7244 $ on $Date: 2009-01-20 17:06:59 -0800 (Tue, 20 Jan 2009) $
     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.
     44  *    http://www.khronos.org/registry/implementers_guide.pdf
     45  *
     46  *
     47  * This file should be included as
     48  *        #include <KHR/khrplatform.h>
     49  * by the Khronos API header file that uses its types and defines.
     50  *
     51  * The types in this file should only be used to define API-specific types.
     52  * Types defined in this file:
     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  *
     71  * KHRONOS_SUPPORT_INT64 is 1 if 64 bit integers are supported; otherwise 0.
     72  * KHRONOS_SUPPORT_FLOAT is 1 if floats are supported; otherwise 0.
     73  *
     74  *
     75  * Macros defined in this file:
     76  *    KHRONOS_APICALL
     77  *    KHRONOS_APIENTRY
     78  *    KHRONOS_APIATTRIBUTES
     79  * These may be used in function prototypes as:
     80  *      KHRONOS_APICALL void KHRONOS_APIENTRY funcname(
     81  *                                  int arg1,
     82  *                                  int arg2) KHRONOS_APIATTRIBUTES;
     83  */
     84 
     85 /*-------------------------------------------------------------------------
     86  * Definition of KHRONOS_APICALL
     87  *-------------------------------------------------------------------------
     88  * This precedes the return type of the function in the function prototype.
     89  */
     90 #if defined(_WIN32) && !defined(__SCITECH_SNAP__)
     91 #   define KHRONOS_APICALL __declspec(dllimport)
     92 #elif defined (__SYMBIAN32__)
     93 #   define KHRONOS_APICALL IMPORT_C
     94 #elif defined(ANDROID)
     95 #   define KHRONOS_APICALL __attribute__((visibility("default")))
     96 #else
     97 #   define KHRONOS_APICALL
     98 #endif
     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 #if defined(_WIN32) && !defined(_WIN32_WCE) && !defined(__SCITECH_SNAP__)
    107     /* Win32 but not WinCE */
    108 #   define KHRONOS_APIENTRY __stdcall
    109 #else
    110 #   define KHRONOS_APIENTRY
    111 #endif
    112 
    113 /*-------------------------------------------------------------------------
    114  * Definition of KHRONOS_APIATTRIBUTES
    115  *-------------------------------------------------------------------------
    116  * This follows the closing parenthesis of the function prototype arguments.
    117  */
    118 #if defined (__ARMCC_2__)
    119 #define KHRONOS_APIATTRIBUTES __softfp
    120 #else
    121 #define KHRONOS_APIATTRIBUTES
    122 #endif
    123 
    124 /*-------------------------------------------------------------------------
    125  * basic type definitions
    126  *-----------------------------------------------------------------------*/
    127 #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || defined(__GNUC__) || defined(__SCO__) || defined(__USLC__)
    128 
    129 
    130 /*
    131  * Using <stdint.h>
    132  */
    133 #include <stdint.h>
    134 typedef int32_t                 khronos_int32_t;
    135 typedef uint32_t                khronos_uint32_t;
    136 typedef int64_t                 khronos_int64_t;
    137 typedef uint64_t                khronos_uint64_t;
    138 #define KHRONOS_SUPPORT_INT64   1
    139 #define KHRONOS_SUPPORT_FLOAT   1
    140 
    141 #elif defined(__VMS ) || defined(__sgi)
    142 
    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 
    154 #elif defined(_WIN32) && !defined(__SCITECH_SNAP__)
    155 
    156 /*
    157  * Win32
    158  */
    159 typedef __int32                 khronos_int32_t;
    160 typedef unsigned __int32        khronos_uint32_t;
    161 typedef __int64                 khronos_int64_t;
    162 typedef unsigned __int64        khronos_uint64_t;
    163 #define KHRONOS_SUPPORT_INT64   1
    164 #define KHRONOS_SUPPORT_FLOAT   1
    165 
    166 #elif defined(__sun__) || defined(__digital__)
    167 
    168 /*
    169  * Sun or Digital
    170  */
    171 typedef int                     khronos_int32_t;
    172 typedef unsigned int            khronos_uint32_t;
    173 #if defined(__arch64__) || defined(_LP64)
    174 typedef long int                khronos_int64_t;
    175 typedef unsigned long int       khronos_uint64_t;
    176 #else
    177 typedef long long int           khronos_int64_t;
    178 typedef unsigned long long int  khronos_uint64_t;
    179 #endif /* __arch64__ */
    180 #define KHRONOS_SUPPORT_INT64   1
    181 #define KHRONOS_SUPPORT_FLOAT   1
    182 
    183 #elif 0
    184 
    185 /*
    186  * Hypothetical platform with no float or int64 support
    187  */
    188 typedef int                     khronos_int32_t;
    189 typedef unsigned int            khronos_uint32_t;
    190 #define KHRONOS_SUPPORT_INT64   0
    191 #define KHRONOS_SUPPORT_FLOAT   0
    192 
    193 #else
    194 
    195 /*
    196  * Generic fallback
    197  */
    198 #include <stdint.h>
    199 typedef int32_t                 khronos_int32_t;
    200 typedef uint32_t                khronos_uint32_t;
    201 typedef int64_t                 khronos_int64_t;
    202 typedef uint64_t                khronos_uint64_t;
    203 #define KHRONOS_SUPPORT_INT64   1
    204 #define KHRONOS_SUPPORT_FLOAT   1
    205 
    206 #endif
    207 
    208 
    209 /*
    210  * Types that are (so far) the same on all platforms
    211  */
    212 typedef signed   char          khronos_int8_t;
    213 typedef unsigned char          khronos_uint8_t;
    214 typedef signed   short int     khronos_int16_t;
    215 typedef unsigned short int     khronos_uint16_t;
    216 typedef signed   long  int     khronos_intptr_t;
    217 typedef unsigned long  int     khronos_uintptr_t;
    218 typedef signed   long  int     khronos_ssize_t;
    219 typedef unsigned long  int     khronos_usize_t;
    220 
    221 #if KHRONOS_SUPPORT_FLOAT
    222 /*
    223  * Float type
    224  */
    225 typedef          float         khronos_float_t;
    226 #endif
    227 
    228 #if KHRONOS_SUPPORT_INT64
    229 /* Time types
    230  *
    231  * These types can be used to represent a time interval in nanoseconds or
    232  * an absolute Unadjusted System Time.  Unadjusted System Time is the number
    233  * of nanoseconds since some arbitrary system event (e.g. since the last
    234  * time the system booted).  The Unadjusted System Time is an unsigned
    235  * 64 bit value that wraps back to 0 every 584 years.  Time intervals
    236  * may be either signed or unsigned.
    237  */
    238 typedef khronos_uint64_t       khronos_utime_nanoseconds_t;
    239 typedef khronos_int64_t        khronos_stime_nanoseconds_t;
    240 #endif
    241 
    242 
    243 #endif /* __khrplatform_h_ */
    244