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