2006-05-29 08:59:36 +00:00
|
|
|
/*
|
|
|
|
|
* Clutter.
|
|
|
|
|
*
|
|
|
|
|
* An OpenGL based 'interactive canvas' library.
|
|
|
|
|
*
|
|
|
|
|
* Authored By Matthew Allum <mallum@openedhand.com>
|
|
|
|
|
*
|
|
|
|
|
* 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
|
2008-10-30 17:04:34 +00:00
|
|
|
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
|
2006-05-29 08:59:36 +00:00
|
|
|
*/
|
|
|
|
|
|
2008-10-30 17:04:34 +00:00
|
|
|
#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
|
|
|
|
|
#error "Only <clutter/clutter.h> can be included directly."
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#ifndef __CLUTTER_MAIN_H__
|
|
|
|
|
#define __CLUTTER_MAIN_H__
|
2006-05-29 08:59:36 +00:00
|
|
|
|
2006-06-13 13:17:45 +00:00
|
|
|
#include <clutter/clutter-actor.h>
|
2006-05-29 08:59:36 +00:00
|
|
|
#include <clutter/clutter-stage.h>
|
2008-10-30 17:11:29 +00:00
|
|
|
#include <pango/pango.h>
|
2006-05-29 08:59:36 +00:00
|
|
|
|
2006-07-24 21:15:19 +00:00
|
|
|
G_BEGIN_DECLS
|
|
|
|
|
|
2008-06-25 16:46:42 +00:00
|
|
|
/**
|
|
|
|
|
* CLUTTER_INIT_ERROR:
|
|
|
|
|
*
|
|
|
|
|
* #GError domain for #ClutterInitError
|
|
|
|
|
*/
|
2006-11-21 Emmanuele Bassi <ebassi@openedhand.com>
* configure.ac: Enable debug messages also when
--enable-debug is set to "minimum".
* clutter/Makefile.am:
* clutter/clutter-debug.h: Move all debugging macros inside
this private header; make all debug macros depend on the
CLUTTER_ENABLE_DEBUG compile time define, controlled by
the --enable-debug configure switch; add G_LOG_DOMAIN define.
* clutter/clutter-main.c: Clean up the debug stuff; add
command line argument parsing using GOption; the debug
messages now are triggered like this:
CLUTTER_DEBUG=section:section:... clutter-app
or like this:
clutter-app --clutter-debug=section:section:...
where "section" is one of the sections listed in clutter-main.c,
or "all", for all sections; each section is bound to a flag,
which can be used to define a domain when adding a debug note
using the CLUTTER_NOTE() macro; the old CLUTTER_DBG() macro is
just a wrapper around that, under the CLUTTER_DEBUG_MISC domain;
CLUTTER_NOTE() is used like this:
CLUTTER_NOTE (DOMAIN, log-function);
where log function is g_printerr(), g_message(), g_warning(),
g_critical() or directly g_log() - for instance:
CLUTTER_NOTE (PANGO, g_warning ("Cache miss: %d", glyph));
will print the warning only if the "pango" flag has been
set to the CLUTTER_DEBUG envvar or passed to the --clutter-debug
command line argument.
similar to CLUTTER_SHOW_FPS, there's also the --clutter-show-fps
command line switch; also, the --display and --screen command
line switches have been added: the first overrides the DISPLAY
envvar and the second controls the X screen used by Clutter to
get the root window on the display.
* clutter/clutter-main.h:
* clutter/clutter-main.c: Add extended support for GOption
in Clutter; use clutter_init_with_args() to let Clutter
parse your own command line arguments; use instead
clutter_get_option_group() to get the GOptionGroup used by
Clutter if you want to do the parsing yourself with
g_option_context_parse(). The init sequence has been verified,
updated and moved into common functions where possible.
* clutter/pango/pangoclutter-render.c:
* clutter/*.c: Include "clutter-debug.h" where needed; use
CLUTTER_NOTE() instead of CLUTTER_DBG().
* examples/super-oh.c: Use the new clutter_init_with_args()
function, and add a --num-hands command line switch to
the SuperOH example code controlling the number of hands at
runtime.
2006-11-21 21:27:53 +00:00
|
|
|
#define CLUTTER_INIT_ERROR (clutter_init_error_quark ())
|
2006-05-29 08:59:36 +00:00
|
|
|
|
2007-08-07 14:03:58 +00:00
|
|
|
/**
|
|
|
|
|
* 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
|
|
|
|
|
*/
|
2006-09-15 12:30:15 +00:00
|
|
|
typedef enum {
|
|
|
|
|
CLUTTER_INIT_SUCCESS = 1,
|
2007-08-07 14:03:58 +00:00
|
|
|
CLUTTER_INIT_ERROR_UNKNOWN = 0,
|
2006-09-15 12:30:15 +00:00
|
|
|
CLUTTER_INIT_ERROR_THREADS = -1,
|
2007-01-23 20:29:11 +00:00
|
|
|
CLUTTER_INIT_ERROR_BACKEND = -2,
|
2007-03-22 18:21:59 +00:00
|
|
|
CLUTTER_INIT_ERROR_INTERNAL = -3
|
2006-09-15 12:30:15 +00:00
|
|
|
} ClutterInitError;
|
|
|
|
|
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2006-11-21 Emmanuele Bassi <ebassi@openedhand.com>
* configure.ac: Enable debug messages also when
--enable-debug is set to "minimum".
* clutter/Makefile.am:
* clutter/clutter-debug.h: Move all debugging macros inside
this private header; make all debug macros depend on the
CLUTTER_ENABLE_DEBUG compile time define, controlled by
the --enable-debug configure switch; add G_LOG_DOMAIN define.
* clutter/clutter-main.c: Clean up the debug stuff; add
command line argument parsing using GOption; the debug
messages now are triggered like this:
CLUTTER_DEBUG=section:section:... clutter-app
or like this:
clutter-app --clutter-debug=section:section:...
where "section" is one of the sections listed in clutter-main.c,
or "all", for all sections; each section is bound to a flag,
which can be used to define a domain when adding a debug note
using the CLUTTER_NOTE() macro; the old CLUTTER_DBG() macro is
just a wrapper around that, under the CLUTTER_DEBUG_MISC domain;
CLUTTER_NOTE() is used like this:
CLUTTER_NOTE (DOMAIN, log-function);
where log function is g_printerr(), g_message(), g_warning(),
g_critical() or directly g_log() - for instance:
CLUTTER_NOTE (PANGO, g_warning ("Cache miss: %d", glyph));
will print the warning only if the "pango" flag has been
set to the CLUTTER_DEBUG envvar or passed to the --clutter-debug
command line argument.
similar to CLUTTER_SHOW_FPS, there's also the --clutter-show-fps
command line switch; also, the --display and --screen command
line switches have been added: the first overrides the DISPLAY
envvar and the second controls the X screen used by Clutter to
get the root window on the display.
* clutter/clutter-main.h:
* clutter/clutter-main.c: Add extended support for GOption
in Clutter; use clutter_init_with_args() to let Clutter
parse your own command line arguments; use instead
clutter_get_option_group() to get the GOptionGroup used by
Clutter if you want to do the parsing yourself with
g_option_context_parse(). The init sequence has been verified,
updated and moved into common functions where possible.
* clutter/pango/pangoclutter-render.c:
* clutter/*.c: Include "clutter-debug.h" where needed; use
CLUTTER_NOTE() instead of CLUTTER_DBG().
* examples/super-oh.c: Use the new clutter_init_with_args()
function, and add a --num-hands command line switch to
the SuperOH example code controlling the number of hands at
runtime.
2006-11-21 21:27:53 +00:00
|
|
|
GQuark clutter_init_error_quark (void);
|
|
|
|
|
|
2008-06-25 16:46:42 +00:00
|
|
|
/**
|
|
|
|
|
* CLUTTER_PRIORITY_REDRAW:
|
|
|
|
|
*
|
2009-06-06 23:31:32 +00:00
|
|
|
* 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.
|
2008-06-25 16:46:42 +00:00
|
|
|
*
|
|
|
|
|
* Since: 0.8
|
|
|
|
|
*/
|
2009-06-06 23:31:32 +00:00
|
|
|
#define CLUTTER_PRIORITY_REDRAW (G_PRIORITY_HIGH_IDLE + 50)
|
2008-06-25 16:46:42 +00:00
|
|
|
|
2007-08-08 10:20:14 +00:00
|
|
|
/* Initialisation */
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
void clutter_base_init (void);
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
ClutterInitError clutter_init (int *argc,
|
|
|
|
|
char ***argv) G_GNUC_WARN_UNUSED_RESULT;
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
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;
|
|
|
|
|
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
GOptionGroup * clutter_get_option_group (void);
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
GOptionGroup * clutter_get_option_group_without_init (void);
|
2006-11-21 Emmanuele Bassi <ebassi@openedhand.com>
* configure.ac: Enable debug messages also when
--enable-debug is set to "minimum".
* clutter/Makefile.am:
* clutter/clutter-debug.h: Move all debugging macros inside
this private header; make all debug macros depend on the
CLUTTER_ENABLE_DEBUG compile time define, controlled by
the --enable-debug configure switch; add G_LOG_DOMAIN define.
* clutter/clutter-main.c: Clean up the debug stuff; add
command line argument parsing using GOption; the debug
messages now are triggered like this:
CLUTTER_DEBUG=section:section:... clutter-app
or like this:
clutter-app --clutter-debug=section:section:...
where "section" is one of the sections listed in clutter-main.c,
or "all", for all sections; each section is bound to a flag,
which can be used to define a domain when adding a debug note
using the CLUTTER_NOTE() macro; the old CLUTTER_DBG() macro is
just a wrapper around that, under the CLUTTER_DEBUG_MISC domain;
CLUTTER_NOTE() is used like this:
CLUTTER_NOTE (DOMAIN, log-function);
where log function is g_printerr(), g_message(), g_warning(),
g_critical() or directly g_log() - for instance:
CLUTTER_NOTE (PANGO, g_warning ("Cache miss: %d", glyph));
will print the warning only if the "pango" flag has been
set to the CLUTTER_DEBUG envvar or passed to the --clutter-debug
command line argument.
similar to CLUTTER_SHOW_FPS, there's also the --clutter-show-fps
command line switch; also, the --display and --screen command
line switches have been added: the first overrides the DISPLAY
envvar and the second controls the X screen used by Clutter to
get the root window on the display.
* clutter/clutter-main.h:
* clutter/clutter-main.c: Add extended support for GOption
in Clutter; use clutter_init_with_args() to let Clutter
parse your own command line arguments; use instead
clutter_get_option_group() to get the GOptionGroup used by
Clutter if you want to do the parsing yourself with
g_option_context_parse(). The init sequence has been verified,
updated and moved into common functions where possible.
* clutter/pango/pangoclutter-render.c:
* clutter/*.c: Include "clutter-debug.h" where needed; use
CLUTTER_NOTE() instead of CLUTTER_DBG().
* examples/super-oh.c: Use the new clutter_init_with_args()
function, and add a --num-hands command line switch to
the SuperOH example code controlling the number of hands at
runtime.
2006-11-21 21:27:53 +00:00
|
|
|
|
2007-08-08 10:20:14 +00:00
|
|
|
/* Mainloop */
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
void clutter_main (void);
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
void clutter_main_quit (void);
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
gint clutter_main_level (void);
|
2007-03-22 18:21:59 +00:00
|
|
|
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
void clutter_do_event (ClutterEvent *event);
|
2008-01-23 11:08:39 +00:00
|
|
|
|
2007-08-08 10:20:14 +00:00
|
|
|
/* Debug utility functions */
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_1_4
|
2011-11-02 12:32:09 +00:00
|
|
|
gboolean clutter_get_accessibility_enabled (void);
|
2007-05-16 15:00:41 +00:00
|
|
|
|
2013-03-01 09:58:54 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_1_14
|
|
|
|
|
void clutter_disable_accessibility (void);
|
|
|
|
|
|
2007-08-08 10:20:14 +00:00
|
|
|
/* Threading functions */
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
void clutter_threads_set_lock_functions (GCallback enter_fn,
|
|
|
|
|
GCallback leave_fn);
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
guint clutter_threads_add_idle (GSourceFunc func,
|
|
|
|
|
gpointer data);
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
guint clutter_threads_add_idle_full (gint priority,
|
|
|
|
|
GSourceFunc func,
|
|
|
|
|
gpointer data,
|
|
|
|
|
GDestroyNotify notify);
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
guint clutter_threads_add_timeout (guint interval,
|
|
|
|
|
GSourceFunc func,
|
|
|
|
|
gpointer data);
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
guint clutter_threads_add_timeout_full (gint priority,
|
|
|
|
|
guint interval,
|
|
|
|
|
GSourceFunc func,
|
|
|
|
|
gpointer data,
|
|
|
|
|
GDestroyNotify notify);
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_1_0
|
2011-11-02 12:32:09 +00:00
|
|
|
guint clutter_threads_add_repaint_func (GSourceFunc func,
|
|
|
|
|
gpointer data,
|
|
|
|
|
GDestroyNotify notify);
|
2012-03-06 14:22:43 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_1_10
|
2012-03-06 12:09:00 +00:00
|
|
|
guint clutter_threads_add_repaint_func_full (ClutterRepaintFlags flags,
|
|
|
|
|
GSourceFunc func,
|
|
|
|
|
gpointer data,
|
|
|
|
|
GDestroyNotify notify);
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_1_0
|
2011-11-02 12:32:09 +00:00
|
|
|
void clutter_threads_remove_repaint_func (guint handle_id);
|
|
|
|
|
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
void clutter_grab_pointer (ClutterActor *actor);
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
void clutter_ungrab_pointer (void);
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
ClutterActor * clutter_get_pointer_grab (void);
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
void clutter_grab_keyboard (ClutterActor *actor);
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
void clutter_ungrab_keyboard (void);
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
ClutterActor * clutter_get_keyboard_grab (void);
|
|
|
|
|
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
PangoFontMap * clutter_get_font_map (void);
|
|
|
|
|
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-02 12:32:09 +00:00
|
|
|
ClutterTextDirection clutter_get_default_text_direction (void);
|
2009-11-06 16:50:53 +00:00
|
|
|
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_ALL
|
2011-11-07 20:24:13 +00:00
|
|
|
guint clutter_get_default_frame_rate (void);
|
|
|
|
|
|
2014-03-17 18:19:52 +00:00
|
|
|
CLUTTER_AVAILABLE_IN_1_2
|
|
|
|
|
gboolean clutter_check_version (guint major,
|
|
|
|
|
guint minor,
|
|
|
|
|
guint micro);
|
|
|
|
|
|
|
|
|
|
CLUTTER_AVAILABLE_IN_1_10
|
|
|
|
|
gboolean clutter_check_windowing_backend (const char *backend_type);
|
|
|
|
|
|
|
|
|
|
|
2006-07-24 21:15:19 +00:00
|
|
|
G_END_DECLS
|
2006-05-29 08:59:36 +00:00
|
|
|
|
2008-10-30 17:04:34 +00:00
|
|
|
#endif /* _CLUTTER_MAIN_H__ */
|
