Index

  1. \setasign\SetaPDF2
    1. Core
      1. DataStructure
        1. Color
          1. AbstractColor
          2. Cmyk
          3. Gray
          4. Rgb
          5. Special

setasign\SetaPDF2\Core\DataStructure\Color

Rgb RGB Color

File: /SetaPDF v2/Core/DataStructure/Color/Rgb.php
Old class name (alias): \SetaPDF_Core_DataStructure_Color_Rgb

Class hierarchy

Implements

Summary

Static Methods

Methods

Properties

Properties

$_components

protected \SetaPDF_Core_Type_Array AbstractColor::$_components

The array of color components


Static Methods

createByComponents()

public static AbstractColor::createByComponents (
int|float|string|array|\SetaPDF_Core_Type_Array $components
): \SetaPDF_Core_DataStructure_Color

Create an instance by a PDF array object, PHP array or a hexadecimal string of an RGB value.

Parameters
$components : int|float|string|array|\SetaPDF_Core_Type_Array
 
Exceptions

Throws \InvalidArgumentException

hexToRgb()

public static Rgb::hexToRgb (
string $hex
): array

Converts a hex encoded string (3 or 6 characters) into a component array of red, green and blue values.

Parameters
$hex : string
 

writePdfString()

public static Rgb::writePdfString (
\SetaPDF_Core_WriteInterface $writer,
array|float $componentsOrR,
bool|float $strokingOrG = 0.0,
float $b = 0.0,
bool $stroking = true
): void

Writes a color definition directly to a writer.

Parameters
$writer : \SetaPDF_Core_WriteInterface
 
$componentsOrR : array|float

An array of 3 components or the value for the red component

$strokingOrG : bool|float

Stroking flag or the value for the green component

$b : float

The value for the blue component

$stroking : bool

Stroking flag

Exceptions

Throws \InvalidArgumentException

writePdfStringByComponents()

public static AbstractColor::writePdfStringByComponents (
\SetaPDF_Core_WriteInterface $writer,
array|int|float|string $components,
bool $stroking = true
): void

Writes a color definition directly to a writer.

Parameters
$writer : \SetaPDF_Core_WriteInterface
 
$components : array|int|float|string
 
$stroking : bool
 
Exceptions

Throws \InvalidArgumentException


Methods

__construct()

public Rgb::__construct (
\SetaPDF_Core_Type_Array|array|float $componentsOrR,
float $g = 0.0,
float $b = 0.0
)

The constructor.

Parameters
$componentsOrR : \SetaPDF_Core_Type_Array|array|float
 
$g : float
 
$b : float
 
Exceptions

Throws \InvalidArgumentException

__clone()

public AbstractColor::__clone (
void
): void

Implementation of __clone().

adjustAllComponents()

public AbstractColor::adjustAllComponents (
int|float $by
): void

Adjust all color components by a specific value.

Parameters
$by : int|float
 

draw()

public Rgb::draw (
\SetaPDF_Core_WriteInterface $writer,
bool $stroking = true
): void

Draw the color on a writer.

Parameters
$writer : \SetaPDF_Core_WriteInterface
 
$stroking : bool
 
See

getValue()

public AbstractColor::getValue (
void
): \SetaPDF_Core_Type_Array

Get the components of the color.

toPhp()

public AbstractColor::toPhp (
void
): array

Get the data as a PHP value.


© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)