Harlequin RIP SDK

This file defines the Event interface for HVD (aka Retained Raster). More...

#include "swevents.h"

Data Structures

struct  SWMSG_RR_CONNECT
 Message for SWEVT_RR_CONNECT: establishes a connection to an HVD cache instance. More...
 
struct  SWMSG_RR_DISCONNECT
 Message for SWEVT_RR_DISCONNECT: disconnects from a HVD cache instance. More...
 
struct  RR_PAGE_DEFINE_ELEMENT
 An element on a page in the External HVD interface Page Define message. More...
 
struct  RR_PAGE_DEFINE_PAGE
 A page or tile in the External HVD interface Page Define message. More...
 
struct  SWMSG_RR_PAGE_DEFINE
 An External HVD interface Page Define message, sent with the SWEVT_RR_PAGE_DEFINE event. More...
 
struct  SWMSG_RR_PAGE_REF
 External HVD interface Page reference: passed during SWEVT_RR_PAGE_READY and SWEVT_RR_PAGE_COMPLETE events. More...
 
struct  SWMSG_RR_ELEMENT_DEFINE
 HVD interface Page Element Define message. More...
 
struct  SWMSG_RR_ELEMENT_REF
 This is a message which identifies a particular raster element, and is used by two events: More...
 
struct  SWMSG_RR_ELEMENT_QUERY_LOCK
 HVD element query message, sent with the SWEVT_RR_ELEMENT_QUERY_LOCK event. More...
 
struct  SWMSG_RR_ELEMENT_UPDATE_RASTER
 Internal HVD element update message, sent with the SWEVT_RR_ELEMENT_UPDATE_RASTER event. More...
 
struct  SWMSG_RR_ELEMENT_UPDATE_HITS
 HVD element hit count message, sent with the SWEVT_RR_ELEMENT_UPDATE_HITS event. More...
 

Macros

#define RR_CACHE_ID_LENGTH   256
 Length of the string (including terminating zero byte) for External HVD cache IDs.
 
#define RR_SETUP_ID_LENGTH   256
 Length of the string (including terminating zero byte) for External HVD setup IDs.
 
#define RR_ELEMENT_ID_LENGTH   16
 Length of the id strings in External HVD elements.
 

Typedefs

typedef struct SWMSG_RR_CONNECT SWMSG_RR_CONNECT
 Message for SWEVT_RR_CONNECT: establishes a connection to an HVD cache instance.
 
typedef struct SWMSG_RR_DISCONNECT SWMSG_RR_DISCONNECT
 Message for SWEVT_RR_DISCONNECT: disconnects from a HVD cache instance.
 
typedef struct RR_PAGE_DEFINE_ELEMENT RR_PAGE_DEFINE_ELEMENT
 An element on a page in the External HVD interface Page Define message.
 
typedef struct RR_PAGE_DEFINE_PAGE RR_PAGE_DEFINE_PAGE
 A page or tile in the External HVD interface Page Define message. More...
 
typedef struct SWMSG_RR_PAGE_DEFINE SWMSG_RR_PAGE_DEFINE
 An External HVD interface Page Define message, sent with the SWEVT_RR_PAGE_DEFINE event. More...
 
typedef struct SWMSG_RR_PAGE_REF SWMSG_RR_PAGE_REF
 External HVD interface Page reference: passed during SWEVT_RR_PAGE_READY and SWEVT_RR_PAGE_COMPLETE events.
 
typedef struct SWMSG_RR_ELEMENT_DEFINE SWMSG_RR_ELEMENT_DEFINE
 HVD interface Page Element Define message. More...
 
typedef struct SWMSG_RR_ELEMENT_REF SWMSG_RR_ELEMENT_REF
 This is a message which identifies a particular raster element, and is used by two events: More...
 
typedef struct SWMSG_RR_ELEMENT_QUERY_LOCK SWMSG_RR_ELEMENT_QUERY_LOCK
 HVD element query message, sent with the SWEVT_RR_ELEMENT_QUERY_LOCK event. More...
 
typedef struct SWMSG_RR_ELEMENT_UPDATE_RASTER SWMSG_RR_ELEMENT_UPDATE_RASTER
 Internal HVD element update message, sent with the SWEVT_RR_ELEMENT_UPDATE_RASTER event. More...
 
typedef struct SWMSG_RR_ELEMENT_UPDATE_HITS SWMSG_RR_ELEMENT_UPDATE_HITS
 HVD element hit count message, sent with the SWEVT_RR_ELEMENT_UPDATE_HITS event. More...
 

Detailed Description

This file defines the Event interface for HVD (aka Retained Raster).

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.