clutter/clutter-page-turn-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  * Based on MxDeformPageTurn, written by:
  25  *   Chris Lord <chris@linux.intel.com>
  26  */
  27
  28 #if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
  29 #error "Only <clutter/clutter.h> can be included directly."
  30 #endif
  31
  32 #ifndef __CLUTTER_PAGE_TURN_EFFECT_H__
  33 #define __CLUTTER_PAGE_TURN_EFFECT_H__
  34
  35 #include <clutter/clutter-deform-effect.h>
  36
  37 G_BEGIN_DECLS
  38
  39 #define CLUTTER_TYPE_PAGE_TURN_EFFECT           (clutter_page_turn_effect_get_type ())
  40 #define CLUTTER_PAGE_TURN_EFFECT(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_PAGE_TURN_EFFECT, ClutterPageTurnEffect))
  41 #define CLUTTER_IS_PAGE_TURN_EFFECT(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_PAGE_TURN_EFFECT))
  42
  43 /**
  44  * ClutterPageTurnEffect:
  45  *
  46  * <structname>ClutterPageTurnEffect</structname> is an opaque structure
  47  * whose members can only be accessed using the provided API
  48  *
  49  * Since: 1.4
  50  */
  51 typedef struct _ClutterPageTurnEffect           ClutterPageTurnEffect;
  52 typedef struct _ClutterPageTurnEffectClass      ClutterPageTurnEffectClass;
  53
  54 GType clutter_page_turn_effect_get_type (void) G_GNUC_CONST;
  55
  56 ClutterEffect *clutter_page_turn_effect_new (gdouble period,
  57                                              gdouble angle,
  58                                              gfloat  radius);
  59
  60 void    clutter_page_turn_effect_set_period (ClutterPageTurnEffect *effect,
  61                                              gdouble                period);
  62 gdouble clutter_page_turn_effect_get_period (ClutterPageTurnEffect *effect);
  63 void    clutter_page_turn_effect_set_angle  (ClutterPageTurnEffect *effect,
  64                                              gdouble                angle);
  65 gdouble clutter_page_turn_effect_get_angle  (ClutterPageTurnEffect *effect);
  66 void    clutter_page_turn_effect_set_radius (ClutterPageTurnEffect *effect,
  67                                              gfloat                 radius);
  68 gfloat  clutter_page_turn_effect_get_radius (ClutterPageTurnEffect *effect);
  69
  70 G_END_DECLS
  71
  72 #endif /* __CLUTTER_PAGE_TURN_EFFECT_H__ */