brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Make a pass on CoglRenderer argument documentation

Browse Source 
Various arguments where missing, added them.

(cherry picked from commit 6e6ee4acb5524ced2f82d42d9c6a706f84f8184c)
This commit is contained in:
Damien Lespiau 2012-12-30 17:47:12 +00:00 committed by Robert Bragg
parent e8838e7a4c
commit 6aadb4a0db
2 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
cogl/cogl-win32-renderer.h
View File

@ -35,6 +35,7 @@ COGL_BEGIN_DECLS
/** /**
* cogl_win32_renderer_handle_event: * cogl_win32_renderer_handle_event:
* @renderer: a #CoglRenderer
* @message: A pointer to a win32 MSG struct * @message: A pointer to a win32 MSG struct
* *
* This function processes a single event; it can be used to hook into * This function processes a single event; it can be used to hook into
@ -66,6 +67,9 @@ typedef CoglFilterReturn (* CoglWin32FilterFunc) (MSG *message,
/** /**
* cogl_win32_renderer_add_filter: * cogl_win32_renderer_add_filter:
* @renderer: a #CoglRenderer
* @func: the callback function
* @data: user data passed to @func when called
* *
* Adds a callback function that will receive all native events. The * Adds a callback function that will receive all native events. The
* function can stop further processing of the event by return * function can stop further processing of the event by return
@ -78,6 +82,9 @@ cogl_win32_renderer_add_filter (CoglRenderer *renderer,
/** /**
* cogl_win32_renderer_remove_filter: * cogl_win32_renderer_remove_filter:
* @renderer: a #CoglRenderer
* @func: the callback function
* @data: user data given when the callback was installed
* *
* Removes a callback that was previously added with * Removes a callback that was previously added with
* cogl_win32_renderer_add_filter(). * cogl_win32_renderer_add_filter().

13
cogl/cogl-xlib-renderer.h
View File

@ -37,6 +37,7 @@ COGL_BEGIN_DECLS
/* /*
* cogl_xlib_renderer_handle_event: * cogl_xlib_renderer_handle_event:
* @renderer: a #CoglRenderer
* @event: pointer to an XEvent structure * @event: pointer to an XEvent structure
* *
* This function processes a single event; it can be used to hook into * This function processes a single event; it can be used to hook into
@ -56,7 +57,7 @@ cogl_xlib_renderer_handle_event (CoglRenderer *renderer,
/* /*
* CoglXlibFilterFunc: * CoglXlibFilterFunc:
* @event: pointer to an XEvent structure * @event: pointer to an XEvent structure
* @data: The data that was given when the filter was added * @data: the data that was given when the filter was added
* *
* A callback function that can be registered with * A callback function that can be registered with
* cogl_xlib_renderer_add_filter(). The function should return * cogl_xlib_renderer_add_filter(). The function should return
@ -68,6 +69,9 @@ typedef CoglFilterReturn (* CoglXlibFilterFunc) (XEvent *event,
/* /*
* cogl_xlib_renderer_add_filter: * cogl_xlib_renderer_add_filter:
* @renderer: a #CoglRenderer
* @func: the callback function
* @data: user data passed to @func when called
* *
* Adds a callback function that will receive all native events. The * Adds a callback function that will receive all native events. The
* function can stop further processing of the event by return * function can stop further processing of the event by return
@ -80,6 +84,9 @@ cogl_xlib_renderer_add_filter (CoglRenderer *renderer,
/* /*
* cogl_xlib_renderer_remove_filter: * cogl_xlib_renderer_remove_filter:
* @renderer: a #CoglRenderer
* @func: the callback function
* @data: user data given when the callback was installed
* *
* Removes a callback that was previously added with * Removes a callback that was previously added with
* cogl_xlib_renderer_add_filter(). * cogl_xlib_renderer_add_filter().
@ -91,6 +98,7 @@ cogl_xlib_renderer_remove_filter (CoglRenderer *renderer,
/* /*
* cogl_xlib_renderer_get_foreign_display: * cogl_xlib_renderer_get_foreign_display:
* @renderer: a #CoglRenderer
* *
* Return value: the foreign Xlib display that will be used by any Xlib based * Return value: the foreign Xlib display that will be used by any Xlib based
* winsys backend. The display needs to be set with * winsys backend. The display needs to be set with
@ -101,6 +109,7 @@ cogl_xlib_renderer_get_foreign_display (CoglRenderer *renderer);
/* /*
* cogl_xlib_renderer_set_foreign_display: * cogl_xlib_renderer_set_foreign_display:
* @renderer: a #CoglRenderer
* *
* Sets a foreign Xlib display that Cogl will use for and Xlib based winsys * Sets a foreign Xlib display that Cogl will use for and Xlib based winsys
* backend. * backend.
@ -117,7 +126,7 @@ cogl_xlib_renderer_set_foreign_display (CoglRenderer *renderer,
/** /**
* cogl_xlib_renderer_set_event_retrieval_enabled: * cogl_xlib_renderer_set_event_retrieval_enabled:
* @renderer: A #CoglRenderer * @renderer: a #CoglRenderer
* @enable: The new value * @enable: The new value
* *
* Sets whether Cogl should automatically retrieve events from the X * Sets whether Cogl should automatically retrieve events from the X