Functions

path_parse (string)

serialization_error_quark ()

stroke_equal (stroke1, stroke2)

transform_parse (string)

value_dup_render_node (value)

value_get_render_node (value)

value_set_render_node (value, node)

value_take_render_node (value, node)

Details

Gsk.path_parse(string)
Parameters:

string (str) – a string

Returns:

a new GskPath, or NULL if string could not be parsed

Return type:

Gsk.Path or None

Constructs a path from a serialized form.

The string is expected to be in (a superset of) SVG path syntax, as e.g. produced by [method`Gsk`.Path.to_string].

A high-level summary of the syntax:

  • M x y Move to (x, y)

  • L x y Add a line from the current point to (x, y)

  • Q x1 y1 x2 y2 Add a quadratic Bézier from the current point to (x2, y2), with control point (x1, y1)

  • C x1 y1 x2 y2 x3 y3 Add a cubic Bézier from the current point to (x3, y3), with control points (x1, y1) and (x2, y2)

  • Z Close the contour by drawing a line back to the start point

  • H x Add a horizontal line from the current point to the given x value

  • V y Add a vertical line from the current point to the given y value

  • T x2 y2 Add a quadratic Bézier, using the reflection of the previous segments’ control point as control point

  • S x2 y2 x3 y3 Add a cubic Bézier, using the reflection of the previous segments’ second control point as first control point

  • A rx ry r l s x y Add an elliptical arc from the current point to (x, y) with radii rx and ry. See the SVG documentation for how the other parameters influence the arc.

  • O x1 y1 x2 y2 w Add a rational quadratic Bézier from the current point to (x2, y2) with control point (x1, y1) and weight w.

All the commands have lowercase variants that interpret coordinates relative to the current point.

The O command is an extension that is not supported in SVG.

New in version 4.14.

Gsk.serialization_error_quark()
Returns:

the error quark

Return type:

int

Registers an error quark for [class`Gsk`.RenderNode] errors.

Gsk.stroke_equal(stroke1, stroke2)
Parameters:
Returns:

true if the two strokes are equal, false otherwise

Return type:

bool

Checks if two strokes are identical.

New in version 4.14.

Gsk.transform_parse(string)
Parameters:

string (str) – the string to parse

Returns:

true if string described a valid transform

out_transform:

return location for the transform

Return type:

(bool, out_transform: Gsk.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.

Gsk.value_dup_render_node(value)
Parameters:

value (GObject.Value) – a [struct`GObject`.Value] initialized with type GSK_TYPE_RENDER_NODE

Returns:

the render node

Return type:

Gsk.RenderNode or None

Retrieves the render node stored inside a GValue, and acquires a reference to it.

New in version 4.6.

Gsk.value_get_render_node(value)
Parameters:

value (GObject.Value) – a GValue initialized with type GSK_TYPE_RENDER_NODE

Returns:

the render node

Return type:

Gsk.RenderNode or None

Retrieves the render node stored inside a GValue.

New in version 4.6.

Gsk.value_set_render_node(value, node)
Parameters:
  • value (GObject.Value) – a [struct`GObject`.Value] initialized with type GSK_TYPE_RENDER_NODE

  • node (Gsk.RenderNode) – a render node

Stores the given render node inside a GValue.

The [struct`GObject`.Value] will acquire a reference to the render node.

New in version 4.6.

Gsk.value_take_render_node(value, node)
Parameters:

Stores the given render node inside a GValue.

This function transfers the ownership of the render node to the GValue.

New in version 4.6.