Class (GI Struct)

Gsk-4.0 ▶ Gsk ▶ StrokeSince 4.14

Collects the parameters that are needed when stroking a path.

4.14

Index
constructor
$gtype
copy free get_dash get_dash_offset get_line_cap get_line_join get_line_width get_miter_limit set_dash set_dash_offset set_line_cap set_line_join set_line_width set_miter_limit to_cairo equal new
$gtype: GType<Stroke>

  • Gets the dash array in use.

    Returns number[]

    the dash array or NULL if the dash array is empty

    4.14

  • Gets the dash offset.

    Returns number

    the dash offset

    4.14

  • Gets the line width used.

    Returns number

    the line width

    4.14

  • Gets the miter limit.

    Returns number

    the miter limit

    4.14

  • 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" 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.LineCap.ROUND or 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.

    If n_dash is 1, an alternating "on" and "off" pattern with the single dash length provided is assumed.

    If n_dash is uneven, the dash array will be used with the first element in dash defining an "on" or "off" in alternating passes through the array.

    You can specify a starting offset into the dash with Gsk.Stroke.set_dash_offset.

    Parameters

    • dash: number[]

      the array of dashes

    Returns void

    4.14

  • Sets the offset into the dash pattern where dashing should begin.

    This is an offset into the length of the path, not an index into the array values of the dash array.

    See Gsk.Stroke.set_dash for more details on dashing.

    Parameters

    • offset: number

      offset into the dash pattern

    Returns void

    4.14

  • Sets the line width to be used when stroking.

    The line width must be >= 0.

    Parameters

    • line_width: number

      width of the line in pixels

    Returns void

    4.14

  • 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 limit is specfied in units of line width and must be non-negative.

    For joins of type Gsk.LineJoin.MITER that exceed the miter limit, the join gets rendered as if it was of type Gsk.LineJoin.BEVEL.

    Parameters

    • limit: number

      the miter limit

    Returns void

    4.14

  • Checks if two strokes are identical.

    Parameters

    • stroke1: null

      the first stroke

    • stroke2: null

      the second stroke

    Returns boolean

    4.14