Debian Codegraph @

clutter/egl/clutter-egl.h

raw
1 /*
2 * Clutter.
3 *
4 * An OpenGL based 'interactive canvas' library.
5 *
6 * Authored By Matthew Allum <[email protected]>
7 *
8 * Copyright (C) 2006 OpenedHand
9 *
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
14 *
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
19 *
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
22 *
23 *
24 */
25
26 /**
27 * SECTION:clutter-egl
28 * @short_description: EGL specific API
29 *
30 * The EGL backend for Clutter provides some EGL specific API
31 *
32 * You need to include `clutter-egl.h` to have access to the functions documented here.
33 */
34
35 #ifndef __CLUTTER_EGL_H__
36 #define __CLUTTER_EGL_H__
37
38 #include <glib.h>
39
40 #ifdef COGL_HAS_XLIB_SUPPORT
41 #include <X11/Xlib.h>
42 #include <X11/Xatom.h>
43 #include <X11/Xutil.h>
44 #endif
45
46 #include "clutter-egl-headers.h"
47 #include <clutter/clutter.h>
48
49 G_BEGIN_DECLS
50
51 /**
52 * clutter_eglx_display:
53 *
54 * Retrieves the #EGLDisplay used by Clutter,
55 * if Clutter has been compiled with EGL and X11 support.
56 *
57 * Return value: the EGL display
58 *
59 * Since: 0.4
60 *
61 * Deprecated: 1.6: Use clutter_egl_get_egl_display() instead
62 */
63 CLUTTER_DEPRECATED_FOR(clutter_egl_get_egl_display)
64 EGLDisplay clutter_eglx_display (void);
65
66 /**
67 * clutter_egl_display:
68 *
69 * Retrieves the #EGLDisplay used by Clutter
70 *
71 * Return value: the EGL display
72 *
73 * Deprecated: 1.6: Use clutter_egl_get_egl_display() instead
74 */
75 CLUTTER_DEPRECATED_FOR(clutter_egl_get_egl_display)
76 EGLDisplay clutter_egl_display (void);
77
78 /**
79 * clutter_egl_get_egl_display:
80 *
81 * Retrieves the #EGLDisplay used by Clutter.
82 *
83 * Return value: the EGL display
84 *
85 * Since: 1.6
86 */
87 CLUTTER_AVAILABLE_IN_1_6
88 EGLDisplay clutter_egl_get_egl_display (void);
89
90 #ifdef COGL_HAS_EGL_PLATFORM_KMS_SUPPORT
91 CLUTTER_AVAILABLE_IN_1_18
92 void clutter_egl_set_kms_fd (int fd);
93 #endif
94
95 CLUTTER_AVAILABLE_IN_1_20
96 void clutter_egl_freeze_master_clock (void);
97 CLUTTER_AVAILABLE_IN_1_20
98 void clutter_egl_thaw_master_clock (void);
99
100 G_END_DECLS
101
102 #endif /* __CLUTTER_EGL_H__ */