---
name: "Graphics::Primitive::Brush"
section: "3pm"
platform: "linux"
package: "libgraphics-primitive-perl"
version: "0.67-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Graphics::Primitive::Brush"
---

# Graphics::Primitive::Brush(3pm)

Description of a stroke

## NAME

Graphics::Primitive::Brush - Description of a stroke

## DESCRIPTION

Graphics::Primitive::Brush represents the visible trace of 'ink' along a path.

## SYNOPSIS

```
  use Graphics::Primitive::Brush;
  my $stroke = Graphics::Primitive::Brush->new({
    line_cap => 'round',
    line_join => 'miter',
    width => 2
  });
```

## METHODS

### Constructor

- *new*

  Creates a new Graphics::Primitive::Brush.  Defaults to a width of 1, a line\_cap 'butt' and a line\_join of 'miter'.

### Instance Methods

- *color*

  Set/Get this brush's color.

- *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.

- *derive*

  Clone this brush but change one or more of it's attributes by passing in a hashref of options:

  ```
    my $new = $brush->derive({ attr => $newvalue });
  ```

  The returned font will be identical to the cloned one, save the attributes specified.

- *equal\_to ($other)*

  Returns 1 if this brush is equal to the supplied one, else returns 0.

- *line\_cap*

  Set/Get the line\_cap of this stroke.  Valid values are butt, round and square.

- *line\_join*

  Set/Get the line\_join of this stroke. Valid values are miter, round and bevel.

- *not\_equal\_to ($other)*

  Opposite of equal\_to.

- *width*

  Set/Get the width of this stroke.  Defaults to 1

## AUTHOR

Cory Watson, `"<gphat@cpan.org>"`

## COPYRIGHT & LICENSE

Copyright 2008-2010 by Cory G Watson.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.