gstreamer/gst-libs/gst/gl/gstglapi.h
Julien Isorce 2fd84a6c86 gl: do not include GL headers in public gstgl headers
Except for gst/gl/gstglfuncs.h

It is up to the client app to include these headers.
It is coherent with the fact that gstreamer-gl.pc does not
require any egl.pc/gles.pc. I.e. it is the responsability
of the app to search these headers within its build setup.

For example gstreamer-vaapi includes explicitly EGL/egl.h
and search for it in its configure.ac.

For example with this patch, if an app includes the headers
  gst/gl/egl/gstglcontext_egl.h
  gst/gl/egl/gstgldisplay_egl.h
  gst/gl/egl/gstglmemoryegl.h
it will *no longer* automatically include EGL/egl.h and GLES2/gl2.h.
Which is good because the app might want to use the gstgl api only
without the need to bother about gl headers.

Also added a test: cd tests/check && make libs/gstglheaders.check

https://bugzilla.gnome.org/show_bug.cgi?id=784779
2017-08-22 10:00:19 +01:00

113 lines
3.1 KiB
C

/*
* GStreamer
* Copyright (C) 2012 Matthew Waters <ystreet00@gmail.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __GST_GL_API_H__
#define __GST_GL_API_H__
#include <gst/gl/gstglconfig.h>
#include <gst/gst.h>
G_BEGIN_DECLS
/**
* GstGLAPI:
* @GST_GL_API_NONE: no API
* @GST_GL_API_OPENGL: Desktop OpenGL up to and including 3.1. The
* compatibility profile when the OpenGL version is >= 3.2
* @GST_GL_API_OPENGL3: Desktop OpenGL >= 3.2 core profile
* @GST_GL_API_GLES1: OpenGL ES 1.x
* @GST_GL_API_GLES2: OpenGL ES 2.x and 3.x
* @GST_GL_API_ANY: Any OpenGL API
*/
typedef enum {
GST_GL_API_NONE = 0,
GST_GL_API_OPENGL = (1 << 0),
GST_GL_API_OPENGL3 = (1 << 1),
GST_GL_API_GLES1 = (1 << 15),
GST_GL_API_GLES2 = (1 << 16),
GST_GL_API_ANY = G_MAXUINT32
} GstGLAPI;
/**
* GST_GL_API_OPENGL_NAME:
*
* The name for %GST_GL_API_OPENGL used in various places
*/
#define GST_GL_API_OPENGL_NAME "opengl"
/**
* GST_GL_API_OPENGL3_NAME:
*
* The name for %GST_GL_API_OPENGL3 used in various places
*/
#define GST_GL_API_OPENGL3_NAME "opengl3"
/**
* GST_GL_API_GLES1_NAME:
*
* The name for %GST_GL_API_GLES1 used in various places
*/
#define GST_GL_API_GLES1_NAME "gles1"
/**
* GST_GL_API_GLES2_NAME:
*
* The name for %GST_GL_API_GLES2 used in various places
*/
#define GST_GL_API_GLES2_NAME "gles2"
/**
* GstGLPlatform:
* @GST_GL_PLATFORM_NONE: no platform
* @GST_GL_PLATFORM_EGL: the EGL platform used primarily with the X11, wayland
* and android window systems as well as on embedded Linux
* @GST_GL_PLATFORM_GLX: the GLX platform used primarily with the X11 window system
* @GST_GL_PLATFORM_WGL: the WGL platform used primarily on Windows
* @GST_GL_PLATFORM_CGL: the CGL platform used primarily on OS X
* @GST_GL_PLATFORM_EAGL: the EAGL platform used primarily on iOS
* @GST_GL_PLATFORM_ANY: any OpenGL platform
*/
typedef enum
{
GST_GL_PLATFORM_NONE = 0,
GST_GL_PLATFORM_EGL = (1 << 0),
GST_GL_PLATFORM_GLX = (1 << 1),
GST_GL_PLATFORM_WGL = (1 << 2),
GST_GL_PLATFORM_CGL = (1 << 3),
GST_GL_PLATFORM_EAGL = (1 << 4),
GST_GL_PLATFORM_ANY = G_MAXUINT32
} GstGLPlatform;
GST_EXPORT
gchar * gst_gl_api_to_string (GstGLAPI api);
GST_EXPORT
GstGLAPI gst_gl_api_from_string (const gchar * api_s);
GST_EXPORT
gchar * gst_gl_platform_to_string (GstGLPlatform platform);
GST_EXPORT
GstGLPlatform gst_gl_platform_from_string (const gchar * platform_s);
G_END_DECLS
#endif /* __GST_GL_API_H__ */