|
Harlequin RIP SDK
|
|
|
|
Harlequin RIP SDK
|
|
Structure modified by raster consumer during a DeviceIOCtl_BlankPage call to determine how to handle blank pages. Blank pages may be detected because all separations were omitted (in which case the PGB NumSeparations param will be 0), or if there is nothing on the display list. The DeviceIOCtl_BlankPage call will only be made for the final output pass, not for compositing or partial paints. The page number, separations, and all other relevant parameters will have been sent to the PGB device before the IOCtl call. More...
#include "swraster.h"
Data Fields | |
| int32 | action |
| int32 | reason |
| HqBool | handled |
| int32 | eraseno |
| struct sw_datum * | raster_params |
| RASTER_LAYOUT * | raster_layout |
Structure modified by raster consumer during a DeviceIOCtl_BlankPage call to determine how to handle blank pages. Blank pages may be detected because all separations were omitted (in which case the PGB NumSeparations param will be 0), or if there is nothing on the display list. The DeviceIOCtl_BlankPage call will only be made for the final output pass, not for compositing or partial paints. The page number, separations, and all other relevant parameters will have been sent to the PGB device before the IOCtl call.
| int32 RASTER_BLANK::action |
One of the blank_page_action_t enumeration values. This is set to a default action by the caller. It may be modified by the callee to change the action.
| int32 RASTER_BLANK::eraseno |
Page generation ID. See RASTER_REQUIREMENTS::eraseno.
| HqBool RASTER_BLANK::handled |
Flag which is set to FALSE by the caller, and set to TRUE by the callee if it has done everything it needs to do. If not, the caller will keep calling with the same data until either this flag is set to TRUE or the callee returns an error.
| RASTER_LAYOUT* RASTER_BLANK::raster_layout |
The raster layout for the pagedevice. If the raster backend wishes to access this structure after the call is finished, it should call raster_layout_acquire() to get a pointer that will remain valid, or copy the layout into its own memory using raster_layout_copy(). Pointers acquired using raster_layout_acquire() must be released using raster_layout_release() before the RIP shuts down.
| struct sw_datum* RASTER_BLANK::raster_params |
Optional structured data for raster parameters. If the raster backend wishes to access these parameters after the call is finished, it should either unpack them into its own variables, or use the sw_data_api::retain() and sw_data_api::release() functions to preserve the data tree.
| int32 RASTER_BLANK::reason |
One of the blank_page_reason_t enum values. This is set by the caller to indicate why the page was detected as blank. The callee can use this to determine whether it will modify the action. In some cases, more information may be available from the page's RasterDescription if handling of the blank page is deferred to let the RIP output.