SDL  2.0
SDL_egl_c.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2020 Sam Lantinga <slouken@libsdl.org>
4 
5  This software is provided 'as-is', without any express or implied
6  warranty. In no event will the authors be held liable for any damages
7  arising from the use of this software.
8 
9  Permission is granted to anyone to use this software for any purpose,
10  including commercial applications, and to alter it and redistribute it
11  freely, subject to the following restrictions:
12 
13  1. The origin of this software must not be misrepresented; you must not
14  claim that you wrote the original software. If you use this software
15  in a product, an acknowledgment in the product documentation would be
16  appreciated but is not required.
17  2. Altered source versions must be plainly marked as such, and must not be
18  misrepresented as being the original software.
19  3. This notice may not be removed or altered from any source distribution.
20 */
21 #include "../SDL_internal.h"
22 
23 #ifndef SDL_egl_h_
24 #define SDL_egl_h_
25 
26 #if SDL_VIDEO_OPENGL_EGL
27 
28 #include "SDL_egl.h"
29 
30 #include "SDL_sysvideo.h"
31 
32 #define SDL_EGL_MAX_DEVICES 8
33 
34 typedef struct SDL_EGL_VideoData
35 {
36  void *egl_dll_handle, *dll_handle;
37  EGLDisplay egl_display;
38  EGLConfig egl_config;
39  int egl_swapinterval;
40  int egl_surfacetype;
41  int egl_version_major, egl_version_minor;
42  EGLint egl_required_visual_id;
43 
46  void *native_display,
47  const EGLint *attrib_list);
48  EGLDisplay(EGLAPIENTRY *eglGetPlatformDisplayEXT) (EGLenum platform,
49  void *native_display,
50  const EGLint *attrib_list);
52  EGLint * minor);
54 
55  void *(EGLAPIENTRY *eglGetProcAddress) (const char * procName);
56 
58  const EGLint * attrib_list,
59  EGLConfig * configs,
60  EGLint config_size, EGLint * num_config);
61 
64  EGLContext share_list,
65  const EGLint * attrib_list);
66 
68 
70  EGLint const* attrib_list);
71 
75  const EGLint * attrib_list);
77 
79  EGLSurface read, EGLContext ctx);
80 
82 
84 
86 
88 
91 
93 
95 
97 
99 
100  EGLBoolean(EGLAPIENTRY *eglQueryDevicesEXT)(EGLint max_devices,
101  void **devices,
103 
104  /* whether EGL display was offscreen */
105  int is_offscreen;
106 
107 } SDL_EGL_VideoData;
108 
109 /* OpenGLES functions */
110 extern int SDL_EGL_GetAttribute(_THIS, SDL_GLattr attrib, int *value);
111 /* SDL_EGL_LoadLibrary can get a display for a specific platform (EGL_PLATFORM_*)
112  * or, if 0 is passed, let the implementation decide.
113  */
114 extern int SDL_EGL_LoadLibraryOnly(_THIS, const char *path);
115 extern int SDL_EGL_LoadLibrary(_THIS, const char *path, NativeDisplayType native_display, EGLenum platform);
116 extern void *SDL_EGL_GetProcAddress(_THIS, const char *proc);
117 extern void SDL_EGL_UnloadLibrary(_THIS);
118 extern void SDL_EGL_SetRequiredVisualId(_THIS, int visual_id);
119 extern int SDL_EGL_ChooseConfig(_THIS);
120 extern int SDL_EGL_SetSwapInterval(_THIS, int interval);
121 extern int SDL_EGL_GetSwapInterval(_THIS);
122 extern void SDL_EGL_DeleteContext(_THIS, SDL_GLContext context);
123 extern EGLSurface *SDL_EGL_CreateSurface(_THIS, NativeWindowType nw);
124 extern void SDL_EGL_DestroySurface(_THIS, EGLSurface egl_surface);
125 
126 extern EGLSurface SDL_EGL_CreateOffscreenSurface(_THIS, int width, int height);
127 /* Assumes that LoadLibraryOnly() has succeeded */
128 extern int SDL_EGL_InitializeOffscreen(_THIS, int device);
129 
130 /* These need to be wrapped to get the surface for the window by the platform GLES implementation */
131 extern SDL_GLContext SDL_EGL_CreateContext(_THIS, EGLSurface egl_surface);
132 extern int SDL_EGL_MakeCurrent(_THIS, EGLSurface egl_surface, SDL_GLContext context);
133 extern int SDL_EGL_SwapBuffers(_THIS, EGLSurface egl_surface);
134 
135 /* SDL Error-reporting */
136 extern int SDL_EGL_SetErrorEx(const char * message, const char * eglFunctionName, EGLint eglErrorCode);
137 #define SDL_EGL_SetError(message, eglFunctionName) SDL_EGL_SetErrorEx(message, eglFunctionName, _this->egl_data->eglGetError())
138 
139 /* A few of useful macros */
140 
141 #define SDL_EGL_SwapWindow_impl(BACKEND) int \
142 BACKEND ## _GLES_SwapWindow(_THIS, SDL_Window * window) \
143 {\
144  return SDL_EGL_SwapBuffers(_this, ((SDL_WindowData *) window->driverdata)->egl_surface);\
145 }
146 
147 #define SDL_EGL_MakeCurrent_impl(BACKEND) int \
148 BACKEND ## _GLES_MakeCurrent(_THIS, SDL_Window * window, SDL_GLContext context) \
149 {\
150  if (window && context) { \
151  return SDL_EGL_MakeCurrent(_this, ((SDL_WindowData *) window->driverdata)->egl_surface, context); \
152  }\
153  else {\
154  return SDL_EGL_MakeCurrent(_this, NULL, NULL);\
155  }\
156 }
157 
158 #define SDL_EGL_CreateContext_impl(BACKEND) SDL_GLContext \
159 BACKEND ## _GLES_CreateContext(_THIS, SDL_Window * window) \
160 {\
161  return SDL_EGL_CreateContext(_this, ((SDL_WindowData *) window->driverdata)->egl_surface);\
162 }
163 
164 #endif /* SDL_VIDEO_OPENGL_EGL */
165 
166 #endif /* SDL_egl_h_ */
167 
168 /* vi: set ts=4 sw=4 expandtab: */
eglGetDisplay
EGLAPI EGLDisplay EGLAPIENTRY eglGetDisplay(EGLNativeDisplayType display_id)
EGLContext
void * EGLContext
Definition: egl.h:60
eglMakeCurrent
EGLAPI EGLBoolean EGLAPIENTRY eglMakeCurrent(EGLDisplay dpy, EGLSurface draw, EGLSurface read, EGLContext ctx)
eglSwapBuffers
EGLAPI EGLBoolean EGLAPIENTRY eglSwapBuffers(EGLDisplay dpy, EGLSurface surface)
eglInitialize
EGLAPI EGLBoolean EGLAPIENTRY eglInitialize(EGLDisplay dpy, EGLint *major, EGLint *minor)
eglWaitNative
EGLAPI EGLBoolean EGLAPIENTRY eglWaitNative(EGLint engine)
surface
EGLSurface surface
Definition: eglext.h:248
width
GLint GLint GLsizei width
Definition: SDL_opengl.h:1572
message
GLuint GLsizei const GLchar * message
Definition: SDL_opengl_glext.h:2486
NativeWindowType
EGLNativeWindowType NativeWindowType
Definition: eglplatform.h:112
dpy
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display dpy)
Definition: SDL_x11sym.h:44
eglDestroySurface
EGLAPI EGLBoolean EGLAPIENTRY eglDestroySurface(EGLDisplay dpy, EGLSurface surface)
SDL_GLattr
SDL_GLattr
OpenGL configuration attributes.
Definition: SDL_video.h:197
devices
EGLDeviceEXT * devices
Definition: eglext.h:621
EGLenum
unsigned int EGLenum
Definition: egl.h:171
path
GLsizei const GLchar *const * path
Definition: SDL_opengl_glext.h:3733
eglGetPlatformDisplay
EGLAPI EGLDisplay EGLAPIENTRY eglGetPlatformDisplay(EGLenum platform, void *native_display, const EGLAttrib *attrib_list)
ctx
EGLContext ctx
Definition: eglext.h:208
eglGetProcAddress
EGLAPI __eglMustCastToProperFunctionPointerType EGLAPIENTRY eglGetProcAddress(const char *procname)
eglBindAPI
EGLAPI EGLBoolean EGLAPIENTRY eglBindAPI(EGLenum api)
context
static screen_context_t context
Definition: video.c:25
EGLDisplay
void * EGLDisplay
Definition: egl.h:55
eglChooseConfig
EGLAPI EGLBoolean EGLAPIENTRY eglChooseConfig(EGLDisplay dpy, const EGLint *attrib_list, EGLConfig *configs, EGLint config_size, EGLint *num_config)
NativeDisplayType
EGLNativeDisplayType NativeDisplayType
Definition: eglplatform.h:110
EGLConfig
void * EGLConfig
Definition: egl.h:58
window
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
config
EGLConfig config
Definition: eglext.h:433
height
GLint GLint GLsizei GLsizei height
Definition: SDL_opengl.h:1572
eglDestroyContext
EGLAPI EGLBoolean EGLAPIENTRY eglDestroyContext(EGLDisplay dpy, EGLContext ctx)
name
GLuint const GLchar * name
Definition: SDL_opengl_glext.h:663
num_devices
EGLDeviceEXT EGLint * num_devices
Definition: eglext.h:621
eglCreateContext
EGLAPI EGLContext EGLAPIENTRY eglCreateContext(EGLDisplay dpy, EGLConfig config, EGLContext share_context, const EGLint *attrib_list)
_THIS
#define _THIS
Definition: SDL_alsa_audio.h:31
eglGetError
EGLAPI EGLint EGLAPIENTRY eglGetError(void)
eglCreateWindowSurface
EGLAPI EGLSurface EGLAPIENTRY eglCreateWindowSurface(EGLDisplay dpy, EGLConfig config, EGLNativeWindowType win, const EGLint *attrib_list)
EGLBoolean
unsigned int EGLBoolean
Definition: egl.h:54
draw
void draw()
Definition: testoffscreen.c:36
eglSwapInterval
EGLAPI EGLBoolean EGLAPIENTRY eglSwapInterval(EGLDisplay dpy, EGLint interval)
SDL_GLContext
void * SDL_GLContext
An opaque handle to an OpenGL context.
Definition: SDL_video.h:192
native_display
void * native_display
Definition: eglext.h:789
attribute
EGLSurface EGLint attribute
Definition: eglext.h:263
attrib_list
EGLenum const EGLAttribKHR * attrib_list
Definition: eglext.h:63
value
GLsizei const GLfloat * value
Definition: SDL_opengl_glext.h:701
EGLint
khronos_int32_t EGLint
Definition: eglplatform.h:122
eglCreatePbufferSurface
EGLAPI EGLSurface EGLAPIENTRY eglCreatePbufferSurface(EGLDisplay dpy, EGLConfig config, const EGLint *attrib_list)
EGLAPIENTRY
#define EGLAPIENTRY
Definition: eglplatform.h:54
eglTerminate
EGLAPI EGLBoolean EGLAPIENTRY eglTerminate(EGLDisplay dpy)
eglQueryAPI
EGLAPI EGLenum EGLAPIENTRY eglQueryAPI(void)
eglWaitGL
EGLAPI EGLBoolean EGLAPIENTRY eglWaitGL(void)
EGLSurface
void * EGLSurface
Definition: egl.h:59
SDL_sysvideo.h
eglQueryString
const EGLAPI char *EGLAPIENTRY eglQueryString(EGLDisplay dpy, EGLint name)
void
const SDL_PRINTF_FORMAT_STRING char int const SDL_PRINTF_FORMAT_STRING char int const SDL_PRINTF_FORMAT_STRING char int const SDL_PRINTF_FORMAT_STRING char const char const SDL_SCANF_FORMAT_STRING char return SDL_ThreadFunction const char void return Uint32 return Uint32 void
Definition: SDL_dynapi_procs.h:89
device
static SDL_AudioDeviceID device
Definition: loopwave.c:37
SDL_egl.h
eglGetConfigAttrib
EGLAPI EGLBoolean EGLAPIENTRY eglGetConfigAttrib(EGLDisplay dpy, EGLConfig config, EGLint attribute, EGLint *value)