mutter/clutter/clutter/clutter-page-turn-effect.h
Bilal Elmoussaoui c8e63866f0 clutter: Migrate to gi-docgen
- Drop all the private structs documentations
- Make use of gi-docgen items linking as much as possible
- Use markdown formatting for code snippets

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/2441>
2022-08-02 09:52:22 +02:00

73 lines
2.7 KiB
C

/*
* Clutter.
*
* An OpenGL based 'interactive canvas' library.
*
* Copyright (C) 2010 Intel Corporation.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
* Author:
* Emmanuele Bassi <ebassi@linux.intel.com>
*
* Based on MxDeformPageTurn, written by:
* Chris Lord <chris@linux.intel.com>
*/
#ifndef __CLUTTER_PAGE_TURN_EFFECT_H__
#define __CLUTTER_PAGE_TURN_EFFECT_H__
#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
#error "Only <clutter/clutter.h> can be included directly."
#endif
#include <clutter/clutter-deform-effect.h>
G_BEGIN_DECLS
#define CLUTTER_TYPE_PAGE_TURN_EFFECT (clutter_page_turn_effect_get_type ())
#define CLUTTER_PAGE_TURN_EFFECT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_PAGE_TURN_EFFECT, ClutterPageTurnEffect))
#define CLUTTER_IS_PAGE_TURN_EFFECT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_PAGE_TURN_EFFECT))
typedef struct _ClutterPageTurnEffect ClutterPageTurnEffect;
typedef struct _ClutterPageTurnEffectClass ClutterPageTurnEffectClass;
CLUTTER_EXPORT
GType clutter_page_turn_effect_get_type (void) G_GNUC_CONST;
CLUTTER_EXPORT
ClutterEffect *clutter_page_turn_effect_new (gdouble period,
gdouble angle,
gfloat radius);
CLUTTER_EXPORT
void clutter_page_turn_effect_set_period (ClutterPageTurnEffect *effect,
gdouble period);
CLUTTER_EXPORT
gdouble clutter_page_turn_effect_get_period (ClutterPageTurnEffect *effect);
CLUTTER_EXPORT
void clutter_page_turn_effect_set_angle (ClutterPageTurnEffect *effect,
gdouble angle);
CLUTTER_EXPORT
gdouble clutter_page_turn_effect_get_angle (ClutterPageTurnEffect *effect);
CLUTTER_EXPORT
void clutter_page_turn_effect_set_radius (ClutterPageTurnEffect *effect,
gfloat radius);
CLUTTER_EXPORT
gfloat clutter_page_turn_effect_get_radius (ClutterPageTurnEffect *effect);
G_END_DECLS
#endif /* __CLUTTER_PAGE_TURN_EFFECT_H__ */