clutter/egl/clutter-egl.h

   1 /*
   2  * Clutter.
   3  *
   4  * An OpenGL based 'interactive canvas' library.
   5  *
   6  * Authored By Matthew Allum  <mallum@openedhand.com>
   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
  33  * <filename class="headerfile">&lt;clutter/egl/clutter-egl.h&gt;</filename>
  34  * to have access to the functions documented here.
  35  */
  36
  37 #ifndef __CLUTTER_EGL_H__
  38 #define __CLUTTER_EGL_H__
  39
  40 #include <glib.h>
  41
  42 #ifdef COGL_HAS_XLIB_SUPPORT
  43 #include <X11/Xlib.h>
  44 #include <X11/Xatom.h>
  45 #include <X11/Xutil.h>
  46 #endif
  47
  48 #include "clutter-egl-headers.h"
  49
  50 G_BEGIN_DECLS
  51
  52 #ifndef CLUTTER_DISABLE_DEPRECATED
  53 /**
  54  * clutter_eglx_display:
  55  *
  56  * Retrieves the <structname>EGLDisplay</structname> used by Clutter,
  57  * if Clutter has been compiled with EGL and X11 support.
  58  *
  59  * Return value: the EGL display
  60  *
  61  * Since: 0.4
  62  *
  63  * Deprecated: 1.6: Use clutter_egl_get_egl_display() instead
  64  */
  65 EGLDisplay      clutter_eglx_display            (void);
  66
  67 /**
  68  * clutter_egl_display:
  69  *
  70  * Retrieves the <structname>EGLDisplay</structname> used by Clutter
  71  *
  72  * Return value: the EGL display
  73  *
  74  * Deprecated: 1.6: Use clutter_egl_get_egl_display() instead
  75  */
  76 EGLDisplay      clutter_egl_display             (void);
  77 #endif /* CLUTTER_DISABLE_DEPRECATED */
  78
  79 /**
  80  * clutter_egl_get_egl_display:
  81  *
  82  * Retrieves the  <structname>EGLDisplay</structname> used by Clutter.
  83  *
  84  * Return value: the EGL display
  85  *
  86  * Since: 1.6
  87  */
  88 EGLDisplay      clutter_egl_get_egl_display     (void);
  89
  90 G_END_DECLS
  91
  92 #endif /* __CLUTTER_EGL_H__ */