Documentation

VBox
in package

Table of Contents

$b1  : int
$b2  : int
$g1  : int
$g2  : int
$histo  : array<int, int>
$r1  : int
$r2  : int
$avg  : array<string|int, mixed>
$avg_set  : bool
$count  : int
$count_set  : bool
$volume  : int
$volume_set  : bool
__construct()  : mixed
VBox constructor.
avg()  : array<string|int, mixed>
Calculates the average color represented by this VBox.
contains()  : bool
copy()  : self
count()  : int
longestAxis()  : string
Determines the longest axis.
volume()  : int

Properties

$histo

public array<int, int> $histo

$avg

private array<string|int, mixed> $avg
Tags
phpstan-var

ColorRGB

$avg_set

private bool $avg_set = false

$count

private int $count

$count_set

private bool $count_set = false

$volume

private int $volume

$volume_set

private bool $volume_set = false

Methods

__construct()

VBox constructor.

public __construct(int $r1, int $r2, int $g1, int $g2, int $b1, int $b2, array<int, int> $histo) : mixed
Parameters
$r1 : int
$r2 : int
$g1 : int
$g2 : int
$b1 : int
$b2 : int
$histo : array<int, int>
Return values
mixed —

avg()

Calculates the average color represented by this VBox.

public avg([bool $force = false ]) : array<string|int, mixed>
Parameters
$force : bool = false
Tags
phpstan-return

ColorRGB

Return values
array<string|int, mixed> —

contains()

public contains(array<string|int, mixed> $rgbValue[, int $rshift = ColorThief::RSHIFT ]) : bool
Parameters
$rgbValue : array<string|int, mixed>
$rshift : int = ColorThief::RSHIFT
Tags
phpstan-param

ColorRGB $rgbValue

Return values
bool —

copy()

public copy() : self
Return values
self —

count()

public count([bool $force = false ]) : int
Parameters
$force : bool = false
Return values
int —

longestAxis()

Determines the longest axis.

public longestAxis() : string
Tags
phpstan-return

'r'|'g'|'b'

Return values
string —

volume()

public volume([bool $force = false ]) : int
Parameters
$force : bool = false
Return values
int —

Search results