class final Core · roukmoute/pdf 0.7.1
PDF\Graphics\GraphicsState\SoftMaskAlpha/luminosity mask deriving values from an explicit transparency-group form.Inheritance and contracts
Parent : PDF\Specification\SchemaDictionary
Interfaces : Countable, IteratorAggregate, PDF\Document\VersionedComponent, PDF\Syntax\FileStructure\BasicType, Stringable, Traversable
Definition in the specification
Table 144 · Entries in a soft-mask dictionary
ISO 32000-1:2008, §11.6.5.3 · PDF page 355 ↗
| Entry | PDF type | Source requirement | Table |
|---|---|---|---|
/Type | name | Optional | 144 |
/S | name | Required | 144 |
/G | stream | Required | 144 |
/BC | array | Optional | 144 |
/TR | function or name | Optional | 144 |
Conditional descriptions remain traceable. A definition alone does not implement a codec, a signature or every format mechanism. Read the coverage.
Construction
__construct()
public function __construct(PDF\Graphics\GraphicsState\SoftMaskSubtype $subtype, PDF\Graphics\XObjects\FormXObject $group, ?PDF\Graphics\ColourSpaces\ColourComponents $backdrop = null, ?PDF\Functions\FunctionObject $transfer = null)Declared methods
validateVersion()
public function validateVersion(PDF\Syntax\FileStructure\EffectivePdfVersion $version): voidwith()
public function with(PDF\Syntax\Object\DictionaryObject\Entry $entry): staticwithout()
public function without(PDF\Syntax\Object\NameType|string $key): staticInherited methods
9 methods from parents and contracts
__toString()
public function __toString(): stringcount()
public function count(): intdefinition()
public function definition(): PDF\Specification\TableDefinitionentries()
public function entries(): iterable@return iterable<Entry>get()
public function get(PDF\Syntax\Object\NameType|string $key): ?PDF\Syntax\FileStructure\BasicTypegetIterator()
public function getIterator(): Traversablehas()
public function has(PDF\Syntax\Object\NameType|string $key): booltoPdf()
public function toPdf(PDF\Serialization\SerializationContext $context): stringvalidate()
public function validate(): voidChecks unconditional requirements; conditional and inherited rules remain explicit.Properties
| Declaration | Origin and documentation |
|---|---|
public readonly PDF\Graphics\XObjects\FormXObject $group | PDF\Graphics\GraphicsState\SoftMask |
public readonly PDF\Graphics\GraphicsState\SoftMaskSubtype $subtype | PDF\Graphics\GraphicsState\SoftMask |
Constants
| Name | PHP value | Origin |
|---|---|---|
COMMON_TABLES | | PDF\Specification\SchemaDictionary |
TABLE | | PDF\Graphics\GraphicsState\SoftMask |