Harlequin RIP SDK
sw_htm_raster_info Struct Reference

Information about the destination raster. More...

#include "swhtm.h"

Data Fields

sw_htm_resolution x_resolution
 The x (horizontal) resolution, in dots per inch, expressed as a floating-point number.
 
sw_htm_resolution y_resolution
 The y (vertical) resolution, in dots per inch, expressed as a floating-point number.
 
sw_htm_coord width
 The width of the raster, in pixels.
 
sw_htm_coord height
 The height of the raster, in pixels.
 
sw_htm_coord band_height
 The height of each band, in lines (pixels). More...
 
unsigned int bit_depth
 The number of bits per pixel for each channel of the raster.
 
sw_htm_colorspace colorspace
 The fundamental colorspace of the raster. More...
 
unsigned int num_process_colorants
 The number of process colorants in the raster. More...
 
unsigned int num_colorant_infos
 The total number of colorants in the colorant_infos array. More...
 
const sw_htm_colorant_infocolorant_infos
 Array of colorant information structures. More...
 
sw_htm_raster_interleaving interleaving
 Raster interleaving. More...
 
HqBool separating
 Whether the raster is separated. More...
 
unsigned int num_separations
 The number of separations being produced. More...
 
unsigned int job_number
 The ordinal job number of the job being processed.
 
unsigned int page_number
 The ordinal number of the page within the job. More...
 
int msk_linebytes
 The number of bytes between consecutive lines of a mask raster. More...
 
int src8_linebytes
 The number of bytes between consecutive lines of an 8-bit source raster. More...
 
int src16_linebytes
 The number of bytes between consecutive lines of a 16-bit source raster. More...
 
int dst_linebytes
 The number of bytes between consecutive lines of the destination raster. More...
 

Detailed Description

Information about the destination raster.

Field Documentation

◆ band_height

sw_htm_coord sw_htm_raster_info::band_height

The height of each band, in lines (pixels).

For band interleaved, the same number of lines are present for each channel of the raster. Note, however, that the last band in a page, frame or separation may actually contain fewer lines than the rest. The actual number present is passed in the call to sw_htm_api::DoHalftone().

◆ colorant_infos

const sw_htm_colorant_info* sw_htm_raster_info::colorant_infos

Array of colorant information structures.

This will have one entry for each colorant in each separation of the page so far, giving the colorant name and the raster channel index number to which the colorant is mapped. Spot colors will not necessarily appear in the list at the time sw_htm_api::HalftoneSelect() is called, because they may get added later. Raster channels for fixed colorants may be omitted, for example due to separation omission or progresive separation styles, but this does not mean that those channels won't be present, merely that they have no colorants mapped to them for that separation.

◆ colorspace

sw_htm_colorspace sw_htm_raster_info::colorspace

The fundamental colorspace of the raster.

One of the sw_htm_colorspace values.

◆ dst_linebytes

int sw_htm_raster_info::dst_linebytes

The number of bytes between consecutive lines of the destination raster.

This is the number to add to the byte address of one line in order to get the byte address of the next line in the raster.

◆ interleaving

sw_htm_raster_interleaving sw_htm_raster_info::interleaving

Raster interleaving.

This is one of the the sw_htm_raster_interleave values. Monochrome is treated as SW_HTM_RASTER_INTERLEAVE_BAND, but with only a single channel present.

◆ msk_linebytes

int sw_htm_raster_info::msk_linebytes

The number of bytes between consecutive lines of a mask raster.

This is the number to add to the byte address of one line in order to get the byte address of the next line in the raster.

◆ num_colorant_infos

unsigned int sw_htm_raster_info::num_colorant_infos

The total number of colorants in the colorant_infos array.

This is the total number of colorants mapped to raster channels, at the time the screening module is called, for all separations of the page so far. See colorant_infos, below, for more information.

◆ num_process_colorants

unsigned int sw_htm_raster_info::num_process_colorants

The number of process colorants in the raster.

This is also the number of fixed colorant channels.

◆ num_separations

unsigned int sw_htm_raster_info::num_separations

The number of separations being produced.

Actually, this is better thought of as the minimum number. Spot separations will not necessarily be included at the time sw_htm_api::HalftoneSelect() is called, because they may get added later.

◆ page_number

unsigned int sw_htm_raster_info::page_number

The ordinal number of the page within the job.

This is not necessarily the same as any document page number.

◆ separating

HqBool sw_htm_raster_info::separating

Whether the raster is separated.

The value will be FALSE for composite and genuinely monochrome rasters.

separating implies that the use of interrelated channels may not be possible, because only the color values for the separation(s) being produced, at any one time, will be available to the RIP.

As an example, consider a separated job being output to a composite device. When halftoning the Cyan separation, the RIP will use the halftone instance for the Cyan colorant, but the channel to which it is mapped could be Black (for conventional separations) or Cyan (for colored or progressive separations). The other channels may or may not be blank. The RIP only knows the value of the Cyan component, so it could not satisfy the need of an interrelated channels halftone needing all four CMYK values.

◆ src16_linebytes

int sw_htm_raster_info::src16_linebytes

The number of bytes between consecutive lines of a 16-bit source raster.

This is the number to add to the byte address of one line in order to get the byte address of the next line in the raster.

Whether the actual source rasters will be 16 bit depends on the gray level settings, see sw_htm_select_info::src_bit_depth.

The same number will apply to any object properties map.

◆ src8_linebytes

int sw_htm_raster_info::src8_linebytes

The number of bytes between consecutive lines of an 8-bit source raster.

This is the number to add to the byte address of one line in order to get the byte address of the next line in the raster.

Whether the actual source rasters will be 8 bit depends on the gray level settings, see sw_htm_select_info::src_bit_depth.

The same number will apply to any object properties map.


The documentation for this struct was generated from the following file: