HumHub Documentation (unofficial)

LayersInterface extends Iterator, Countable, ArrayAccess

The layers interface.

Table of Contents

Methods

add()  : $this
Adds an image at the end of the layers stack.
animate()  : $this
Animates layers.
coalesce()  : $this
Coalesce layers. Each layer in the sequence is the same size as the first and composited with the next layer in the sequence.
get()  : ImageInterface
Returns the image at offset.
has()  : bool
Returns true if a layer at offset is preset.
merge()  : mixed
Merge layers into the original objects.
remove()  : $this
Removes the image at offset.
set()  : $this
Set an image at offset.

Methods

animate()

Animates layers.

public animate(string $format, int $delay, int $loops) : $this
Parameters
$format : string

The output output format

$delay : int

The delay in milliseconds between two frames

$loops : int

The number of loops, 0 means infinite

Tags
throws
InvalidArgumentException

In case an invalid argument is provided

throws
RuntimeException

In case the driver fails to animate

Return values
$this

coalesce()

Coalesce layers. Each layer in the sequence is the same size as the first and composited with the next layer in the sequence.

public coalesce() : $this
Tags
throws
NotSupportedException
Return values
$this

has()

Returns true if a layer at offset is preset.

public has(int $offset) : bool
Parameters
$offset : int
Return values
bool

        
On this page

Search results