clutter-stage: Add annotations to clutter_stage_capture
Especially document that out_captures is an array that is given as output. https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1131
This commit is contained in:
parent
0053ef2e16
commit
b310e1d9d7
1 changed files with 14 additions and 0 deletions
|
@ -4349,6 +4349,20 @@ capture_view (ClutterStage *stage,
|
|||
cairo_surface_mark_dirty (capture->image);
|
||||
}
|
||||
|
||||
/**
|
||||
* clutter_stage_capture:
|
||||
* @stage: a #ClutterStage
|
||||
* @paint: whether to pain the frame
|
||||
* @rect: a #cairo_rectangle_int_t in stage coordinates
|
||||
* @out_captures: (out) (array length=out_n_captures): an array of
|
||||
* #ClutterCapture
|
||||
* @out_n_captures: (out): the number of captures in @out_captures
|
||||
*
|
||||
* Captures the stage pixels of @rect into @captures. @rect is in stage
|
||||
* coordinates.
|
||||
*
|
||||
* Returns: %TRUE if a #ClutterCapture has been created, %FALSE otherwise
|
||||
*/
|
||||
gboolean
|
||||
clutter_stage_capture (ClutterStage *stage,
|
||||
gboolean paint,
|
||||
|
|
Loading…
Reference in a new issue