Harlequin RIP SDK
sw_htm_select_info Struct Reference

Information passed to the screening module for sw_htm_api::HalftoneSelect(). More...

#include "swhtm.h"

Data Fields

const sw_htm_raster_infodst_raster_info
 Information about the destination raster (page or separation).
 
unsigned int src_bit_depth
 The source raster bit depth to be used.
 
float screen_rotation
 If a screening module wishes to honor the /ScreenRotate systemparam (a Harlequin extension), this is the number of degrees of rotation present in the pagedevice, and by which any screen should be rotated. It is zero if /ScreenRotate is false.
 
sw_htm_coord phasex
 The x (horizontal) value from the sethalftonephase operator, or its equivalent.
 
sw_htm_coord phasey
 The y (vertical) value from the sethalftonephase operator, or its equivalent.
 
unsigned int max_render_threads
 The maximum number of renderer threads the RIP will use. More...
 
const sw_data_apidata_api
 An implementation pointer for access to the sw_datum values in this structure.
 
sw_datum colorantname
 A string sw_datum containing the name of the component screen for which this halftone is being selected. More...
 
sw_datum halftonedict
 A dictionary sw_datum that represents the halftone dictionary. More...
 
unsigned int src_values_per_component
 The number of color values for each component of the source raster. More...
 
unsigned int colorant_index
 Index of the colorant in sw_htm_raster_info::colorant_infos. More...
 

Detailed Description

Information passed to the screening module for sw_htm_api::HalftoneSelect().

Field Documentation

◆ colorant_index

unsigned int sw_htm_select_info::colorant_index

Index of the colorant in sw_htm_raster_info::colorant_infos.

Contains the index for the colorant for which this halftone is being selected. This will refer to the actual spot colorant, even if the halftone dictionary only has a /Default for it. However, the /Default screen will also be set up, and on that call, this will be SW_HTM_DEFAULT_INDEX (not an index of any colorant in the array). This information allows the module to select a specific screen for any spot colorant or provide a shared default.

◆ colorantname

sw_datum sw_htm_select_info::colorantname

A string sw_datum containing the name of the component screen for which this halftone is being selected.

This can be an explicit name from a type 5 dictionary, or the name of a process colorant implicitly declared, or (Default) for spot colorants not explicitly named (but see colorant_index).

◆ halftonedict

sw_datum sw_htm_select_info::halftonedict

A dictionary sw_datum that represents the halftone dictionary.

Note that some keys in halftone dictionaries are consumed by the RIP and not passed on to the screening module. These include DetectSeparation, InheritAngle, InheritFrequency, Override, OverrideAngle, OverrideFrequency and TransferFunction.

◆ max_render_threads

unsigned int sw_htm_select_info::max_render_threads

The maximum number of renderer threads the RIP will use.

Note
The RIP may opt to use fewer than this at render time, but it will never use more.

◆ src_values_per_component

unsigned int sw_htm_select_info::src_values_per_component

The number of color values for each component of the source raster.

This is determined by the value of the ScreenLevels system parameter at selection time.

If the module cannot work with this setting, it should return SW_HTM_ERROR_UNSUPPORTED_SRC_BIT_DEPTH.


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