|
Harlequin RIP SDK
|
|
|
|
Harlequin RIP SDK
|
|
Header file defining the Input queue and source API. More...
#include "hqncall.h"Data Structures | |
| struct | sw_inputq_setup |
| Name and contents of a RIP configuration. More... | |
| struct | sw_inputq_api_20171010 |
| Input queue controller function pointer API version 20171010. More... | |
| struct | SWMSG_INPUTQ_CHANGE |
| The message associated with SWEVT_INPUTQ_CHANGE events. More... | |
| struct | SWMSG_INPUTS_ENABLE |
| The message associated with SWEVT_INPUTS_ENABLE events. More... | |
Macros | |
| #define | inputq_print_job inputq_api->print_job |
| Insert a job into the input queue for printing by the RIP. More... | |
| #define | inputq_delete_job inputq_api->delete_job |
| Delete a job from the input queue. More... | |
| #define | inputq_iterate_setups inputq_api->iterate_setups |
| Iterate over the available job setups. More... | |
| #define | inputq_source_add inputq_api->source_add |
| Inform the input queue system of a persistent source that will add entries to the queue. More... | |
| #define | inputq_source_remove inputq_api->source_remove |
| Inform the input queue system that a persistent source previously added with the sw_inputq_api_20171010::source_add() method has been removed. More... | |
| #define | inputq_signal_waiters inputq_api->signal_waiters |
| Release threads blocked on the input queue, even if there is no input. More... | |
Typedefs | |
| typedef HqnResult | sw_inputq_result |
| Status return type for API calls. More... | |
| typedef struct sw_inputq_setup | sw_inputq_setup |
| Name and contents of a RIP configuration. More... | |
| typedef sw_inputq_result() | sw_inputq_setup_fn(const sw_inputq_setup *setup, size_t size, void *data) |
| Type of a callback function for iterating RIP configurations. More... | |
| typedef void() | sw_inputq_decontext_fn(void *jobcontext) |
| Type of a callback function for disposing of a job context. More... | |
| typedef HqBool() | sw_inputq_mkcontext_fn(void *data, void **jobcontext, sw_inputq_decontext_fn **decontext) |
| Type of a callback function for making a job context and its disposal callback. More... | |
| typedef struct sw_inputq_api_20171010 | sw_inputq_api_20171010 |
| Input queue controller function pointer API version 20171010. | |
| typedef int32 | sw_inputq_change_reason |
| Type for queue change reasons. Variables of this type should store one of the SW_INPUTQ_CHANGE_REASON enumeration values. | |
| typedef struct SWMSG_INPUTQ_CHANGE | SWMSG_INPUTQ_CHANGE |
| The message associated with SWEVT_INPUTQ_CHANGE events. More... | |
| typedef int32 | sw_input_enable_state |
| Type for input enable states. Variables of this type should store one of the SW_INPUT_ENABLE_STATE enumeration values. | |
| typedef struct SWMSG_INPUTS_ENABLE | SWMSG_INPUTS_ENABLE |
| The message associated with SWEVT_INPUTS_ENABLE events. More... | |
Enumerations | |
| enum | SW_INPUTQ_RESULT { SW_INPUTQ_SUCCESS = HQN_RESULT_SUCCESS , SW_INPUTQ_ERROR , SW_INPUTQ_ERROR_MEMORY , SW_INPUTQ_ERROR_SETUP , SW_INPUTQ_ERROR_JOB , SW_INPUTQ_ERROR_QPOS , SW_INPUTQ_ERROR_PARAMS } |
| Return codes for API calls. More... | |
| enum | SW_INPUTQ_CHANGE_REASON { SW_INPUTQ_JOB_ADDED_Q , SW_INPUTQ_JOB_ADDED , SW_INPUTQ_JOB_DELETED_UI , SW_INPUTQ_JOB_DELETED_API , SW_INPUTQ_JOB_DELETED_AUTO , SW_INPUTQ_JOB_DELETED_Q } |
| Reasons for queue change event message. More... | |
| enum | SW_INPUT_ENABLE_STATE { SW_INPUTS_ENABLE_UNKNOWN = -1 , SW_INPUTS_ENABLE_STOPPED = 0 , SW_INPUTS_ENABLE_START = 1 , SW_INPUTS_ENABLE_STOP = 2 } |
| Valid states for the SWMSG_INPUTS_ENABLE::enable field. More... | |
Header file defining the Input queue and source API.
Copyright (C) 2023 Global Graphics Software Ltd. All rights reserved. This source code contains the confidential and trade secret information of Global Graphics Software Ltd. It may not be used, copied or distributed for any reason except as set forth in the applicable Global Graphics license agreement.