|
Harlequin RIP SDK
|
|
|
|
Harlequin RIP SDK
|
|
Message for SWEVT_RR_CONNECT: establishes a connection to an HVD cache instance. More...
#include "rrevents.h"
Data Fields | |
| sw_tl_ref | timeline |
| uint8 | cache_id [256] |
| uint8 | setup_id [256] |
| void * | connection |
| HqBool | position_independent_compatible |
| HqBool | allow_zero_elements |
Message for SWEVT_RR_CONNECT: establishes a connection to an HVD cache instance.
| HqBool SWMSG_RR_CONNECT::allow_zero_elements |
If the client code can handle having zero elements in a page or tile, then it should set this flag to TRUE. The default value is FALSE, which causes the HVD implementation to create an empty dummy element if there are no elements intersecting a page or tile. Client code written against a prior version of the API will not set this flag, and therefore will have at least one element per page or tile.
| uint8 SWMSG_RR_CONNECT::cache_id[ 256] |
A zero-terminated string identifying the cache to which we wish to connect. This discrimination allows a single RIP to have multiple HVD-capable implementations installed, and to direct its events at the appropriate one.
| void* SWMSG_RR_CONNECT::connection |
If the event is successfully handled, this is set to an opaque handle uniquely identifying the connection.
| HqBool SWMSG_RR_CONNECT::position_independent_compatible |
If the client code can handle position independent scan results (i.e., where the element x and y offsets can be non-zero) then it should set this flag to TRUE. Client code written against a prior version of the API will not set this flag, naturally, and therefore the scanner will not operate in position independent mode.
| uint8 SWMSG_RR_CONNECT::setup_id[ 256] |
A zero-terminated string identifying the setup associated with this connection to the cache. The contract between provider and user of this interface is that this setup id uniquely describes a configuration of the RIP in every respect; if this is not the case then correct behaviour cannot be guaranteed. That is, if any parameter of the page device or other salient configuration item differs between the creation and use of items in the cache, undefined behavour will result. As a special case, if this ID is the empty string then a cache instance is created upon connection and is immediately destroyed upon disconnection.
| sw_tl_ref SWMSG_RR_CONNECT::timeline |
Identifies the job containing the pages.