clutter/cogl/clutter-cex100.h.in

   1 /*
   2  * Clutter.
   3  *
   4  * An OpenGL based 'interactive canvas' library.
   5  *
   6  * Copyright (C) 2010 Intel Corporation
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  20  *
  21  * Authors:
  22  *   Damien Lespiau <damien.lespiau@intel.com>
  23  */
  24
  25 /**
  26  * SECTION:clutter-cex100
  27  * @short_description: Intel CE3100, CE4100 Specific API
  28  *
  29  * The CEX100 backend for Clutter provides some Intel CE3100/CE4100
  30  * specific API
  31  *
  32  * You need to include
  33  * <filename class="headerfile">&lt;clutter/egl/clutter-cex100.h&gt;</filename>
  34  * to have access to the functions documented here.
  35  */
  36
  37 #ifndef __CLUTTER_CEX100_H__
  38 #define __CLUTTER_CEX100_H__
  39
  40 #include <glib.h>
  41
  42 #include <@CLUTTER_CEX100_LIBGDL_PREFIX@libgdl.h>
  43
  44 G_BEGIN_DECLS
  45
  46 /**
  47  * clutter_cex100_set_plane:
  48  * @plane: a GDL plane
  49  *
  50  * Intel CE3100 and CE4100 have several planes (frame buffers) and a
  51  * hardware blender to blend the planes togeteher and produce the final
  52  * image.
  53  *
  54  * clutter_cex100_set_plane() let's you configure the GDL plane where
  55  * the stage will be drawn. By default Clutter will pick UPP_C
  56  * (GDL_PLANE_ID_UPP_C).
  57  *
  58  * <note>This function has to be called before clutter_init()</note>
  59  */
  60 void clutter_cex100_set_plane (gdl_plane_id_t plane);
  61
  62 /**
  63  * ClutterCex100BufferingMode:
  64  * @CLUTTER_CEX100_DOUBLE_BUFFERING: The GDL plane will be double buffered
  65  * @CLUTTER_CEX100_TRIPLE_BUFFERING: The GDL plane will be triple buffered
  66  *
  67  * Enum passed to clutter_cex100_set_buffering_mode().
  68  */
  69 typedef enum /*< prefix=CLUTTER_CEX100 >*/
  70 {
  71   CLUTTER_CEX100_DOUBLE_BUFFERING = 2,
  72   CLUTTER_CEX100_TRIPLE_BUFFERING = 3
  73 } ClutterCex100BufferingMode;
  74
  75 /**
  76  * clutter_cex100_set_buffering_mode:
  77  * @mode: a #ClutterCex100BufferingMode
  78  *
  79  * Configure the buffering mode of the underlying GDL plane. The GDL
  80  * surface used by Clutter to draw can be backed up by either one or two
  81  * back buffers thus being double or triple buffered, respectively.
  82  *
  83  * Clutter defaults to %CLUTTER_CEX100_TRIPLE_BUFFERING.
  84  *
  85  * <note>This function has to be called before clutter_init()</note>
  86  */
  87 void clutter_cex100_set_buffering_mode (ClutterCex100BufferingMode mode);
  88
  89 G_END_DECLS
  90
  91 #endif /* __CLUTTER_CEX100_H__ */