OklchColor

Represents a color in the Oklch color space.

Oklch is a cylindrical representation of the Oklab color space, using
lightness (L), chroma (C), and hue (H). It is highly intuitive for
color design and manipulation.

Methods

analogous

public function analogous(int $count): array
Parameters
NameTypeDefault
$count int 2

blend

public function blend(ColorInterface|string $backdrop, string $mode): static
Parameters
NameTypeDefault
$backdrop ColorInterface|string -
$mode string "normal"

complementary

public function complementary(): static

cool

public function cool(float $amount): static
Parameters
NameTypeDefault
$amount float -

darken

public function darken(float $amount): static
Parameters
NameTypeDefault
$amount float -

desaturate

public function desaturate(float $amount): static
Parameters
NameTypeDefault
$amount float -

equals

public function equals(ColorInterface $other): bool
Parameters
NameTypeDefault
$other ColorInterface -

from

static
public static function from(ColorInterface|string $input): static
Parameters
NameTypeDefault
$input ColorInterface|string -

fromChannels

static
public static function fromChannels(array $channels, float $alpha): static

Create color from channel values.

Parameters
NameTypeDefault
$channels array -
$alpha float 1

fromOklab

static
public static function fromOklab(OklabColor $oklab): static

Create an Oklch color from an Oklab color instance.

Parameters
NameTypeDefault
$oklab OklabColor -

fromSrgb

static
public static function fromSrgb(SrgbColor $srgb): static
Parameters
NameTypeDefault
$srgb SrgbColor -

getAlpha

public function getAlpha(): float

getChannels

public function getChannels(): array

getChroma

public function getChroma(): float

Get the chroma component value.

getHue

public function getHue(): float

getLightness

public function getLightness(): float

Get the lightness component value.

getLuminance

public function getLuminance(): float

getOpacity

public function getOpacity(): float

getSaturation

public function getSaturation(): float

getSpaceName

static
public static function getSpaceName(): string

grayscale

public function grayscale(): static

invert

public function invert(): static

isCold

public function isCold(): bool

isDark

public function isDark(): bool

isHot

public function isHot(): bool

isLight

public function isLight(): bool

isOpaque

public function isOpaque(): bool

isTransparent

public function isTransparent(): bool

lighten

public function lighten(float $amount): static
Parameters
NameTypeDefault
$amount float -

parse

static
public static function parse(string $color): static

Parse an oklch() color string into an Oklch color instance.

Parameters
NameTypeDefault
$color string -

rotateHue

public function rotateHue(float $degrees): static
Parameters
NameTypeDefault
$degrees float -

saturate

public function saturate(float $amount): static
Parameters
NameTypeDefault
$amount float -

shade

public function shade(float $t): static
Parameters
NameTypeDefault
$t float -

splitComplementary

public function splitComplementary(): array

temperature

public function temperature(): float

tetradic

public function tetradic(): array

tint

public function tint(float $t): static
Parameters
NameTypeDefault
$t float -

to

public function to(ColorInterface|string $space): ColorInterface
Parameters
NameTypeDefault
$space ColorInterface|string -

toCss

public function toCss(string $space): string
Parameters
NameTypeDefault
$space string null

toHex

public function toHex(bool $withAlpha): string
Parameters
NameTypeDefault
$withAlpha bool false

toOklab

public function toOklab(): OklabColor

Convert the color to its Oklab representation.

toOklch

public function toOklch(): OklchColor

toSrgb

public function toSrgb(): SrgbColor

toString

public function toString(): string

triadic

public function triadic(): array

tryFrom

static
public static function tryFrom(ColorInterface|string $input): static
Parameters
NameTypeDefault
$input ColorInterface|string -

warm

public function warm(float $amount): static
Parameters
NameTypeDefault
$amount float -

withAlpha

public function withAlpha(float $alpha): static
Parameters
NameTypeDefault
$alpha float 1

withChannel

public function withChannel(string $name, int|float $value): static
Parameters
NameTypeDefault
$name string -
$value int|float -

withChannels

public function withChannels(array $partial): static
Parameters
NameTypeDefault
$partial array -