AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2024-12-28 06:21:14 +00:00
Code Issues Projects Releases Wiki Activity

gtk: Improve documentation on returned nodes for snapshot

Browse Source 
Closes: #5747
This commit is contained in:
Marco Trevisan (Treviño) 2023-04-14 18:05:21 +02:00
parent 31c5961c4f
commit 584fd36a5f
2 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
gtk/gskpango.c
View File

@ -460,6 +460,9 @@ gsk_pango_renderer_release (GskPangoRenderer *renderer)
* Creates render nodes for rendering @layout in the given foregound @color
* and appends them to the current node of @snapshot without changing the
* current node.
*
* Note that if the layout does not contain any printable character, then
* no node will be added to the @snapshot.
**/
void
gtk_snapshot_append_layout (GtkSnapshot *snapshot,

9
gtk/gtksnapshot.c
View File

@ -300,6 +300,8 @@ gtk_snapshot_new (void)
* Returns the node that was constructed by @snapshot
* and frees @snapshot.
*
* See also gtk_snapshot_to_node().
*
* Returns: (transfer full) (nullable): a newly-created [class@Gsk.RenderNode]
*/
GskRenderNode *
@ -1569,11 +1571,16 @@ gtk_snapshot_pop_collect (GtkSnapshot *snapshot)
* Returns the render node that was constructed
* by @snapshot.
*
* Note that this function may return %NULL if nothing has been
* added to the snapshot or if its content does not produce pixels
* to be rendered.
*
* After calling this function, it is no longer possible to
* add more nodes to @snapshot. The only function that should
* be called after this is [method@GObject.Object.unref].
*
* Returns: (transfer full) (nullable): the constructed `GskRenderNode`
* Returns: (transfer full) (nullable): the constructed `GskRenderNode` or
* %NULL if there are no nodes to render.
*/
GskRenderNode *
gtk_snapshot_to_node (GtkSnapshot *snapshot)