(v13) The PageHeaderColorant structure

This page applies to Harlequin v13.1r0 and later; and to Harlequin MultiRIP but not Harlequin Core

This structure establishes the link between a colorant and the channel to which it is mapped. There is an onward link to the next colorant.

TEXT

    typedef struct pageHeaderColorant
    {
      struct pageHeaderColorant * pNext; int32 nChannel;
      uint8 colorantName [32];
    float srgbOriginal [3];
      float srgbEquivalent [3]; int32 specialHandling; float cmykEquivalent [4]; float neutralDensity;
    } PageHeaderColorant;

Note: It is possible for a plugin to define aliases for colorant names. This is demonstrated by the ‘opeg3' output plugin example, which allows Hexachrome PostScript language jobs to use colorant names such as ‘Cyan', ‘Magenta' and ‘Yellow' in place of the more technically correct ‘HexCyan', ‘HexMagenta' and ‘HexYellow'.

pNext (PageHeaderColorant)

pNext Wr

Type: pageHeaderColorant *

These structures form a linked list, and this is the next pointer.

nChannel (PageHeaderColorant)

nChannel Wr

Type: int32

The number of the channel on which this colorant is used (to which it is mapped). Channels are always presented in ascending numerical order, counting from zero, but there may be some missing (the channel is blank - has no colorant mapped onto it) or may appear more than once (more than one separation is imposed on the channel).

colorantName (PageHeaderColorant)

colorantName Wr

Type: uint8 [32]

The name by which the colorant is known (not the channel). This will be the preferred name for process colorants and the name given by the job to a spot color. For example, “Cyan”, “Photo Magenta” or “PANTONE836”.

This field uses the character encoding method supplied by the job or the plugin, as appropriate.

Note: It is possible for a plugin to define aliases for colorant names. This is demonstrated by the ‘opeg3' output plugin example, which allows Hexachrome PostScript language jobs to use colorant names such as ‘Cyan', ‘Magenta' and ‘Yellow' in place of the more technically correct ‘HexCyan', ‘HexMagenta' and ‘HexYellow'.

srgbOriginal (PageHeaderColorant)

srgbOriginal Wr

Type: float [3]

An RGB triple as values 0..1 describing an sRGB color. Initialized by the RIP and used only by the Roam preview function.

srgbEquivalent (PageHeaderColorant)

srgbEquivalent Wr

Type: float [3]

A color in the sRGB (IEC 61966) colorspace, (or if an approximation, in DeviceRGB color space) for the solid colorant for use in Roam, Preview, and similar uses. For example [1.0, 0.0, 1.0] (Magenta).

specialHandling (PageHeaderColorant)

specialHandling Wr

Type: int32

Describes the way in which the colorant should be handled, where the plugin is capable of doing so. This allows for back-end trapping solutions, more accurate screen previews and so on. This field is used in plugin v.18 and later only.

Possible values are:

`SPECIALHANDLING_NONE (0)`	`None` : an ordinary translucent process or spot colorant.
`SPECIALHANDLING_OPAQUE (1)`	`Opaque` : a colorant like a metallic or foil (as per Red Book table 6.12).
`SPECIALHANDLING_OPAQUEIGNORE (2)`	`OpaqueIgnore` : opaque, but special trapping rules apply.
`SPECIALHANDLING_TRANSPARENT (3)`	`Transparent` : such as a varnish.
`SPECIALHANDLING_TRAPZONES (4)`	`TrapZones` : the colorant defines a trap zone mask, rather than a true marking colorant.
`SPECIALHANDLING_TRAPHIGHLIGHTS (5)`	`TrapHighlights` : the colorant is used only to show where traps are present on the page. Suppression of this colorant will result in the highlights being omitted. The plugin is not required to implement this suppression, but it is useful particularly for Roam and similar applications.

cmykEquivalent (PageHeaderColorant)

cmykEquivalent Wr

Type: float [4]

As per srgbEquivalent , except the color is expressed as a CMYK. Values are in the range 0 to 1 as per the PostScript language setcmykcolor operator. For example [0.0, 0.0, 1.0, 0.0]

neutralDensity (PageHeaderColorant)

neutralDensity Wr

Type: float

The neutral density of the colorant. This information should be provided in the definition of the colorant by the job. However, sometimes this does not happen. Defaults are provided for Cyan, Magenta, Yellow and Black (where relevant), so will always be set, but for other colorants, a negative number is used to indicate this. In that case, if density is important to the consuming plugin, one option is to estimate the density from the CMYK equivalents and their densities.