Harlequin RIP SDK
SWMSG_RR_PAGE_DEFINE Struct Reference

An External HVD interface Page Define message, sent with the SWEVT_RR_PAGE_DEFINE event. More...

#include "rrevents.h"

Data Fields

void * connection
 
sw_tl_ref timeline
 
uint32 page_offset
 
uint32 page_count
 
uint32 page_index_offset
 
RR_PAGE_DEFINE_PAGE ** pages
 

Detailed Description

An External HVD interface Page Define message, sent with the SWEVT_RR_PAGE_DEFINE event.

Note that the memory referred to in this structure should be treated as transient: if the code associated with a handler wishes to use any data contained in this event after the handler has returned, it should make a copy. When tiling output, each tile appears as a separate RR_PAGE_DEFINE_PAGE in the pages array.

Field Documentation

◆ connection

void* SWMSG_RR_PAGE_DEFINE::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_count

uint32 SWMSG_RR_PAGE_DEFINE::page_count

The number of pages or tiles being defined.

◆ page_index_offset

uint32 SWMSG_RR_PAGE_DEFINE::page_index_offset

Page index offset of first page/tile in this define.

◆ page_offset

uint32 SWMSG_RR_PAGE_DEFINE::page_offset

Page number offset of first page (counted as page 1) in this define.

◆ pages

RR_PAGE_DEFINE_PAGE** SWMSG_RR_PAGE_DEFINE::pages

Array of pointers to page structures, of length page_count. When tiling, each tile appears as a separate :RR_PAGE_DEFINE_PAGE structure, sharing its RR_PAGE_DEFINE_PAGE::relative_page_number with other tiles from the same page.

◆ timeline

sw_tl_ref SWMSG_RR_PAGE_DEFINE::timeline

Identifies the job containing the pages.


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