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