+2006-06-22 Iain Holmes <iain@openedhand.com>
+
+ * clutter/clutter-main.c: More documentation
+
2006-06-22 Matthew Allum <mallum@openedhand.com>
* clutter/clutter-main.h:
/**
* clutter_main_quit:
*
- * FIXME
+ * Terminates the Clutter mainloop.
*/
void
clutter_main_quit (void)
/**
* clutter_main_level:
*
- * FIXME
+ * Retrieves the depth of the Clutter mainloop.
+ *
+ * Return value: The level of the mainloop.
*/
gint
clutter_main_level (void)
/**
* clutter_main:
*
- * FIXME
+ * Starts the Clutter mainloop.
*/
void
clutter_main (void)
/**
* clutter_threads_enter:
*
- * FIXME
+ * Locks the Clutter thread lock.
*/
void
clutter_threads_enter(void)
/**
* clutter_threads_leave:
*
- * FIXME
+ * Unlocks the Clutter thread lock.
*/
void
clutter_threads_leave (void)
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*
clutter_xdisplay (void)
{
return ClutterCntx->xdpy;
}
+/**
+ * clutter_xscreen:
+ *
+ * Retrieves the X screen that Clutter is using.
+ *
+ * Return value: the X screen ID
+ */
int
clutter_xscreen (void)
{
/**
* 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
clutter_want_debug (void)
/**
* clutter_init:
- * @argc: FIXME
- * @argv: FIXME
+ * @argc: The number of arguments in @argv
+ * @argv: A pointer to an array of arguments.
*
- * FIXME
+ * Initialises Clutter.
*
- * Return value: FIXME
+ * Return value: 1 on success, < 0 on failure.
*/
int
clutter_init (int *argc, char ***argv)