Documentation

ImageBackEndInterface

Interface for back ends able to to produce path based images.

Table of Contents

done()  : string
Ends the image drawing operation and returns the resulting blob.
drawPathWithColor()  : void
Draws a path with a given color.
drawPathWithGradient()  : void
Draws a path with a given gradient which spans the box described by the position and size.
new()  : void
Starts a new image.
pop()  : void
Pops the last coordinate transformation from a stack.
push()  : void
Pushes the current coordinate transformation onto a stack.
rotate()  : void
Transforms all following drawing operation coordinates by rotating them by a given amount.
scale()  : void
Transforms all following drawing operation coordinates by scaling them by a given factor.
translate()  : void
Transforms all following drawing operation coordinates by translating them by a given amount.

Methods

done()

Ends the image drawing operation and returns the resulting blob.

public done() : string

This should reset the state of the back end and thus this method should only be callable once per image.

Tags
throws
RuntimeException

if no image was started yet.

Return values
string

drawPathWithGradient()

Draws a path with a given gradient which spans the box described by the position and size.

public drawPathWithGradient(Path $path, Gradient $gradient, float $x, float $y, float $width, float $height) : void
Parameters
$path : Path
$gradient : Gradient
$x : float
$y : float
$width : float
$height : float
Tags
throws
RuntimeException

if no image was started yet.

Return values
void

new()

Starts a new image.

public new(int $size, ColorInterface $backgroundColor) : void

If a previous image was already started, previous data get erased.

Parameters
$size : int
$backgroundColor : ColorInterface
Return values
void

rotate()

Transforms all following drawing operation coordinates by rotating them by a given amount.

public rotate(int $degrees) : void
Parameters
$degrees : int
Tags
throws
RuntimeException

if no image was started yet.

Return values
void

scale()

Transforms all following drawing operation coordinates by scaling them by a given factor.

public scale(float $size) : void
Parameters
$size : float
Tags
throws
RuntimeException

if no image was started yet.

Return values
void

translate()

Transforms all following drawing operation coordinates by translating them by a given amount.

public translate(float $x, float $y) : void
Parameters
$x : float
$y : float
Tags
throws
RuntimeException

if no image was started yet.

Return values
void

Search results