blob: 6786afd90b685895efa25b302afba68fc8296941 [file] [log] [blame]
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -08001#ifndef __eglplatform_h_
2#define __eglplatform_h_
3
4/*
Tom Murphy790b4612024-07-22 12:11:52 +00005** Copyright 2007-2020 The Khronos Group Inc.
6** SPDX-License-Identifier: Apache-2.0
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -08007*/
8
9/* Platform-specific types and definitions for egl.h
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080010 *
11 * Adopters may modify khrplatform.h and this file to suit their platform.
12 * You are encouraged to submit all modifications to the Khronos group so that
13 * they can be included in future versions of this file. Please submit changes
Tom Murphy790b4612024-07-22 12:11:52 +000014 * by filing an issue or pull request on the public Khronos EGL Registry, at
15 * https://www.github.com/KhronosGroup/EGL-Registry/
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080016 */
17
18#include <KHR/khrplatform.h>
19
20/* Macros used in EGL function prototype declarations.
21 *
22 * EGL functions should be prototyped as:
23 *
24 * EGLAPI return-type EGLAPIENTRY eglFunction(arguments);
25 * typedef return-type (EXPAPIENTRYP PFNEGLFUNCTIONPROC) (arguments);
26 *
27 * KHRONOS_APICALL and KHRONOS_APIENTRY are defined in KHR/khrplatform.h
28 */
29
30#ifndef EGLAPI
31#define EGLAPI KHRONOS_APICALL
32#endif
33
Mathias Agopiane81a3cb2010-06-09 18:46:35 -070034#ifndef EGLAPIENTRY
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080035#define EGLAPIENTRY KHRONOS_APIENTRY
Mathias Agopiane81a3cb2010-06-09 18:46:35 -070036#endif
37#define EGLAPIENTRYP EGLAPIENTRY*
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080038
39/* The types NativeDisplayType, NativeWindowType, and NativePixmapType
40 * are aliases of window-system-dependent types, such as X Display * or
41 * Windows Device Context. They must be defined in platform-specific
42 * code below. The EGL-prefixed versions of Native*Type are the same
43 * types, renamed in EGL 1.3 so all types in the API start with "EGL".
Mathias Agopian12af3f62013-03-27 14:55:03 -070044 *
45 * Khronos STRONGLY RECOMMENDS that you use the default definitions
46 * provided below, since these changes affect both binary and source
47 * portability of applications using EGL running on different EGL
48 * implementations.
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080049 */
50
Tom Murphy790b4612024-07-22 12:11:52 +000051#if defined(EGL_NO_PLATFORM_SPECIFIC_TYPES)
52
53typedef void *EGLNativeDisplayType;
54typedef void *EGLNativePixmapType;
55typedef void *EGLNativeWindowType;
56
57#elif defined(_WIN32) || defined(__VC32__) && !defined(__CYGWIN__) && !defined(__SCITECH_SNAP__) /* Win32 and WinCE */
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080058#ifndef WIN32_LEAN_AND_MEAN
59#define WIN32_LEAN_AND_MEAN 1
60#endif
61#include <windows.h>
62
63typedef HDC EGLNativeDisplayType;
64typedef HBITMAP EGLNativePixmapType;
65typedef HWND EGLNativeWindowType;
66
Tom Murphy790b4612024-07-22 12:11:52 +000067#elif defined(__QNX__)
68
69typedef khronos_uintptr_t EGLNativeDisplayType;
70typedef struct _screen_pixmap* EGLNativePixmapType; /* screen_pixmap_t */
71typedef struct _screen_window* EGLNativeWindowType; /* screen_window_t */
72
73#elif defined(__EMSCRIPTEN__)
74
75typedef int EGLNativeDisplayType;
76typedef int EGLNativePixmapType;
77typedef int EGLNativeWindowType;
78
Courtney Goeltzenleuchteredf87c12018-07-18 09:32:50 -060079#elif defined(__WINSCW__) || defined(__SYMBIAN32__) /* Symbian */
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080080
81typedef int EGLNativeDisplayType;
Priyanka Advani (xWF)d28f4fe2024-07-29 23:38:45 +000082typedef void *EGLNativePixmapType;
Tom Murphy790b4612024-07-22 12:11:52 +000083typedef void *EGLNativeWindowType;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080084
Courtney Goeltzenleuchteredf87c12018-07-18 09:32:50 -060085#elif defined(WL_EGL_PLATFORM)
86
87typedef struct wl_display *EGLNativeDisplayType;
88typedef struct wl_egl_pixmap *EGLNativePixmapType;
89typedef struct wl_egl_window *EGLNativeWindowType;
90
91#elif defined(__GBM__)
92
93typedef struct gbm_device *EGLNativeDisplayType;
94typedef struct gbm_bo *EGLNativePixmapType;
95typedef void *EGLNativeWindowType;
96
David 'Digit' Turnerdfd07592010-11-05 12:41:51 +010097#elif defined(__ANDROID__) || defined(ANDROID)
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080098
Mathias Agopianb0e76f42012-03-23 14:15:44 -070099struct ANativeWindow;
Mathias Agopian7189c002009-05-05 18:11:11 -0700100struct egl_native_pixmap_t;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800101
Priyanka Advani (xWF)d28f4fe2024-07-29 23:38:45 +0000102typedef void* EGLNativeDisplayType;
Tom Murphy790b4612024-07-22 12:11:52 +0000103typedef struct egl_native_pixmap_t* EGLNativePixmapType;
104typedef struct ANativeWindow* EGLNativeWindowType;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800105
Courtney Goeltzenleuchteredf87c12018-07-18 09:32:50 -0600106#elif defined(USE_OZONE)
107
108typedef intptr_t EGLNativeDisplayType;
Priyanka Advani (xWF)d28f4fe2024-07-29 23:38:45 +0000109typedef intptr_t EGLNativePixmapType;
Tom Murphy790b4612024-07-22 12:11:52 +0000110typedef intptr_t EGLNativeWindowType;
Courtney Goeltzenleuchteredf87c12018-07-18 09:32:50 -0600111
Tom Murphy790b4612024-07-22 12:11:52 +0000112#elif defined(USE_X11)
David 'Digit' Turnerdfd07592010-11-05 12:41:51 +0100113
114/* X11 (tentative) */
115#include <X11/Xlib.h>
116#include <X11/Xutil.h>
117
118typedef Display *EGLNativeDisplayType;
119typedef Pixmap EGLNativePixmapType;
120typedef Window EGLNativeWindowType;
121
Tom Murphy790b4612024-07-22 12:11:52 +0000122#elif defined(__unix__)
123
124typedef void *EGLNativeDisplayType;
125typedef khronos_uintptr_t EGLNativePixmapType;
126typedef khronos_uintptr_t EGLNativeWindowType;
127
Courtney Goeltzenleuchteredf87c12018-07-18 09:32:50 -0600128#elif defined(__APPLE__)
129
130typedef int EGLNativeDisplayType;
Priyanka Advani (xWF)d28f4fe2024-07-29 23:38:45 +0000131typedef void *EGLNativePixmapType;
Tom Murphy790b4612024-07-22 12:11:52 +0000132typedef void *EGLNativeWindowType;
Courtney Goeltzenleuchteredf87c12018-07-18 09:32:50 -0600133
134#elif defined(__HAIKU__)
135
136#include <kernel/image.h>
137
138typedef void *EGLNativeDisplayType;
139typedef khronos_uintptr_t EGLNativePixmapType;
140typedef khronos_uintptr_t EGLNativeWindowType;
141
Tom Murphy790b4612024-07-22 12:11:52 +0000142#elif defined(__Fuchsia__)
143
144typedef void *EGLNativeDisplayType;
145typedef khronos_uintptr_t EGLNativePixmapType;
146typedef khronos_uintptr_t EGLNativeWindowType;
147
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800148#else
149#error "Platform not recognized"
150#endif
151
152/* EGL 1.2 types, renamed for consistency in EGL 1.3 */
153typedef EGLNativeDisplayType NativeDisplayType;
154typedef EGLNativePixmapType NativePixmapType;
155typedef EGLNativeWindowType NativeWindowType;
156
157
158/* Define EGLint. This must be a signed integral type large enough to contain
159 * all legal attribute names and values passed into and out of EGL, whether
160 * their type is boolean, bitmask, enumerant (symbolic constant), integer,
161 * handle, or other. While in general a 32-bit integer will suffice, if
162 * handles are 64 bit types, then EGLint should be defined as a signed 64-bit
163 * integer type.
164 */
165typedef khronos_int32_t EGLint;
166
Ian Elliotte7be42b2017-07-06 13:02:32 -0600167
168/* C++ / C typecast macros for special EGL handle values */
Colin Cross0c7cc2e2016-11-03 17:36:46 -0700169#if defined(__cplusplus)
170#define EGL_CAST(type, value) (static_cast<type>(value))
171#else
172#define EGL_CAST(type, value) ((type) (value))
173#endif
174
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800175#endif /* __eglplatform_h */