|
Harlequin RIP SDK
|
|
|
|
Harlequin RIP SDK
|
|
Header file defining the RIP Data Resource (RDR) System. More...
Data Structures | |
| struct | sw_rdr_api_20110201 |
| The RDR API structure for version 20110201. More... | |
| struct | sw_rdr_api_20191120 |
| The RDR API structure for version 20191120. More... | |
Macros | |
| #define | SwFindRDRs(void) rdr_api->find_all |
| Find all RDRs. More... | |
Typedefs | |
| typedef HqnIdent | sw_rdr_class |
| A type used to store and communicate RDR classes. More... | |
| typedef HqnIdent | sw_rdr_type |
| RDR Types. More... | |
| typedef HqnIdent | sw_rdr_namespace |
| A type used to store and communicate RDR Namespaces. More... | |
| typedef HqnIdent | sw_rdr_id |
| RDR IDs. More... | |
| typedef int32 | sw_rdr_priority |
| RDR priorities. More... | |
| typedef HqnResult | sw_rdr_result |
| A type used to communicate return values from RDR API calls. More... | |
| typedef struct sw_rdr_iterator | sw_rdr_iterator |
| Iterator for finding multiple RDRs. More... | |
Enumerations | |
| enum | RDR_CLASSES { RDR_CLASS_EVENT = -1 , RDR_CLASS_RDR = 1 , RDR_CLASS_FONT , RDR_CLASS_RESERVE1 , RDR_CLASS_API , RDR_CLASS_TIMELINE , RDR_CLASS_LOW_MEM , RDR_CLASS_SOAR , RDR_CLASS_DEVICETYPE } |
| RDR Classes. More... | |
| enum | RDR_NAMES { RDR_NAMES_RDR = 1 , RDR_NAMES_TILEAPI , RDR_NAMES_CMMAPI , RDR_NAMES_HTMAPI , RDR_NAMES_NAMEDCOLOR_DEVICE , RDR_NAMES_RASTERAPI } |
| RDR Namespaces. More... | |
| enum | { SW_RDR_DEFAULT = -10000 , SW_RDR_NORMAL = 0 , SW_RDR_OVERRIDE = 10000 } |
| Enumeration of RDR priorities. More... | |
| enum | RDR_RESULT { SW_RDR_SUCCESS = HQN_RESULT_SUCCESS , SW_RDR_ERROR , SW_RDR_ERROR_UNKNOWN , SW_RDR_ERROR_SYNTAX , SW_RDR_ERROR_IN_USE , SW_RDR_ERROR_MEMORY } |
| Return values from RDR API calls. More... | |
Functions | |
| int | rdr_start (void) |
| Initialise the RDR system. More... | |
| void | rdr_end (void) |
| Finalise the RDR system. More... | |
| HqBool | get_skin_api_ptr (sw_rdr_type apitype, sw_rdr_id id, void *papi) |
| Get an API pointer to a specified version of an RDR_CLASS_API resource. More... | |
| sw_rdr_result | SwRegisterRDR (sw_rdr_class rdrclass, sw_rdr_type rdrtype, sw_rdr_id rdrid, void *ptr, size_t length, sw_rdr_priority priority) |
| Register an RDR. More... | |
| sw_rdr_result | SwRegisterRDRandID (sw_rdr_class rdrclass, sw_rdr_type rdrtype, sw_rdr_id *prdrid, void *ptr, size_t length, sw_rdr_priority priority) |
| Register an RDR and allocate it a unique ID. More... | |
| sw_rdr_result | SwDeregisterRDR (sw_rdr_class rdrclass, sw_rdr_type rdrtype, sw_rdr_id rdrid, void *ptr, size_t length) |
| Deregister an RDR. More... | |
| sw_rdr_result | SwFindRDR (sw_rdr_class rdrclass, sw_rdr_type rdrtype, sw_rdr_id rdrid, void **pptr, size_t *plength) |
| Find an RDR given the Class, Type and ID. More... | |
| sw_rdr_iterator * | SwFindRDRbyType (sw_rdr_class rdrclass, sw_rdr_type rdrtype) |
| Find all RDRs of a specified Class and Type. More... | |
| sw_rdr_iterator * | SwFindRDRbyClass (sw_rdr_class rdrclass) |
| Find all RDRs of a specified Class. More... | |
| sw_rdr_result | SwNextRDR (sw_rdr_iterator *iterator, sw_rdr_class *pclass, sw_rdr_type *ptype, sw_rdr_id *pid, void **pptr, size_t *plength) |
| Find an RDR by iteration. More... | |
| sw_rdr_result | SwLockNextRDR (sw_rdr_iterator *iterator, sw_rdr_class *pclass, sw_rdr_type *ptype, sw_rdr_id *pid, void **pptr, size_t *plength) |
| Find an RDR by iteration and lock it to prevent deregistration. More... | |
| sw_rdr_result | SwRestartFindRDR (sw_rdr_iterator *iterator) |
| Restart an RDR iterator. More... | |
| sw_rdr_result | SwFoundRDR (sw_rdr_iterator *iterator) |
| Destroy an RDR iterator. More... | |
| sw_rdr_result | SwRegisterNamedRDR (sw_rdr_namespace rdrspace, const char *name, size_t namelen, sw_rdr_id rdrid, void *ptr, size_t length, sw_rdr_priority priority) |
| Register a Named RDR. More... | |
| sw_rdr_result | SwRegisterNamedRDRandID (sw_rdr_namespace rdrspace, const char *name, size_t namelen, sw_rdr_id *prdrid, void *ptr, size_t length, sw_rdr_priority priority) |
| Register a Named RDR and allocate it a unique ID. More... | |
| sw_rdr_result | SwDeregisterNamedRDR (sw_rdr_namespace rdrspace, const char *name, size_t namelen, sw_rdr_id rdrid, void *ptr, size_t length) |
| Deregister a Named RDR. More... | |
| sw_rdr_result | SwFindNamedRDR (sw_rdr_namespace rdrspace, const char *name, size_t namelen, sw_rdr_id rdrid, void **pptr, size_t *plength) |
| Find a named RDR given the Namespace, Name, and ID. More... | |
| sw_rdr_iterator * | SwFindNamedRDRbyName (sw_rdr_namespace rdrspace, const char *name, size_t namelen) |
| Find all Named RDRs of a specified Namespace and Name. More... | |
Header file defining the 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.