Harlequin RIP SDK
SWMSG_RR_PAGE_REF Struct Reference

External HVD interface Page reference: passed during SWEVT_RR_PAGE_READY and SWEVT_RR_PAGE_COMPLETE events. More...

#include "rrevents.h"

Data Fields

void * connection
 
sw_tl_ref timeline
 
uint32 page_index
 

Detailed Description

External HVD interface Page reference: passed during SWEVT_RR_PAGE_READY and SWEVT_RR_PAGE_COMPLETE events.

Field Documentation

◆ connection

void* SWMSG_RR_PAGE_REF::connection

Opaque handle to the connection to which this event is relevant. All handlers whose connection handle doesn't match should immediately return SW_EVENT_CONTINUE.

◆ page_index

uint32 SWMSG_RR_PAGE_REF::page_index

Index into the pages or tiles defined by SWMSG_RR_PAGE_DEFINE messages. Multiple SWEVT_RR_PAGE_DEFINE events may be received, for different page ranges or tiles of a job. This index is cumulative over all of the page definitions. The page index used in a page ready or page complete message is the zero-based offset into the SWMSG_RR_PAGE_DEFINE::pages array plus the SWMSG_RR_PAGE_DEFINE::page_index_offset offset. This calculation provides a unique index across all of the SWEVT_RR_PAGE_DEFINE events for the connection.

◆ timeline

sw_tl_ref SWMSG_RR_PAGE_REF::timeline

Identifies the job containing the pages.


The documentation for this struct was generated from the following file: