From 01066bc7d926da07306225c810f13ca42cfcf0b6 Mon Sep 17 00:00:00 2001
From: sdroege <301846+sdroege@users.noreply.github.com>
Date: Sun, 15 Dec 2024 01:25:03 +0000
Subject: [PATCH] Update GIR files
---
GLib-2.0.gir | 15 +-
GObject-2.0.gir | 6 +-
Gio-2.0.gir | 19 +-
Gsk-4.0.gir | 750 ++++++++++++++++++++++++------------------------
Gtk-4.0.gir | 8 +-
5 files changed, 404 insertions(+), 394 deletions(-)
diff --git a/GLib-2.0.gir b/GLib-2.0.gir
index 3c4dd082..4ffc8ec0 100644
--- a/GLib-2.0.gir
+++ b/GLib-2.0.gir
@@ -5709,12 +5709,14 @@ in the macro, so you shouldn't use double quotes.
The directory separator character.
-This is '/' on UNIX machines and '\' under Windows.
+
+This is `'/'` on UNIX machines and `'\'` under Windows.
The directory separator as a string.
-This is "/" on UNIX machines and "\" under Windows.
+
+This is `"/"` on UNIX machines and `"\"` under Windows.
@@ -12404,9 +12406,10 @@ in a generic way.
- Checks whether a character is a directory
-separator. It returns %TRUE for '/' on UNIX
-machines and for '\' or '/' under Windows.
+ Checks whether a character is a directory separator.
+
+It returns true for `'/'` on UNIX machines and for `'\'` or `'/'` under
+Windows.
a character
@@ -15256,7 +15259,7 @@ linked against at application run time.
-
+
The micro version number of the GLib library.
Like #gtk_micro_version, but from the headers used at
diff --git a/GObject-2.0.gir b/GObject-2.0.gir
index f6ab5956..a6e2da31 100644
--- a/GObject-2.0.gir
+++ b/GObject-2.0.gir
@@ -8621,10 +8621,12 @@ See also: %G_PARAM_STATIC_STRINGS
alias for %G_PARAM_READABLE | %G_PARAM_WRITABLE
- the parameter will be set upon object construction
+ the parameter will be set upon object construction.
+ See [vfunc@Object.constructed] for more details
- the parameter can only be set upon object construction
+ the parameter can only be set upon object construction.
+ See [vfunc@Object.constructed] for more details
upon parameter conversion (see g_param_value_convert())
diff --git a/Gio-2.0.gir b/Gio-2.0.gir
index 7543c16d..38eebdc1 100644
--- a/Gio-2.0.gir
+++ b/Gio-2.0.gir
@@ -11868,7 +11868,7 @@ value of type %G_VARIANT_TYPE_HANDLE in the body of the message.
a #GDBusConnection
-
+
return location for a #GUnixFDList or %NULL
@@ -11934,7 +11934,7 @@ This method is only available on UNIX.
a #GUnixFDList or %NULL
-
+
return location for a #GUnixFDList or %NULL
@@ -12441,7 +12441,12 @@ See this [server][gdbus-server] for an example of how to use this method.
Version of g_dbus_connection_register_object() using closures instead of a
-#GDBusInterfaceVTable for easier binding in other languages.
+#GDBusInterfaceVTable for easier binding in other languages.
+
+Note that the reference counting semantics of the function wrapped by
+@method_call_closure are the same as those of
+[callback@Gio.DBusInterfaceMethodCallFunc]: ownership of a reference to the
+[class@Gio.DBusMethodInvocation] is transferred to the function.
0 if @error is set, otherwise a registration ID (never 0)
that can be used with g_dbus_connection_unregister_object() .
@@ -18693,7 +18698,7 @@ return values. Free with g_variant_unref().
A #GDBusProxy.
-
+
Return location for a #GUnixFDList or %NULL.
@@ -18739,7 +18744,7 @@ return values. Free with g_variant_unref().
A #GUnixFDList or %NULL.
-
+
Return location for a #GUnixFDList or %NULL.
@@ -85681,7 +85686,7 @@ implementation.
The client should return a reference to the new file that has been
created for @uri, or %NULL to continue with the default implementation.
-
+
a #GFile for @identifier.
@@ -85696,7 +85701,7 @@ created for @uri, or %NULL to continue with the default implementation.
- user data passed to the function
+ user data passed to the function, or %NULL
diff --git a/Gsk-4.0.gir b/Gsk-4.0.gir
index a6d2ba7e..d26ebe49 100644
--- a/Gsk-4.0.gir
+++ b/Gsk-4.0.gir
@@ -2390,8 +2390,7 @@ during node deserialization.
- A `GskPath` describes lines and curves that are more complex
-than simple rectangles.
+ Describes lines and curves that are more complex than simple rectangles.
Paths can used for rendering (filling or stroking) and for animations
(e.g. as trajectories).
@@ -2424,17 +2423,16 @@ This function serves two purposes:
- When the @flags disallow certain operations, it provides
an approximation of the path using just the allowed operations.
- `FALSE` if @func returned FALSE`, `TRUE` otherwise.
+ false if @func returned false, true otherwise.
- a `GskPath`
+ a path
- flags to pass to the foreach function. See [flags@Gsk.PathForeachFlags]
- for details about flags
+ flags to pass to the foreach function
@@ -2458,40 +2456,39 @@ It is possible that the returned rectangle has 0 width and/or height.
This can happen when the path only describes a point or an
axis-aligned line.
-If the path is empty, `FALSE` is returned and @bounds are set to
+If the path is empty, false is returned and @bounds are set to
graphene_rect_zero(). This is different from the case where the path
is a single point at the origin, where the @bounds will also be set to
-the zero rectangle but `TRUE` will be returned.
+the zero rectangle but true will be returned.
- `TRUE` if the path has bounds, `FALSE` if the path is known
- to be empty and have no bounds.
+ true if the path has bounds, false if the path is known
+ to be empty and have no bounds
- a `GskPath`
+ a path
- the bounds of the given path
+ return location for the bounds
- Computes the closest point on the path to the given point
-and sets the @result to it.
+ Computes the closest point on the path to the given point.
If there is no point closer than the given threshold,
-`FALSE` is returned.
+false is returned.
- `TRUE` if @point was set to the closest point
- on @self, `FALSE` if no point is closer than @threshold
+ true if @point was set to the closest point
+ on @self, false if no point is closer than @threshold
- a `GskPath`
+ a path
@@ -2515,15 +2512,15 @@ If there is no point closer than the given threshold,
Gets the end point of the path.
-An empty path has no points, so `FALSE`
+An empty path has no points, so false
is returned in this case.
- `TRUE` if @result was filled
+ true if @result was filled
- a `GskPath`
+ a path
@@ -2535,15 +2532,15 @@ is returned in this case.
Gets the start point of the path.
-An empty path has no points, so `FALSE`
+An empty path has no points, so false
is returned in this case.
- `TRUE` if @result was filled
+ true if @result was filled
- a `GskPath`
+ a path
@@ -2554,20 +2551,20 @@ is returned in this case.
Computes the bounds for stroking the given path with the
-parameters in @stroke.
+given parameters.
The returned bounds may be larger than necessary, because this
function aims to be fast, not accurate. The bounds are guaranteed
to contain the area affected by the stroke, including protrusions
like miters.
- `TRUE` if the path has bounds, `FALSE` if the path is known
+ true if the path has bounds, false if the path is known
to be empty and have no bounds.
- a #GtkPath
+ a path
@@ -2581,19 +2578,17 @@ like miters.
- Returns whether the given point is inside the area
-that would be affected if the path was filled according
-to @fill_rule.
+ Returns whether a point is inside the fill area of a path.
Note that this function assumes that filling a contour
implicitly closes it.
- `TRUE` if @point is inside
+ true if @point is inside
- a `GskPath`
+ a path
@@ -2607,15 +2602,14 @@ implicitly closes it.
- Returns if the path represents a single closed
-contour.
+ Returns if the path represents a single closed contour.
- `TRUE` if the path is closed
+ true if the path is closed
- a `GskPath`
+ a path
@@ -2623,19 +2617,18 @@ contour.
Checks if the path is empty, i.e. contains no lines or curves.
- `TRUE` if the path is empty
+ true if the path is empty
- a `GskPath`
+ a path
- Converts @self into a human-readable string representation suitable
-for printing.
+ Converts the path into a human-readable representation.
The string is compatible with (a superset of)
[SVG path syntax](https://www.w3.org/TR/SVG11/paths.html#PathData),
@@ -2645,31 +2638,30 @@ see [func@Gsk.Path.parse] for a summary of the syntax.
- a `GskPath`
+ a path
- The string to print into
+ the string to print into
- Increases the reference count of a `GskPath` by one.
+ Increases the reference count of a path by one.
- the passed in `GskPath`.
+ the passed in `GskPath`
- a `GskPath`
+ a path
- Appends the given @path to the given cairo context for drawing
-with Cairo.
+ Appends the path to a cairo context for drawing with Cairo.
This may cause some suboptimal conversions to be performed as
Cairo does not support all features of `GskPath`.
@@ -2681,7 +2673,7 @@ cairo_new_path() if you want this.
- a `GskPath`
+ a path
@@ -2691,7 +2683,7 @@ cairo_new_path() if you want this.
- Converts the path into a string that is suitable for printing.
+ Converts the path into a human-readable string.
You can use this function in a debugger to get a quick overview
of the path.
@@ -2699,18 +2691,18 @@ of the path.
This is a wrapper around [method@Gsk.Path.print], see that function
for details.
- A new string for @self
+ a new string for @self
- a `GskPath`
+ a path
- Decreases the reference count of a `GskPath` by one.
+ Decreases the reference count of a path by one.
If the resulting reference count is zero, frees the path.
@@ -2718,14 +2710,13 @@ If the resulting reference count is zero, frees the path.
- a `GskPath`
+ a path
- This is a convenience function that constructs a `GskPath`
-from a serialized form.
+ Constructs a path from a serialized form.
The string is expected to be in (a superset of)
[SVG path syntax](https://www.w3.org/TR/SVG11/paths.html#PathData),
@@ -2762,8 +2753,7 @@ The `O` command is an extension that is not supported in SVG.
- `GskPathBuilder` is an auxiliary object for constructing
-`GskPath` objects.
+ An auxiliary object for constructing `GskPath` objects.
A path is constructed like this:
@@ -2821,7 +2811,7 @@ from a Cairo context.
- a `GskPathBuilder`
+ a path builder
@@ -2831,7 +2821,7 @@ from a Cairo context.
- Adds a circle with the @center and @radius.
+ Adds a circle as a new contour.
The path is going around the circle in clockwise direction.
@@ -2841,7 +2831,7 @@ If @radius is zero, the contour will be a closed point.
- a `GskPathBuilder`
+ a path builder
@@ -2861,7 +2851,7 @@ If @radius is zero, the contour will be a closed point.
- a #GskPathBuilder
+ a path builder
@@ -2877,7 +2867,7 @@ If @radius is zero, the contour will be a closed point.
- a `GskPathBuilder`
+ a path builder
@@ -2887,7 +2877,7 @@ If @radius is zero, the contour will be a closed point.
- Adds @rect as a new contour to the path built by the builder.
+ Adds a rectangle as a new contour.
The path is going around the rectangle in clockwise direction.
@@ -2898,11 +2888,11 @@ horizontal or vertical line. If both are 0, it'll be a closed dot.
- A `GskPathBuilder`
+ a path builder
- The rectangle to create a path for
+ the rectangle to create a path for
@@ -2914,7 +2904,7 @@ horizontal or vertical line. If both are 0, it'll be a closed dot.
- a `GskPathBuilder`
+ a path builder
@@ -2924,7 +2914,7 @@ horizontal or vertical line. If both are 0, it'll be a closed dot.
- Adds @rect as a new contour to the path built in @self.
+ Adds a rounded rectangle as a new contour.
The path is going around the rectangle in clockwise direction.
@@ -2932,7 +2922,7 @@ The path is going around the rectangle in clockwise direction.
- a #GskPathBuilder
+ a path builder
@@ -2942,7 +2932,7 @@ The path is going around the rectangle in clockwise direction.
- Adds to @self the segment of @path from @start to @end.
+ Adds a segment of a path to the builder.
If @start is equal to or after @end, the path will first add the
segment from @start to the end of the path, and then add the segment
@@ -2956,11 +2946,11 @@ and end point. To add a closed path, use [method@Gsk.PathBuilder.add_path].
- a `GskPathBuilder`
+ a path builder
- the `GskPath` to take the segment to
+ the path to take the segment to
@@ -2993,7 +2983,7 @@ or [method@Gsk.PathBuilder.svg_arc_to].
- a `GskPathBuilder`
+ a path builder
@@ -3027,7 +3017,7 @@ joined via the line join, and not ended with line caps.
- a `GskPathBuilder`
+ a path builder
@@ -3054,7 +3044,7 @@ After this, @x2, @y2 will be the new current point.
- a `GskPathBuilder`
+ a path builder
@@ -3095,7 +3085,7 @@ After this, @x3, @y3 will be the new current point.
- a `GskPathBuilder`
+ a path builder
@@ -3125,16 +3115,16 @@ After this, @x3, @y3 will be the new current point.
- Creates a new `GskPath` from the current state of the
-given builder, and unrefs the @builder instance.
+ Creates a new path from the current state of the
+builder, and unrefs the builder.
- the newly created `GskPath`
+ the newly created path
with all the contours added to the builder
- a `GskPathBuilder`
+ a path builder
@@ -3149,12 +3139,12 @@ When the builder is created, the default current point is set
to `0, 0`. Note that this is different from cairo, which starts
out without a current point.
- The current point
+ the current point
- a `GskPathBuilder`
+ a path builder
@@ -3174,27 +3164,27 @@ the circle with the given radius touches the line from
- a `GskPathBuilder`
+ a path builder
- X coordinate of first control point
+ x coordinate of first control point
- Y coordinate of first control point
+ y coordinate of first control point
- X coordinate of second control point
+ x coordinate of second control point
- Y coordinate of second control point
+ y coordinate of second control point
- Radius of the circle
+ radius of the circle
@@ -3212,7 +3202,7 @@ the new current point.
- a `GskPathBuilder`
+ a path builder
@@ -3236,7 +3226,7 @@ The second call will start a new contour.
- a `GskPathBuilder`
+ a path builder
@@ -3264,7 +3254,7 @@ After this, @x2, @y2 will be the new current point.
- a #GskPathBuilder
+ a path builder
@@ -3291,13 +3281,13 @@ After this, @x2, @y2 will be the new current point.
This function is intended primarily for language bindings.
`GskPathBuilder` objects should not be kept around.
- the given `GskPathBuilder` with
+ the given path builder with
its reference count increased
- a `GskPathBuilder`
+ a path builder
@@ -3314,7 +3304,7 @@ This is the relative version of [method@Gsk.PathBuilder.arc_to].
- a `GskPathBuilder`
+ a path builder
@@ -3348,7 +3338,7 @@ This is the relative version of [method@Gsk.PathBuilder.conic_to].
- a `GskPathBuilder`
+ a path builder
@@ -3386,7 +3376,7 @@ This is the relative version of [method@Gsk.PathBuilder.cubic_to].
- a `GskPathBuilder`
+ a path builder
@@ -3426,27 +3416,27 @@ This is the relative version of [method@Gsk.PathBuilder.html_arc_to].
- a `GskPathBuilder`
+ a path builder
- X coordinate of first control point
+ x coordinate of first control point
- Y coordinate of first control point
+ y coordinate of first control point
- X coordinate of second control point
+ x coordinate of second control point
- Y coordinate of second control point
+ y coordinate of second control point
- Radius of the circle
+ radius of the circle
@@ -3461,7 +3451,7 @@ This is the relative version of [method@Gsk.PathBuilder.line_to].
- a `GskPathBuilder`
+ a path builder
@@ -3484,7 +3474,7 @@ This is the relative version of [method@Gsk.PathBuilder.move_to].
- a `GskPathBuilder`
+ a path builder
@@ -3509,7 +3499,7 @@ This is the relative version of [method@Gsk.PathBuilder.quad_to].
- a `GskPathBuilder`
+ a path builder
@@ -3541,15 +3531,15 @@ This is the relative version of [method@Gsk.PathBuilder.svg_arc_to].
- a `GskPathBuilder`
+ a path builder
- X radius
+ x radius
- Y radius
+ y radius
@@ -3565,11 +3555,11 @@ This is the relative version of [method@Gsk.PathBuilder.svg_arc_to].
- the X coordinate of the endpoint
+ x coordinate of the endpoint
- the Y coordinate of the endpoint
+ y coordinate of the endpoint
@@ -3587,15 +3577,15 @@ After this, @x, @y will be the new current point.
- a `GskPathBuilder`
+ a path builder
- X radius
+ x radius
- Y radius
+ y radius
@@ -3611,17 +3601,17 @@ After this, @x, @y will be the new current point.
- the X coordinate of the endpoint
+ x coordinate of the endpoint
- the Y coordinate of the endpoint
+ y coordinate of the endpoint
- Creates a new `GskPath` from the given builder.
+ Creates a new path from the given builder.
The given `GskPathBuilder` is reset once this function returns;
you cannot call this function multiple times on the same builder
@@ -3630,13 +3620,13 @@ instance.
This function is intended primarily for language bindings.
C code should use [method@Gsk.PathBuilder.free_to_path].
- the newly created `GskPath`
+ the newly created path
with all the contours added to the builder
- a `GskPathBuilder`
+ a path builder
@@ -3648,7 +3638,7 @@ C code should use [method@Gsk.PathBuilder.free_to_path].
- a `GskPathBuilder`
+ a path builder
@@ -3744,8 +3734,8 @@ Closed contours end with a @GSK_PATH_CLOSE operation.
- `GskPathMeasure` is an object that allows measurements
-on `GskPath`s such as determining the length of the path.
+ An object that allows measurements on paths such as determining
+the length of the path.
Many measuring operations require sampling the path length
at intermediate points. Therefore, a `GskPathMeasure` has
@@ -3790,12 +3780,12 @@ default tolerance.
The length is cached, so this function does not do any work.
- The length of the path measured by @self
+ the length of the path measured by @self
- a `GskPathMeasure`
+ a path measure
@@ -3808,22 +3798,22 @@ The length is cached, so this function does not do any work.
- a `GskPathMeasure`
+ a path measure
- Sets @result to the point at the given distance into the path.
+ Gets the point at the given distance into the path.
-An empty path has no points, so `FALSE` is returned in that case.
+An empty path has no points, so false is returned in that case.
- `TRUE` if @result was set
+ true if @result was set
- a `GskPathMeasure`
+ a path measure
@@ -3831,7 +3821,7 @@ An empty path has no points, so `FALSE` is returned in that case.
- return location for the result
+ return location for the point
@@ -3844,7 +3834,7 @@ An empty path has no points, so `FALSE` is returned in that case.
- a `GskPathMeasure`
+ a path measure
@@ -3857,7 +3847,7 @@ An empty path has no points, so `FALSE` is returned in that case.
- a `GskPathMeasure`
+ a path measure
@@ -3871,7 +3861,7 @@ If the resulting reference count is zero, frees the object.
- a `GskPathMeasure`
+ a path measure
@@ -3909,10 +3899,10 @@ More values may be added in the future.
- `GskPathPoint` is an opaque type representing a point on a path.
+ An opaque type representing a point on a path.
-It can be queried for properties of the path at that point, such as
-its tangent or its curvature.
+It can be queried for properties of the path at that point,
+such as its tangent or its curvature.
To obtain a `GskPathPoint`, use [method@Gsk.Path.get_closest_point],
[method@Gsk.Path.get_start_point], [method@Gsk.Path.get_end_point]
@@ -3953,11 +3943,11 @@ as long as the `GskPathPoint` is used.
- a `GskPathPoint`
+ a path point
- another `GskPathPoint`
+ another path point
@@ -3985,16 +3975,16 @@ Use [method@Gsk.Path.is_closed] to find out if the
start- and endpoint of a concrete path refer to the
same location.
- `TRUE` if @point1 and @point2 are equal
+ true if @point1 and @point2 are equal
- a `GskPathPoint`
+ a path point
- another `GskPathPoint`
+ another path point
@@ -4018,27 +4008,27 @@ Optionally, returns the center of the osculating circle as well.
The curvature is the inverse of the radius of the osculating circle.
Lines have a curvature of zero (indicating an osculating circle of
-infinite radius. In this case, the @center is not modified.
+infinite radius). In this case, the @center is not modified.
Circles with a radius of zero have `INFINITY` as curvature
Note that certain points on a path may not have a single curvature,
-such as sharp turns. At such points, there are two curvatures --
-the (limit of) the curvature of the path going into the point,
-and the (limit of) the curvature of the path coming out of it.
-The @direction argument lets you choose which one to get.
+such as sharp turns. At such points, there are two curvatures — the
+(limit of) the curvature of the path going into the point, and the
+(limit of) the curvature of the path coming out of it. The @direction
+argument lets you choose which one to get.
<picture>
<source srcset="curvature-dark.png" media="(prefers-color-scheme: dark)">
<img alt="Osculating circle" src="curvature-light.png">
</picture>
- The curvature of the path at the given point
+ the curvature of the path at the given point
- a `GskPathPoint`
+ a path point
@@ -4050,7 +4040,7 @@ The @direction argument lets you choose which one to get.
- Return location for
+ return location for
the center of the osculating circle
@@ -4058,18 +4048,18 @@ The @direction argument lets you choose which one to get.
Returns the distance from the beginning of the path
-to @point.
+to the point.
the distance of @point
- a `GskPathPoint on the path
+ a point on the path
- a `GskPathMeasure` for the path
+ a path measure for the path
@@ -4081,7 +4071,7 @@ to @point.
- a `GskPathPoint`
+ a path point
@@ -4108,7 +4098,7 @@ can e.g. be used in
- a `GskPathPoint`
+ a path point
@@ -4126,12 +4116,12 @@ can e.g. be used in
Note that certain points on a path may not have a single
tangent, such as sharp turns. At such points, there are
-two tangents -- the direction of the path going into the
+two tangents — the direction of the path going into the
point, and the direction coming out of it. The @direction
argument lets you choose which one to get.
If the path is just a single point (e.g. a circle with
-radius zero), then @tangent is set to `0, 0`.
+radius zero), then the tangent is set to `0, 0`.
If you want to orient something in the direction of the
path, [method@Gsk.PathPoint.get_rotation] may be more
@@ -4141,7 +4131,7 @@ convenient to use.
- a `GskPathPoint`
+ a path point
@@ -4168,6 +4158,7 @@ convenient to use.
Initializes a `GskRoundedRect` when declaring it.
+
All corner sizes will be initialized to 0.
@@ -4353,7 +4344,7 @@ properties during construction.
For a discussion of the supported format, see that function.
- a new `GskRenderNode`
+ a new render node
@@ -4362,7 +4353,7 @@ For a discussion of the supported format, see that function.
- Callback on parsing errors
+ callback on parsing errors
@@ -4372,10 +4363,10 @@ For a discussion of the supported format, see that function.
- Draw the contents of @node to the given cairo context.
+ Draws the contents of a render node on a cairo context.
Typically, you'll use this function to implement fallback rendering
-of `GskRenderNode`s on an intermediate Cairo context, instead of using
+of render nodes on an intermediate Cairo context, instead of using
the drawing context associated to a [class@Gdk.Surface]'s rendering buffer.
For advanced nodes that cannot be supported using Cairo, in particular
@@ -4385,7 +4376,7 @@ for nodes doing 3D operations, this function may fail.
- a `GskRenderNode`
+ a render node
@@ -4403,7 +4394,7 @@ The node will not draw outside of its boundaries.
- a `GskRenderNode`
+ a render node
@@ -4413,14 +4404,14 @@ The node will not draw outside of its boundaries.
- Returns the type of the @node.
+ Returns the type of the render node.
- the type of the `GskRenderNode`
+ the type of @node
- a `GskRenderNode`
+ a render node
@@ -4435,13 +4426,13 @@ effort with that goal.
The rectangle will be fully contained in the bounds of the node.
- %TRUE if part or all of the rendernode is opaque, %FALSE if no
+ true if part or all of the rendernode is opaque, false if no
opaque region could be found.
- a `GskRenderNode`
+ a render node
@@ -4453,12 +4444,12 @@ The rectangle will be fully contained in the bounds of the node.
Acquires a reference on the given `GskRenderNode`.
- the `GskRenderNode` with an additional reference
+ the render node with an additional reference
- a `GskRenderNode`
+ a render node
@@ -4494,7 +4485,7 @@ freed.
- a `GskRenderNode`
+ a render node
@@ -4508,16 +4499,16 @@ See those two functions for details on the arguments.
It is mostly intended for use inside a debugger to quickly dump a render
node to a file for later inspection.
- %TRUE if saving was successful
+ true if saving was successful
- a `GskRenderNode`
+ a render node
- the file to save it to.
+ the file to save it to
@@ -4620,8 +4611,8 @@ node to a file for later inspection.
- `GskRenderer` is a class that renders a scene graph defined via a
-tree of [class@Gsk.RenderNode] instances.
+ A class that renders a scene graph defined via a tree of
+[class@Gsk.RenderNode] instances.
Typically you will use a `GskRenderer` instance to repeatedly call
[method@Gsk.Renderer.render] to update the contents of its associated
@@ -4632,7 +4623,7 @@ It is necessary to realize a `GskRenderer` instance using
in order to create the appropriate windowing system resources needed
to render the scene.
- Creates an appropriate `GskRenderer` instance for the given @surface.
+ Creates an appropriate `GskRenderer` instance for the given surface.
If the `GSK_RENDERER` environment variable is set, GSK will
try that renderer first, before trying the backend-specific
@@ -4640,94 +4631,92 @@ default. The ultimate fallback is the cairo renderer.
The renderer will be realized before it is returned.
- a `GskRenderer`
+ the realized renderer
- a `GdkSurface`
+ a surface
- Retrieves the `GdkSurface` set using gsk_enderer_realize().
+ Retrieves the surface that the renderer is associated with.
-If the renderer has not been realized yet, %NULL will be returned.
+If the renderer has not been realized yet, `NULL` will be returned.
- a `GdkSurface`
+ the surface
- a `GskRenderer`
+ a renderer
- Checks whether the @renderer is realized or not.
+ Checks whether the renderer is realized or not.
- %TRUE if the `GskRenderer` was realized, and %FALSE otherwise
+ true if the renderer was realized, false otherwise
- a `GskRenderer`
+ a renderer
- Creates the resources needed by the @renderer to render the scene
-graph.
+ Creates the resources needed by the renderer.
Since GTK 4.6, the surface may be `NULL`, which allows using
-renderers without having to create a surface.
-Since GTK 4.14, it is recommended to use [method@Gsk.Renderer.realize_for_display]
-instead.
+renderers without having to create a surface. Since GTK 4.14,
+it is recommended to use [method@Gsk.Renderer.realize_for_display]
+for this case.
-Note that it is mandatory to call [method@Gsk.Renderer.unrealize] before
-destroying the renderer.
+Note that it is mandatory to call [method@Gsk.Renderer.unrealize]
+before destroying the renderer.
- Whether the renderer was successfully realized
+ whether the renderer was successfully realized
- a `GskRenderer`
+ a renderer
- the `GdkSurface` renderer will be used on
+ the surface that renderer will be used on
- Creates the resources needed by the @renderer to render the scene
-graph.
+ Creates the resources needed by the renderer.
-Note that it is mandatory to call [method@Gsk.Renderer.unrealize] before
-destroying the renderer.
+Note that it is mandatory to call [method@Gsk.Renderer.unrealize]
+before destroying the renderer.
- Whether the renderer was successfully realized
+ whether the renderer was successfully realized
- a `GskRenderer`
+ a renderer
- the `GdkDisplay` renderer will be used on
+ the display that the renderer will be used on
Renders the scene graph, described by a tree of `GskRenderNode` instances
-to the renderer's surface, ensuring that the given @region gets redrawn.
+to the renderer's surface, ensuring that the given region gets redrawn.
If the renderer has no associated surface, this function does nothing.
@@ -4736,63 +4725,63 @@ node as well as the area given by @region are redrawn. They are however
free to not redraw any pixel outside of @region if they can guarantee that
it didn't change.
-The @renderer will acquire a reference on the `GskRenderNode` tree while
+The renderer will acquire a reference on the `GskRenderNode` tree while
the rendering is in progress.
- a realized `GskRenderer`
+ a realized renderer
- a `GskRenderNode`
+ the render node to render
- the `cairo_region_t` that must be redrawn or %NULL
- for the whole window
+ the `cairo_region_t` that must be redrawn or `NULL`
+ for the whole surface
- Renders the scene graph, described by a tree of `GskRenderNode` instances,
-to a `GdkTexture`.
+ Renders a scene graph, described by a tree of `GskRenderNode` instances,
+to a texture.
-The @renderer will acquire a reference on the `GskRenderNode` tree while
+The renderer will acquire a reference on the `GskRenderNode` tree while
the rendering is in progress.
If you want to apply any transformations to @root, you should put it into a
transform node and pass that node instead.
- a `GdkTexture` with the rendered contents of @root.
+ a texture with the rendered contents of @root
- a realized `GskRenderer`
+ a realized renderer
- a `GskRenderNode`
+ the render node to render
- the section to draw or %NULL to use @root's bounds
+ the section to draw or `NULL` to use @root's bounds
- Releases all the resources created by gsk_renderer_realize().
+ Releases all the resources created by [method@Gsk.Renderer.realize].
- a `GskRenderer`
+ a renderer
@@ -5023,14 +5012,14 @@ The algorithm used for normalizing corner sizes is described in
- Checks if the given @point is inside the rounded rectangle.
+ Checks if the given point is inside the rounded rectangle.
- %TRUE if the @point is inside the rounded rectangle
+ true if the point is inside the rounded rectangle
- a `GskRoundedRect`
+ a rounded rectangle
@@ -5040,14 +5029,14 @@ The algorithm used for normalizing corner sizes is described in
- Checks if the given @rect is contained inside the rounded rectangle.
+ Checks if the given rectangle is contained inside the rounded rectangle.
- %TRUE if the @rect is fully contained inside the rounded rectangle
+ true if the @rect is fully contained inside the rounded rectangle
- a `GskRoundedRect`
+ a rounded rectangle
@@ -5057,17 +5046,17 @@ The algorithm used for normalizing corner sizes is described in
- Initializes the given `GskRoundedRect` with the given values.
+ Initializes a rounded rectangle with the given values.
-This function will implicitly normalize the `GskRoundedRect`
+This function will implicitly normalize the rounded rectangle
before returning.
- the initialized rectangle
+ the initialized rounded rectangle
- The `GskRoundedRect` to initialize
+ the rounded rectangle to initialize
@@ -5093,35 +5082,35 @@ before returning.
- Initializes @self using the given @src rectangle.
+ Initializes a rounded rectangle with a copy.
-This function will not normalize the `GskRoundedRect`,
+This function will not normalize the rounded rectangle,
so make sure the source is normalized.
- the initialized rectangle
+ the initialized rounded rectangle
- a `GskRoundedRect`
+ the rounded rectangle to initialize
- a `GskRoundedRect`
+ another rounded rectangle
- Initializes @self to the given @bounds and sets the radius
-of all four corners to @radius.
+ Initializes a rounded rectangle to the given bounds
+and sets the radius of all four corners equally.
- the initialized rectangle
+ the initialized rounded rectangle
- a `GskRoundedRect`
+ the rounded rectangle to initialize
@@ -5135,14 +5124,15 @@ of all four corners to @radius.
- Checks if part of the given @rect is contained inside the rounded rectangle.
+ Checks if part a rectangle is contained
+inside the rounded rectangle.
- %TRUE if the @rect intersects with the rounded rectangle
+ true if the @rect intersects with the rounded rectangle
- a `GskRoundedRect`
+ a rounded rectangle
@@ -5152,50 +5142,50 @@ of all four corners to @radius.
- Checks if all corners of @self are right angles and the
-rectangle covers all of its bounds.
+ Checks if all corners of a rounded rectangle are right angles
+and the rectangle covers all of its bounds.
This information can be used to decide if [ctor@Gsk.ClipNode.new]
or [ctor@Gsk.RoundedClipNode.new] should be called.
- %TRUE if the rectangle is rectilinear
+ true if the rounded rectangle is rectilinear
- the `GskRoundedRect` to check
+ the rounded rectangle to check
- Normalizes the passed rectangle.
+ Normalizes a rounded rectangle.
-This function will ensure that the bounds of the rectangle
+This function will ensure that the bounds of the rounded rectangle
are normalized and ensure that the corner values are positive
and the corners do not overlap.
- the normalized rectangle
+ the normalized rounded rectangle
- a `GskRoundedRect`
+ a rounded rectangle
- Offsets the bound's origin by @dx and @dy.
+ Offsets the rounded rectangle's origin by @dx and @dy.
-The size and corners of the rectangle are unchanged.
+The size and corners of the rounded rectangle are unchanged.
- the offset rectangle
+ the offset rounded rectangle
- a `GskRoundedRect`
+ a rounded rectangle
@@ -5209,37 +5199,37 @@ The size and corners of the rectangle are unchanged.
- Shrinks (or grows) the given rectangle by moving the 4 sides
+ Shrinks (or grows) a rounded rectangle by moving the 4 sides
according to the offsets given.
The corner radii will be changed in a way that tries to keep
the center of the corner circle intact. This emulates CSS behavior.
-This function also works for growing rectangles if you pass
-negative values for the @top, @right, @bottom or @left.
+This function also works for growing rounded rectangles
+if you pass negative values for the @top, @right, @bottom or @left.
- the resized `GskRoundedRect`
+ the resized rounded rectangle
- The `GskRoundedRect` to shrink or grow
+ the rounded rectangle to shrink or grow
- How far to move the top side downwards
+ how far to move the top side downwards
- How far to move the right side to the left
+ how far to move the right side to the left
- How far to move the bottom side upwards
+ how far to move the bottom side upwards
- How far to move the left side to the right
+ how far to move the left side to the right
@@ -5651,8 +5641,7 @@ If the resulting reference count is zero, frees the builder.
- A `GskStroke` struct collects the parameters that influence
-the operation of stroking a path.
+ Collects the parameters that influence the operation of stroking a path.
Creates a new `GskStroke` with the given @line_width.
@@ -5667,14 +5656,14 @@ the operation of stroking a path.
- Creates a copy of the given @other stroke.
+ Creates a copy of a `GskStroke`.
a new `GskStroke`. Use [method@Gsk.Stroke.free] to free it
- `GskStroke` to copy
+ the stroke to copy
@@ -5686,23 +5675,23 @@ the operation of stroking a path.
- a `GskStroke`
+ a stroke
- Gets the dash array in use or `NULL` if dashing is disabled.
+ Gets the dash array in use.
- The dash array or `NULL` if the dash array is empty.
+ the dash array or `NULL` if the dash array is empty
- a `GskStroke`
+ a stroke
@@ -5712,14 +5701,14 @@ the operation of stroking a path.
- Returns the dash_offset of a `GskStroke`.
+ Gets the dash offset.
- the dash_offset
+ the dash offset
- a `GskStroke`
+ a stroke
@@ -5729,12 +5718,12 @@ the operation of stroking a path.
See [enum@Gsk.LineCap] for details.
- The line cap
+ the line cap
- a `GskStroke`
+ a stroke
@@ -5744,12 +5733,12 @@ See [enum@Gsk.LineCap] for details.
See [enum@Gsk.LineJoin] for details.
- The line join
+ the line join
- a `GskStroke`
+ a stroke
@@ -5757,31 +5746,31 @@ See [enum@Gsk.LineJoin] for details.
Gets the line width used.
- The line width
+ the line width
- a `GskStroke`
+ a stroke
- Returns the miter limit of a `GskStroke`.
+ Gets the miter limit.
the miter limit
- a `GskStroke`
+ a stroke
- Sets the dash pattern to use by this stroke.
+ Sets the dash pattern to use.
A dash pattern is specified by an array of alternating non-negative
values. Each value provides the length of alternate "on" and "off"
@@ -5789,8 +5778,8 @@ portions of the stroke.
Each "on" segment will have caps applied as if the segment were a
separate contour. In particular, it is valid to use an "on" length
-of 0 with `GSK_LINE_CAP_ROUND` or `GSK_LINE_CAP_SQUARE` to draw dots
-or squares along a path.
+of 0 with [enum@Gsk.LineCap.round] or [enum@Gsk.LineCap.square]
+to draw dots or squares along a path.
If @n_dash is 0, if all elements in @dash are 0, or if there are
negative values in @dash, then dashing is disabled.
@@ -5809,7 +5798,7 @@ You can specify a starting offset into the dash with
- a `GskStroke`
+ a stroke
@@ -5837,7 +5826,7 @@ See [method@Gsk.Stroke.set_dash] for more details on dashing.
- a `GskStroke`
+ a stroke
@@ -5855,11 +5844,11 @@ See [enum@Gsk.LineCap] for details.
- a`GskStroke`
+ a stroke
- the `GskLineCap`
+ the line cap
@@ -5873,11 +5862,11 @@ See [enum@Gsk.LineJoin] for details.
- a `GskStroke`
+ a stroke
- The line join to use
+ the line join to use
@@ -5891,7 +5880,7 @@ The line width must be > 0.
- a `GskStroke`
+ a stroke
@@ -5901,20 +5890,21 @@ The line width must be > 0.
- Sets the limit for the distance from the corner where sharp
+ Sets the miter limit to be used when stroking.
+
+The miter limit is the distance from the corner where sharp
turns of joins get cut off.
-The miter limit is in units of line width and must be non-negative.
+The limit is specfied in units of line width and must be non-negative.
-For joins of type `GSK_LINE_JOIN_MITER` that exceed the miter
-limit, the join gets rendered as if it was of type
-`GSK_LINE_JOIN_BEVEL`.
+For joins of type [enum@Gsk.LineJoin.miter] that exceed the miter limit,
+the join gets rendered as if it was of type [enum@Gsk.LineJoin.bevel].
- a `GskStroke`
+ a stroke
@@ -5925,13 +5915,13 @@ limit, the join gets rendered as if it was of type
A helper function that sets the stroke parameters
-of @cr from the values found in @self.
+of a cairo context from a `GskStroke`.
- a `GskStroke`
+ a stroke
@@ -5941,18 +5931,18 @@ of @cr from the values found in @self.
- Checks if 2 strokes are identical.
+ Checks if two strokes are identical.
- `TRUE` if the 2 strokes are equal, `FALSE` otherwise
+ true if the two strokes are equal, false otherwise
- the first `GskStroke`
+ the first stroke
- the second `GskStroke`
+ the second stroke
@@ -6295,7 +6285,7 @@ of this node.
- `GskTransform` is an object to describe transform matrices.
+ An object to describe transform matrices.
Unlike `graphene_matrix_t`, `GskTransform` retains the steps in how
a transform was constructed, and allows inspecting them. It is modeled
@@ -6308,7 +6298,7 @@ having to worry about others changing them.
Creates a new identity transform.
This function is meant to be used by language
-bindings. For C code, this is equivalent to using %NULL.
+bindings. For C code, this is equivalent to using `NULL`.
A new identity transform
@@ -6317,7 +6307,7 @@ bindings. For C code, this is equivalent to using %NULL.
Checks two transforms for equality.
- %TRUE if the two transforms perform the same operation
+ true if the two transforms perform the same operation
@@ -6339,7 +6329,7 @@ bindings. For C code, this is equivalent to using %NULL.
- A `GskTransform`
+ a transform
@@ -6347,10 +6337,10 @@ bindings. For C code, this is equivalent to using %NULL.
Inverts the given transform.
-If @self is not invertible, %NULL is returned.
-Note that inverting %NULL also returns %NULL, which is
-the correct inverse of %NULL. If you need to differentiate
-between those cases, you should check @self is not %NULL
+If @self is not invertible, `NULL` is returned.
+Note that inverting `NULL` also returns `NULL`, which is
+the correct inverse of `NULL`. If you need to differentiate
+between those cases, you should check @self is not `NULL`
before calling this function.
This function consumes @self. Use [method@Gsk.Transform.ref] first
@@ -6361,7 +6351,7 @@ if you want to keep it around.
- Transform to invert
+ transform to invert
@@ -6414,8 +6404,7 @@ if you want to keep it around.
- Converts @self into a human-readable string representation suitable
-for printing.
+ Converts the transform into a human-readable representation.
The result of this function can later be parsed with
[func@Gsk.Transform.parse].
@@ -6424,7 +6413,7 @@ The result of this function can later be parsed with
- a `GskTransform`
+ a transform
@@ -6434,20 +6423,21 @@ The result of this function can later be parsed with
- Acquires a reference on the given `GskTransform`.
+ Acquires a reference on the given transform.
- the `GskTransform` with an additional reference
+ the transform with an additional reference
- a `GskTransform`
+ a transform
- Rotates @next @angle degrees in 2D - or in 3D-speak, around the Z axis.
+ Rotates @next by an angle around the Z axis.
+
The rotation happens around the origin point of (0, 0).
This function consumes @next. Use [method@Gsk.Transform.ref] first
@@ -6572,13 +6562,18 @@ if you want to keep it around.
- Converts a `GskTransform` to a 2D transformation matrix.
+ Converts a transform to a 2D transformation matrix.
@self must be a 2D transformation. If you are not
-sure, use gsk_transform_get_category() >=
-%GSK_TRANSFORM_CATEGORY_2D to check.
+sure, use
+
+ gsk_transform_get_category() >= GSK_TRANSFORM_CATEGORY_2D
+
+to check.
-The returned values have the following layout:
+The returned values are a subset of the full 4x4 matrix that
+is computed by [method@Gsk.Transform.to_matrix] and have the
+following layout:
```
| xx yx | | a b 0 |
@@ -6594,7 +6589,7 @@ Cairo.
- a 2D `GskTransform`
+ a 2D transform
@@ -6624,7 +6619,7 @@ Cairo.
- Converts a `GskTransform` to 2D transformation factors.
+ Converts a transform to 2D transformation factors.
To recreate an equivalent transform from the factors returned
by this function, use
@@ -6639,7 +6634,7 @@ by this function, use
@self must be a 2D transformation. If you are not sure, use
- gsk_transform_get_category() >= %GSK_TRANSFORM_CATEGORY_2D
+ gsk_transform_get_category() >= GSK_TRANSFORM_CATEGORY_2D
to check.
@@ -6647,7 +6642,7 @@ to check.
- a `GskTransform`
+ a transform
@@ -6687,19 +6682,21 @@ to check.
- Converts a `GskTransform` to 2D affine transformation factors.
+ Converts a transform to 2D affine transformation factors.
To recreate an equivalent transform from the factors returned
by this function, use
- gsk_transform_scale (gsk_transform_translate (NULL,
- &GRAPHENE_POINT_T (dx, dy)),
- sx, sy)
+ gsk_transform_scale (
+ gsk_transform_translate (
+ NULL,
+ &GRAPHENE_POINT_T (dx, dy)),
+ sx, sy)
@self must be a 2D affine transformation. If you are not
sure, use
- gsk_transform_get_category() >= %GSK_TRANSFORM_CATEGORY_2D_AFFINE
+ gsk_transform_get_category() >= GSK_TRANSFORM_CATEGORY_2D_AFFINE
to check.
@@ -6707,7 +6704,7 @@ to check.
- a `GskTransform`
+ a transform
@@ -6733,7 +6730,7 @@ to check.
- Computes the actual value of @self and stores it in @out_matrix.
+ Computes the 4x4 matrix for the transform.
The previous value of @out_matrix will be ignored.
@@ -6741,17 +6738,17 @@ The previous value of @out_matrix will be ignored.
- a `GskTransform`
+ a transform
- The matrix to set
+ return location for the matrix
- Converts a matrix into a string that is suitable for printing.
+ Converts the transform into a human-readable string.
The resulting string can be parsed with [func@Gsk.Transform.parse].
@@ -6762,18 +6759,18 @@ This is a wrapper around [method@Gsk.Transform.print].
- a `GskTransform`
+ a transform
- Converts a `GskTransform` to a translation operation.
+ Converts a transform to a translation operation.
@self must be a 2D transformation. If you are not
sure, use
- gsk_transform_get_category() >= %GSK_TRANSFORM_CATEGORY_2D_TRANSLATE
+ gsk_transform_get_category() >= GSK_TRANSFORM_CATEGORY_2D_TRANSLATE
to check.
@@ -6781,7 +6778,7 @@ to check.
- a `GskTransform`
+ a transform
@@ -6807,17 +6804,17 @@ if you want to keep it around.
- Transform to apply @other to
+ transform to apply @other to
- Transform to apply
+ transform to apply
- Transforms a `graphene_rect_t` using the given transform @self.
+ Transforms a rectangle using the given transform.
The result is the bounding box containing the coplanar quad.
@@ -6825,11 +6822,11 @@ The result is the bounding box containing the coplanar quad.
- a `GskTransform`
+ a transform
- a `graphene_rect_t`
+ the rectangle to transform
@@ -6840,17 +6837,17 @@ The result is the bounding box containing the coplanar quad.
- Transforms a `graphene_point_t` using the given transform @self.
+ Transforms a point using the given transform.
- a `GskTransform`
+ a transform
- a `graphene_point_t`
+ the point to transform
@@ -6901,7 +6898,7 @@ if you want to keep it around.
- Releases a reference on the given `GskTransform`.
+ Releases a reference on the given transform.
If the reference was the last, the resources associated to the @self are
freed.
@@ -6910,22 +6907,21 @@ freed.
- a `GskTransform`
+ a transform
- Parses the given @string into a transform and puts it in
-@out_transform.
+ Parses a given into a transform.
Strings printed via [method@Gsk.Transform.to_string]
can be read in again successfully using this function.
-If @string does not describe a valid transform, %FALSE is
-returned and %NULL is put in @out_transform.
+If @string does not describe a valid transform, false
+is returned and `NULL` is put in @out_transform.
- %TRUE if @string described a valid transform.
+ true if @string described a valid transform
@@ -6934,7 +6930,7 @@ returned and %NULL is put in @out_transform.
- The location to put the transform in
+ return location for the transform
@@ -7073,8 +7069,7 @@ Vulkan support.
- This is a convenience function that constructs a `GskPath`
-from a serialized form.
+ Constructs a path from a serialized form.
The string is expected to be in (a superset of)
[SVG path syntax](https://www.w3.org/TR/SVG11/paths.html#PathData),
@@ -7117,33 +7112,32 @@ The `O` command is an extension that is not supported in SVG.
- Checks if 2 strokes are identical.
+ Checks if two strokes are identical.
- `TRUE` if the 2 strokes are equal, `FALSE` otherwise
+ true if the two strokes are equal, false otherwise
- the first `GskStroke`
+ the first stroke
- the second `GskStroke`
+ the second stroke
- Parses the given @string into a transform and puts it in
-@out_transform.
+ Parses a given into a transform.
Strings printed via [method@Gsk.Transform.to_string]
can be read in again successfully using this function.
-If @string does not describe a valid transform, %FALSE is
-returned and %NULL is put in @out_transform.
+If @string does not describe a valid transform, false
+is returned and `NULL` is put in @out_transform.
- %TRUE if @string described a valid transform.
+ true if @string described a valid transform
@@ -7152,16 +7146,16 @@ returned and %NULL is put in @out_transform.
- The location to put the transform in
+ return location for the transform
- Retrieves the `GskRenderNode` stored inside the given `value`, and acquires
-a reference to it.
+ Retrieves the render node stored inside a `GValue`,
+and acquires a reference to it.
- a `GskRenderNode`
+ the render node
@@ -7172,9 +7166,9 @@ a reference to it.
- Retrieves the `GskRenderNode` stored inside the given `value`.
+ Retrieves the render node stored inside a `GValue`.
- a `GskRenderNode`
+ the render node
@@ -7185,9 +7179,10 @@ a reference to it.
- Stores the given `GskRenderNode` inside `value`.
+ Stores the given render node inside a `GValue`.
-The [struct@GObject.Value] will acquire a reference to the `node`.
+The [struct@GObject.Value] will acquire a reference
+to the render node.
@@ -7197,15 +7192,16 @@ The [struct@GObject.Value] will acquire a reference to the `node`.
- a `GskRenderNode`
+ a render node
- Stores the given `GskRenderNode` inside `value`.
+ Stores the given render node inside a `GValue`.
-This function transfers the ownership of the `node` to the `GValue`.
+This function transfers the ownership of the
+render node to the `GValue`.
@@ -7215,7 +7211,7 @@ This function transfers the ownership of the `node` to the `GValue`.
- a `GskRenderNode`
+ a render node
diff --git a/Gtk-4.0.gir b/Gtk-4.0.gir
index c7c247c9..a3a83587 100644
--- a/Gtk-4.0.gir
+++ b/Gtk-4.0.gir
@@ -5935,7 +5935,7 @@ function, if the window was the last window of the application.
- an pplication
+ an application
@@ -52392,7 +52392,11 @@ While a `GtkLabel` sizes itself depending on the text that is displayed,
space as well as it can.
Users of this widget should take care to plan behaviour for the common case
-where the text doesn't fit exactly in the allocated space.
+where the text doesn't fit exactly in the allocated space.
+
+## CSS nodes
+
+`GtkInscription` has a single CSS node with the name label.