Cairo.Dash (gb.cairo)

Static Property Dash As Float[]

Returns or sets the dash pattern to be used by Cairo.Stroke.

A dash pattern is specified by dashes, an array of positive values. Each value provides the length of alternate "on" and "off" portions of the stroke.

  • If the number of dashes is 0 dashing is disabled.

  • If the number of dashes is 1 a symmetric pattern is assumed with alternating on and off portions of the size specified by the single value in dashes.

  • If any value in dashes is negative, or if all values are 0, then Cairo will be put into an error state with a status of Cairo.StatusInvalidDash.

Each "on" segment will have caps applied as if the segment were a separate sub-path. In particular, it is valid to use an "on" length of 0.0 with Cairo.LineCapRound or Cairo.LineCapSquare in order to distributed dots or squares along a path.

The length values are in user-space units as evaluated at the time of stroking. This is not necessarily the same as the user space when this property is set.

See also