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