SetaPDF_Core_DataStructure_Color_Rgb RGB Color
File: /SetaPDF v2/Core/DataStructure/Color/Rgb.php
Class hierarchy
Implements
Summary
Properties
Static Methods
createByComponents()
public static SetaPDF_Core_DataStructure_Color::createByComponents (
int|float|string|array|SetaPDF_Core_Type_Array $components
): SetaPDF_Core_DataStructure_ColorCreate 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()
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 SetaPDF_Core_DataStructure_Color_Rgb::writePdfString (
SetaPDF_Core_WriteInterface $writer, array|float $componentsOrR [, boolean|float $strokingOrG = 0.0 [, float $b = 0.0 [, boolean $stroking = true ]]]
): voidWrites 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 : boolean|float
Stroking flag or the value for the green component
- $b : float
The value for the blue component
- $stroking : boolean
Stroking flag
Exceptions
Throws InvalidArgumentException
writePdfStringByComponents()
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 SetaPDF_Core_DataStructure_Color_Rgb::__construct ()
The constructor.
Parameters
- $componentsOrR : SetaPDF_Core_Type_Array|array|float
- $g : float
- $b : float
Exceptions
Throws InvalidArgumentException
draw()
public SetaPDF_Core_DataStructure_Color_Rgb::draw (
SetaPDF_Core_WriteInterface $writer [, boolean $stroking = true ]
): voidDraw the color on a writer.
Parameters
- $writer : SetaPDF_Core_WriteInterface
- $stroking : boolean