|
Harlequin RIP SDK
|
|
|
|
Harlequin RIP SDK
|
|
Structure describing what the RIP wants sw_htm_api::DoHalftone() to do. More...
#include "swhtm.h"
Data Fields | |
| void(* | DoneHalftone )(const struct sw_htm_dohalftone_request *request, sw_htm_result result) |
| The screening module calls this to signal to the RIP that the module has finished processing the request. More... | |
| const sw_htm_render_info * | render_info |
| Overall information about the render. | |
| unsigned int | band_num |
| The ordinal number of the band being processed, within the page. | |
| sw_htm_coord | first_line_y |
| The position of the band in the overall raster, expressed as the line-index (or y coordinate) of the first line in the band. | |
| unsigned int | num_lines |
| The number of raster lines to be halftoned (for each channel). More... | |
| int | channel_id |
| The index within the separation of the first or only channel. More... | |
| unsigned int | separation_number |
| The ordinal number of the separation being rendered. More... | |
| sw_htm_raster_ptr | msk_bitmap |
| The pointer to the mask bitmap. | |
| sw_htm_mask_hint | msk_hint |
| This hint is one of the sw_htm_maskhint constants. More... | |
| sw_htm_raster_ptr | object_props_map |
| The pointer to the object properties map. More... | |
| unsigned int | num_src_channels |
| The number of raster channel pointers in the src_channels array. | |
| sw_htm_raster_ptr * | src_channels |
| The array of raster channel pointers to the source channel(s). More... | |
| unsigned int | num_dst_channels |
| The number of raster channel pointers in the dst_channels array. | |
| sw_htm_raster_ptr * | dst_channels |
| The array of raster channel pointers to the destination channel(s). More... | |
| unsigned int | thread_index |
| Index of the current thread, an int in 0...max_render_threads-1. | |
Structure describing what the RIP wants sw_htm_api::DoHalftone() to do.
| int sw_htm_dohalftone_request::channel_id |
The index within the separation of the first or only channel.
This corresponds to the sw_htm_colorant_info::channel field. This is principally to help screening modules differentiate one channel from another, e.g., when the same halftone instance is being used to screen several channels independently of each other, such as will often be the case when screening spot colors using the /Default entry of a type-5 halftone dictionary.
| void( * sw_htm_dohalftone_request::DoneHalftone) (const struct sw_htm_dohalftone_request *request, sw_htm_result result) |
The screening module calls this to signal to the RIP that the module has finished processing the request.
The result argument indicates the success or otherwise of the halftone processing.
| [in] | request | Pointer to the structure detailing the request. This must be exactly the same request pointer passed in to sw_htm_api::DoHalftone(). |
| [in] | result | The value SW_HTM_SUCCESS if halftoning was successful, otherwise one of the sw_htm_error error constants. |
| sw_htm_raster_ptr* sw_htm_dohalftone_request::dst_channels |
The array of raster channel pointers to the destination channel(s).
The sw_htm_api::DoHalftone() invocation has exclusive access to these rasters for its duration. Note that when using latency, the module may retain pointers to destination channels from earlier calls to sw_htm_api::DoHalftone() and examine and modify those buffers, but that access is not exclusive and the module is responsible for any synchronization required.
| sw_htm_mask_hint sw_htm_dohalftone_request::msk_hint |
This hint is one of the sw_htm_maskhint constants.
It is intended to allow some optimisation when the mask has all of its bits set, or all of its bits clear.
| unsigned int sw_htm_dohalftone_request::num_lines |
The number of raster lines to be halftoned (for each channel).
This may be less than the overall band height, such as in the last band of the page or frame.
| sw_htm_raster_ptr sw_htm_dohalftone_request::object_props_map |
The pointer to the object properties map.
This will be NULL unless the boolean sw_htm_instance::want_object_map was set to TRUE for the halftone instance.
| unsigned int sw_htm_dohalftone_request::separation_number |
The ordinal number of the separation being rendered.
This corresponds to the sw_htm_colorant_info::separation field. For composite pages, this will always be 1.
| sw_htm_raster_ptr* sw_htm_dohalftone_request::src_channels |
The array of raster channel pointers to the source channel(s).
These will be 8- or 16-bit rasters, as indicated in render_info. Only sw_htm_render_info::src_values_per_component distinct values are used, but packed high, so (almost) the full range is covered.