Class DeviceGray in namespace setasign\SetaPDF2\Core\ColorSpace in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. ColorSpace
    1. AbstractResource
    2. ColorSpace
    3. DeviceCmyk
    4. DeviceGray
    5. DeviceN
    6. DeviceRgb
    7. IccBased
    8. Indexed
    9. Lab
    10. Separation

setasign\SetaPDF2\Core\ColorSpace

DeviceGray DeviceGray Color Space

File: /SetaPDF v2/Core/ColorSpace/DeviceGray.php
Old class name (alias): \SetaPDF_Core_ColorSpace_DeviceGray

Class hierarchy

ColorSpace
- DeviceGray

Summary

Properties

$_indirectObject

protected \SetaPDF_Core_Type_IndirectObjectInterface ColorSpace::$_indirectObject

The indirect object for this color space

$_value

protected \SetaPDF_Core_Type_Name|\SetaPDF_Core_Type_Array ColorSpace::$_value

The main color space PDF value

Static Methods

create()

public static DeviceGray::create (

void

): \SetaPDF_Core_ColorSpace_DeviceGray

Creates an instance of this color space.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

createByDefinition()

public static ColorSpace::createByDefinition (

string|\SetaPDF_Core_Type_Name|\SetaPDF_Core_Type_Array|\SetaPDF_Core_Type_IndirectObjectInterface $object

Creates a color space instance based on the incoming value.

Parameters

$object : string|\SetaPDF_Core_Type_Name|\SetaPDF_Core_Type_Array|\SetaPDF_Core_Type_IndirectObjectInterface: A color space definition

Exceptions

Throws \InvalidArgumentException

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Exception

Methods

__construct()

public DeviceGray::__construct (

\SetaPDF_Core_Type_AbstractType $name

)

The constructor.

Parameters

$name : \SetaPDF_Core_Type_AbstractType

Exceptions

Throws \InvalidArgumentException

Throws \setasign\SetaPDF2\Core\Exception

getColorComponents()

public DeviceGray::getColorComponents (

void

): int

Get the color components of this color space.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

getDefaultDecodeArray()

public DeviceGray::getDefaultDecodeArray (

void

): array

Get the default decode array of this color space.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

getFamily()

public ColorSpace::getFamily (

void

): string

Get the color space family name of this color space.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

getPdfValue()

public ColorSpace::getPdfValue (

void

): \SetaPDF_Core_Type_Name|\SetaPDF_Core_Type_Array

Get the main color space PDF value.