.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Graphics::Primitive::Brush 3pm"
.TH Graphics::Primitive::Brush 3pm "2022-06-14" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Graphics::Primitive::Brush \- Description of a stroke
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Graphics::Primitive::Brush represents the visible trace of 'ink' along a
path.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Graphics::Primitive::Brush;
\&
\&  my $stroke = Graphics::Primitive::Brush\->new({
\&    line_cap => \*(Aqround\*(Aq,
\&    line_join => \*(Aqmiter\*(Aq,
\&    width => 2
\&  });
.Ve
.SH "METHODS"
.IX Header "METHODS"
.SS "Constructor"
.IX Subsection "Constructor"
.IP "\fInew\fR" 4
.IX Item "new"
Creates a new Graphics::Primitive::Brush.  Defaults to a width of 1,
a line_cap 'butt' and a line_join of 'miter'.
.SS "Instance Methods"
.IX Subsection "Instance Methods"
.IP "\fIcolor\fR" 4
.IX Item "color"
Set/Get this brush's color.
.IP "\fIdash_pattern\fR" 4
.IX Item "dash_pattern"
Set/Get the dash pattern.  A dash pattern is an arrayref of numbers
representing the lengths of the various line segments of the dash.  Even
numbered elements are considered opaque and odd elements are transparent.
.IP "\fIderive\fR" 4
.IX Item "derive"
Clone this brush but change one or more of it's attributes by passing in a
hashref of options:
.Sp
.Vb 1
\&  my $new = $brush\->derive({ attr => $newvalue });
.Ve
.Sp
The returned font will be identical to the cloned one, save the attributes
specified.
.IP "\fIequal_to ($other)\fR" 4
.IX Item "equal_to ($other)"
Returns 1 if this brush is equal to the supplied one, else returns 0.
.IP "\fIline_cap\fR" 4
.IX Item "line_cap"
Set/Get the line_cap of this stroke.  Valid values are butt, round and square.
.IP "\fIline_join\fR" 4
.IX Item "line_join"
Set/Get the line_join of this stroke. Valid values are miter, round and bevel.
.IP "\fInot_equal_to ($other)\fR" 4
.IX Item "not_equal_to ($other)"
Opposite of equal_to.
.IP "\fIwidth\fR" 4
.IX Item "width"
Set/Get the width of this stroke.  Defaults to 1
.SH "AUTHOR"
.IX Header "AUTHOR"
Cory Watson, \f(CW\*(C`<gphat@cpan.org>\*(C'\fR
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2008\-2010 by Cory G Watson.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.