/* * Clutter. * * An OpenGL based 'interactive canvas' library. * * Authored By Matthew Allum * * Copyright (C) 2006 OpenedHand * * 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 . */ #if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION) #error "Only can be included directly." #endif #ifndef __CLUTTER_MAIN_H__ #define __CLUTTER_MAIN_H__ #include #include #include G_BEGIN_DECLS /** * CLUTTER_INIT_ERROR: * * #GError domain for #ClutterInitError */ #define CLUTTER_INIT_ERROR (clutter_init_error_quark ()) /** * ClutterInitError: * @CLUTTER_INIT_SUCCESS: Initialisation successful * @CLUTTER_INIT_ERROR_UNKNOWN: Unknown error * @CLUTTER_INIT_ERROR_THREADS: Thread initialisation failed * @CLUTTER_INIT_ERROR_BACKEND: Backend initialisation failed * @CLUTTER_INIT_ERROR_INTERNAL: Internal error * * Error conditions returned by clutter_init() and clutter_init_with_args(). * * Since: 0.2 */ typedef enum { CLUTTER_INIT_SUCCESS = 1, CLUTTER_INIT_ERROR_UNKNOWN = 0, CLUTTER_INIT_ERROR_THREADS = -1, CLUTTER_INIT_ERROR_BACKEND = -2, CLUTTER_INIT_ERROR_INTERNAL = -3 } ClutterInitError; GQuark clutter_init_error_quark (void); /** * CLUTTER_PRIORITY_REDRAW: * * Priority of the redraws. This is chosen to be lower than the GTK+ * redraw and resize priorities, because in application with both * GTK+ and Clutter it's more likely that the Clutter part will be * continually animating (and thus able to starve GTK+) than * vice-versa. * * Since: 0.8 */ #define CLUTTER_PRIORITY_REDRAW (G_PRIORITY_HIGH_IDLE + 50) /* Initialisation */ void clutter_base_init (void); ClutterInitError clutter_init (int *argc, char ***argv) G_GNUC_WARN_UNUSED_RESULT; ClutterInitError clutter_init_with_args (int *argc, char ***argv, const char *parameter_string, GOptionEntry *entries, const char *translation_domain, GError **error) G_GNUC_WARN_UNUSED_RESULT; GOptionGroup * clutter_get_option_group (void); GOptionGroup * clutter_get_option_group_without_init (void); /* Mainloop */ void clutter_main (void); void clutter_main_quit (void); gint clutter_main_level (void); #if !defined(CLUTTER_DISABLE_DEPRECATED) || defined(CLUTTER_COMPILATION) CLUTTER_DEPRECATED_FOR(clutter_stage_ensure_redraw) void clutter_redraw (ClutterStage *stage); #endif void clutter_do_event (ClutterEvent *event); /* Debug utility functions */ gboolean clutter_get_debug_enabled (void); gboolean clutter_get_show_fps (void); gulong clutter_get_timestamp (void); gboolean clutter_get_accessibility_enabled (void); /* Threading functions */ #if !defined(CLUTTER_DISABLE_DEPRECATED) || defined(CLUTTER_COMPILATION) CLUTTER_DEPRECATED void clutter_threads_init (void); #endif void clutter_threads_enter (void); void clutter_threads_leave (void); void clutter_threads_set_lock_functions (GCallback enter_fn, GCallback leave_fn); guint clutter_threads_add_idle (GSourceFunc func, gpointer data); guint clutter_threads_add_idle_full (gint priority, GSourceFunc func, gpointer data, GDestroyNotify notify); guint clutter_threads_add_timeout (guint interval, GSourceFunc func, gpointer data); guint clutter_threads_add_timeout_full (gint priority, guint interval, GSourceFunc func, gpointer data, GDestroyNotify notify); #if !defined(CLUTTER_DISABLE_DEPRECATED) || defined(CLUTTER_COMPILATION) CLUTTER_DEPRECATED guint clutter_threads_add_frame_source (guint fps, GSourceFunc func, gpointer data); CLUTTER_DEPRECATED guint clutter_threads_add_frame_source_full (gint priority, guint fps, GSourceFunc func, gpointer data, GDestroyNotify notify); #endif /* CLUTTER_DISABLE_DEPRECATED */ guint clutter_threads_add_repaint_func (GSourceFunc func, gpointer data, GDestroyNotify notify); void clutter_threads_remove_repaint_func (guint handle_id); #if !defined(CLUTTER_DISABLE_DEPRECATED) || defined(CLUTTER_COMPILATION) CLUTTER_DEPRECATED_FOR(clutter_stage_set_motion_events_enabled) void clutter_set_motion_events_enabled (gboolean enable); CLUTTER_DEPRECATED_FOR(clutter_stage_get_motion_events_enabled) gboolean clutter_get_motion_events_enabled (void); #endif /* CLUTTER_DISABLE_DEPRECATED */ void clutter_set_default_frame_rate (guint frames_per_sec); guint clutter_get_default_frame_rate (void); void clutter_grab_pointer (ClutterActor *actor); void clutter_ungrab_pointer (void); ClutterActor * clutter_get_pointer_grab (void); void clutter_grab_keyboard (ClutterActor *actor); void clutter_ungrab_keyboard (void); ClutterActor * clutter_get_keyboard_grab (void); #if !defined(CLUTTER_DISABLE_DEPRECATED) || defined(CLUTTER_COMPILATION) CLUTTER_DEPRECATED_FOR(cogl_pango_font_map_clear_glyph_cache) void clutter_clear_glyph_cache (void); CLUTTER_DEPRECATED_FOR(clutter_backend_set_font_options) void clutter_set_font_flags (ClutterFontFlags flags); CLUTTER_DEPRECATED_FOR(clutter_backend_get_font_options) ClutterFontFlags clutter_get_font_flags (void); #endif /* CLUTTER_DISABLE_DEPRECATED */ #if !defined(CLUTTER_DISABLE_DEPRECATED) || defined(CLUTTER_COMPILATION) CLUTTER_DEPRECATED_FOR(clutter_device_manager_get_device) ClutterInputDevice *clutter_get_input_device_for_id (gint id_); CLUTTER_DEPRECATED_FOR(clutter_input_device_grab) void clutter_grab_pointer_for_device (ClutterActor *actor, gint id_); CLUTTER_DEPRECATED_FOR(clutter_input_device_ungrab) void clutter_ungrab_pointer_for_device (gint id_); #endif /* CLUTTER_DISABLE_DEPRECATED */ PangoFontMap * clutter_get_font_map (void); ClutterTextDirection clutter_get_default_text_direction (void); G_END_DECLS #endif /* _CLUTTER_MAIN_H__ */