clutter/clutter-offscreen-effect.h

   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  * Author:
  22  *   Emmanuele Bassi <ebassi@linux.intel.com>
  23  */
  24
  25 #if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
  26 #error "Only <clutter/clutter.h> can be included directly."
  27 #endif
  28
  29 #ifndef __CLUTTER_OFFSCREEN_EFFECT_H__
  30 #define __CLUTTER_OFFSCREEN_EFFECT_H__
  31
  32 #include <cogl/cogl.h>
  33 #include <clutter/clutter-effect.h>
  34 #include <clutter/clutter-cogl-compat.h>
  35
  36 G_BEGIN_DECLS
  37
  38 #define CLUTTER_TYPE_OFFSCREEN_EFFECT           (clutter_offscreen_effect_get_type ())
  39 #define CLUTTER_OFFSCREEN_EFFECT(o)             (G_TYPE_CHECK_INSTANCE_CAST ((o), CLUTTER_TYPE_OFFSCREEN_EFFECT, ClutterOffscreenEffect))
  40 #define CLUTTER_IS_OFFSCREEN_EFFECT(o)          (G_TYPE_CHECK_INSTANCE_TYPE ((o), CLUTTER_TYPE_OFFSCREEN_EFFECT))
  41 #define CLUTTER_OFFSCREEN_EFFECT_CLASS(k)       (G_TYPE_CHECK_CLASS_CAST ((k), CLUTTER_TYPE_OFFSCREEN_EFFECT, ClutterOffscreenEffectClass))
  42 #define CLUTTER_IS_OFFSCREEN_EFFECT_CLASS(k)    (G_TYPE_CHECK_CLASS_TYPE ((k), CLUTTER_TYPE_OFFSCREEN_EFFECT))
  43 #define CLUTTER_OFFSCREEN_EFFECT_GET_CLASS(o)   (G_TYPE_INSTANCE_GET_CLASS ((o), CLUTTER_TYPE_OFFSCREEN_EFFECT, ClutterOffscreenEffectClass))
  44
  45 typedef struct _ClutterOffscreenEffect          ClutterOffscreenEffect;
  46 typedef struct _ClutterOffscreenEffectPrivate   ClutterOffscreenEffectPrivate;
  47 typedef struct _ClutterOffscreenEffectClass     ClutterOffscreenEffectClass;
  48
  49 /**
  50  * ClutterOffscreenEffect:
  51  *
  52  * The #ClutterOffscreenEffect structure contains only private data
  53  * and should be accessed using the provided API
  54  *
  55  * Since: 1.4
  56  */
  57 struct _ClutterOffscreenEffect
  58 {
  59   /*< private >*/
  60   ClutterEffect parent_instance;
  61
  62   ClutterOffscreenEffectPrivate *priv;
  63 };
  64
  65 /**
  66  * ClutterOffscreenEffectClass:
  67  * @create_texture: virtual function
  68  * @paint_target: virtual function
  69  *
  70  * The #ClutterOffscreenEffectClass structure contains only private data
  71  *
  72  * Since: 1.4
  73  */
  74 struct _ClutterOffscreenEffectClass
  75 {
  76   /*< private >*/
  77   ClutterEffectClass parent_class;
  78
  79   /*< public >*/
  80   CoglHandle (* create_texture) (ClutterOffscreenEffect *effect,
  81                                  gfloat                  width,
  82                                  gfloat                  height);
  83   void       (* paint_target)   (ClutterOffscreenEffect *effect);
  84
  85   /*< private >*/
  86   void (* _clutter_offscreen1) (void);
  87   void (* _clutter_offscreen2) (void);
  88   void (* _clutter_offscreen3) (void);
  89   void (* _clutter_offscreen4) (void);
  90   void (* _clutter_offscreen5) (void);
  91   void (* _clutter_offscreen6) (void);
  92   void (* _clutter_offscreen7) (void);
  93 };
  94
  95 GType clutter_offscreen_effect_get_type (void) G_GNUC_CONST;
  96
  97 CoglMaterial *  clutter_offscreen_effect_get_target             (ClutterOffscreenEffect *effect);
  98
  99 CLUTTER_AVAILABLE_IN_1_10
 100 CoglHandle      clutter_offscreen_effect_get_texture            (ClutterOffscreenEffect *effect);
 101
 102 void            clutter_offscreen_effect_paint_target           (ClutterOffscreenEffect *effect);
 103 CoglHandle      clutter_offscreen_effect_create_texture         (ClutterOffscreenEffect *effect,
 104                                                                  gfloat                  width,
 105                                                                  gfloat                  height);
 106 gboolean        clutter_offscreen_effect_get_target_size        (ClutterOffscreenEffect *effect,
 107                                                                  gfloat                 *width,
 108                                                                  gfloat                 *height);
 109
 110 G_END_DECLS
 111
 112 #endif /* __CLUTTER_OFFSCREEN_EFFECT_H__ */