Home > PHP > Function > PS > ps_begin_pattern()

ps_begin_pattern()

ps_begin_pattern - Start a new pattern

Syntax

int ps_begin_pattern (resource $psdoc, float $width, float $height, float $xstep, float $ystep, int $painttype)

Arguments

  • psdoc - Resource identifier of the postscript file as returned by ps_new().
  • width - The width of the pattern in pixel.
  • height - The height of the pattern in pixel.
  • xstep - The distance in pixel of placements of the pattern in horizontal direction.
  • ystep - The distance in pixel of placements of the pattern in vertical direction.
  • painttype - Must be 1 or 2.

Description

Starts a new pattern. A pattern is like a page containing e.g. a drawing which can be used for filling areas. It is used like a color by calling ps_setcolor() and setting the color space to pattern.

Version

PHP PECL ps >= 1.2.0

Return value

The identifier of the pattern or FALSE on failure.