ImageXObject · PDFToolkit

class final Core · roukmoute/pdf 0.6.2

PDF\Graphics\XObjects\ImageXObject

Real image XObject from decoded normalized rows; masks and Decode are explicit.

Read the source declaration ↗

Inheritance and contracts

Parent : PDF\Syntax\Object\StreamObject

Interfaces : PDF\Document\VersionedComponent, PDF\Syntax\FileStructure\BasicType, Stringable

Construction

__construct()

public function __construct(PDF\Document\Images\ImageSamples $samples, ?PDF\Graphics\XObjects\ImageDecode $decode = null, PDF\Graphics\XObjects\ImageMask|PDF\Graphics\XObjects\ColourKeyMask|null $mask = null, ?PDF\Graphics\XObjects\SoftMaskImage $softMask = null, PDF\Graphics\XObjects\ImageOptions $options = new ImageOptions(), PDF\Syntax\Filters\Filter ...$filters)

Declared by PDF\Graphics\XObjects\ImageXObject · View the code ↗

Declared methods

colourAt()

public function colourAt(int $x, int $y): PDF\Graphics\ColourSpaces\ColourComponents

Declared by PDF\Graphics\XObjects\ImageXObject · View the code ↗

decodedAt()

public function decodedAt(int $x, int $y): PDF\Graphics\ColourSpaces\ColourComponents

Exposes the linear Decode result before PDF colour-space clipping.

Declared by PDF\Graphics\XObjects\ImageXObject · View the code ↗

validateVersion()

public function validateVersion(PDF\Syntax\FileStructure\EffectivePdfVersion $version): void

Declared by PDF\Graphics\XObjects\ImageXObject · View the code ↗

Inherited methods

4 methods from parents and contracts

__toString()

public function __toString(): string

Declared by PDF\Syntax\Object\StreamObject · View the code ↗

bytes()

public function bytes(PDF\Serialization\SerializationContext $context): string

Declared by PDF\Syntax\Object\StreamObject · View the code ↗

dictionary()

public function dictionary(): PDF\Syntax\Object\DictionaryType

Declared by PDF\Syntax\Object\StreamObject · View the code ↗

toPdf()

public function toPdf(PDF\Serialization\SerializationContext $context): string

Declared by PDF\Syntax\Object\StreamObject · View the code ↗

Properties

Declaration	Origin and documentation
`public readonly PDF\Graphics\ColourSpaces\ColourSpace $colourSpace`	PDF\Graphics\XObjects\ImageXObject
`public readonly PDF\Syntax\ContentStreamsResources\ContentStreams\|string $data`	PDF\Syntax\Object\StreamObject
`public readonly PDF\Graphics\XObjects\ImageDecode $decode`	PDF\Graphics\XObjects\ImageXObject
`public readonly array $filters`	PDF\Syntax\Object\StreamObject @var list<Filter>
`public readonly PDF\Graphics\XObjects\ImageMask\|PDF\Graphics\XObjects\ColourKeyMask\|null $mask`	PDF\Graphics\XObjects\ImageXObject
`public readonly PDF\Document\Images\ImageSamples $samples`	PDF\Graphics\XObjects\ImageXObject
`public readonly ?PDF\Graphics\XObjects\SoftMaskImage $softMask`	PDF\Graphics\XObjects\ImageXObject