isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2025-01-03 08:12:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

More documentation

Browse Source
This commit is contained in:
Iain Holmes 2006-06-22 09:12:40 +00:00
parent 83671f4b52
commit ad77326868
2 changed files with 31 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog
View File

@ -1,3 +1,7 @@
2006-06-22 Iain Holmes <iain@openedhand.com>
* clutter/clutter-main.c: More documentation
2006-06-22 Matthew Allum <mallum@openedhand.com> 2006-06-22 Matthew Allum <mallum@openedhand.com>
* clutter/clutter-main.h: * clutter/clutter-main.h:

38
clutter/clutter-main.c
View File

@ -326,7 +326,7 @@ clutter_redraw (void)
/** /**
* clutter_main_quit: * clutter_main_quit:
* *
* FIXME * Terminates the Clutter mainloop.
*/ */
void void
clutter_main_quit (void) clutter_main_quit (void)
@ -341,7 +341,9 @@ clutter_main_quit (void)
/** /**
* clutter_main_level: * clutter_main_level:
* *
* FIXME * Retrieves the depth of the Clutter mainloop.
*
* Return value: The level of the mainloop.
*/ */
gint gint
clutter_main_level (void) clutter_main_level (void)
@ -354,7 +356,7 @@ clutter_main_level (void)
/** /**
* clutter_main: * clutter_main:
* *
* FIXME * Starts the Clutter mainloop.
*/ */
void void
clutter_main (void) clutter_main (void)
@ -395,7 +397,7 @@ clutter_main (void)
/** /**
* clutter_threads_enter: * clutter_threads_enter:
* *
* FIXME * Locks the Clutter thread lock.
*/ */
void void
clutter_threads_enter(void) clutter_threads_enter(void)
@ -408,7 +410,7 @@ clutter_threads_enter(void)
/** /**
* clutter_threads_leave: * clutter_threads_leave:
* *
* FIXME * Unlocks the Clutter thread lock.
*/ */
void void
clutter_threads_leave (void) clutter_threads_leave (void)
@ -418,12 +420,26 @@ clutter_threads_leave (void)
g_mutex_unlock (context->gl_lock); g_mutex_unlock (context->gl_lock);
} }
/**
* clutter_xdisplay:
*
* Retrieves the X display that Clutter is using
*
* Return value: A pointer to an X Display structure.
*/
Display* Display*
clutter_xdisplay (void) clutter_xdisplay (void)
{ {
return ClutterCntx->xdpy; return ClutterCntx->xdpy;
} }
/**
* clutter_xscreen:
*
* Retrieves the X screen that Clutter is using.
*
* Return value: the X screen ID
*/
int int
clutter_xscreen (void) clutter_xscreen (void)
{ {
@ -446,9 +462,9 @@ clutter_root_xwindow (void)
/** /**
* clutter_want_debug: * clutter_want_debug:
* *
* FIXME * Check if clutter has debugging turned on.
* *
* Return value: FIXME * Return value: TRUE if debugging is turned on, FALSE otherwise.
*/ */
gboolean gboolean
clutter_want_debug (void) clutter_want_debug (void)
@ -500,12 +516,12 @@ is_gl_version_at_least_12 (void)
/** /**
* clutter_init: * clutter_init:
* @argc: FIXME * @argc: The number of arguments in @argv
* @argv: FIXME * @argv: A pointer to an array of arguments.
* *
* FIXME * Initialises Clutter.
* *
* Return value: FIXME * Return value: 1 on success, < 0 on failure.
*/ */
int int
clutter_init (int *argc, char ***argv) clutter_init (int *argc, char ***argv)