|
Harlequin RIP SDK
|
|
|
|
Harlequin RIP SDK
|
|
Header file defining the Events system, built on RIP Data Resource (RDR) System. More...
Data Structures | |
| struct | sw_event |
| Event structure. More... | |
| struct | sw_event_handler |
| Event Handler structure. More... | |
| struct | sw_event_handlers |
| Atomic multiple Handler registration. More... | |
| struct | sw_event_api_20110330 |
| Structure for the Event API version 20110330. More... | |
Macros | |
| #define | SW_EVENT_HANDLER_INIT { NULL, NULL, 0 } |
| Static/auto initialiser for sw_event_handler. | |
| #define | SW_EVENT_HANDLERS_INIT { NULL, NULL, 0, EVENT_EVENT, SW_EVENT_NORMAL } |
| Static/auto initialiser for sw_event_handlers. | |
Typedefs | |
| typedef sw_rdr_type | sw_event_type |
| A type used to store and communicate Event types. | |
| typedef sw_rdr_priority | sw_event_priority |
| A type used to store and communicate event handler priorities. | |
| typedef sw_rdr_id | sw_event_id |
| Event IDs. More... | |
| typedef HqnResult | sw_event_result |
| A type used for return values from Event handlers. More... | |
| typedef struct sw_event_context | sw_event_context |
| Opaque event context for internal use only. More... | |
| typedef sw_event_result(* | event_handler) (void *context, sw_event *event) |
| The Event Handler prototype. More... | |
Enumerations | |
| enum | { EVENT_EVENT = 0 , EVENT_RDR = 100 , EVENT_RESERVE1 = 200 , EVENT_TIMELINE = 300 , EVENT_SKIN = 0x4000 , EVENT_PLUGAPI =0x6000 , EVENT_CORE = 0x8000 } |
| Event types. More... | |
| enum | { SW_EVENT_DEFAULT = -10000 , SW_EVENT_NORMAL = 0 , SW_EVENT_OVERRIDE = 10000 } |
| Event Handler Priorities. More... | |
| enum | EVENT_RESULT { SW_EVENT_CONTINUE = -2 , SW_EVENT_FORCE_UNHANDLED = -1 , SW_EVENT_HANDLED = HQN_RESULT_SUCCESS , SW_EVENT_ERROR = 1 , SW_EVENT_UNHANDLED = SW_EVENT_CONTINUE } |
| Result values from Event Handlers. More... | |
Functions | |
| sw_rdr_result | SwRegisterHandler (sw_event_type type, sw_event_handler *handler, sw_event_priority priority) |
| Register an Event Handler. More... | |
| sw_rdr_result | SwRegisterHandlers (sw_event_handlers *handlers, int count) |
| Register multiple Event Handlers atomically. More... | |
| sw_rdr_result | SwDeregisterHandler (sw_event_type type, sw_event_handler *handler) |
| Deregister an Event Handler registered with SwRegisterHandler(). More... | |
| sw_rdr_result | SwDeregisterHandlers (sw_event_handlers *handlers, int count) |
| Deregister multiple Event Handlers. More... | |
| sw_rdr_result | SwSafeDeregisterHandler (sw_event_type type, sw_event_handler *handler) |
| Deregister an Event Handler detecting Handler threading. More... | |
| sw_event_result | SwEvent (sw_event_type type, void *message, size_t length) |
| Generate an event, calling relevant handlers in priority order. More... | |
| sw_event_result | SwEventTail (sw_event *event) |
| Call the remaining Handlers for the current Event, returning the value that would have been returned to the Issuer. More... | |
Header file defining the Events system, built on RIP Data Resource (RDR) System.
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.