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