Harlequin RIP SDK
RR_PAGE_DEFINE_PAGE Struct Reference

A page or tile in the External HVD interface Page Define message. More...

#include "rrevents.h"

Data Fields

uint32 w
 
uint32 h
 
int32 x1
 
uint32 relative_page_number
 
uint32 element_count
 
RR_PAGE_DEFINE_ELEMENT ** elements
 
const uint8background_id
 
uint32 pdf_page_number
 

Detailed Description

A page or tile in the External HVD interface Page Define message.

The bounding box of the raster data can be used to determine if a whole page or a tile is represented. The relative page number can be used to determine if more than one tile of the same page is present. If tiling, the RIP guarantees that all tiles of a page that are being output will appear in the same SWEVT_RR_PAGE_DEFINE event, with adjacent entries in the SWMSG_RR_PAGE_DEFINE::pages array.

Field Documentation

◆ background_id

const uint8* RR_PAGE_DEFINE_PAGE::background_id

Unique ID of length RR_ELEMENT_ID_LENGTH, or NULL. This is used to identify an element used to initialize the background of the page or tile, when the erase color is not white. The page or tile background should be initialized to the color value of the pixel or pixels of the corresponding raster element. If the raster contains more than 1 pixel, all the pixels will have the same color value. A NULL entry indicates that the page or tile background should be initialized to white.

◆ element_count

uint32 RR_PAGE_DEFINE_PAGE::element_count

Number of raster elements on this page or tile.

◆ elements

RR_PAGE_DEFINE_ELEMENT** RR_PAGE_DEFINE_PAGE::elements

Array of pointers to raster elements, of length element_count.

◆ h

uint32 RR_PAGE_DEFINE_PAGE::h

Height of the entire (untiled) page in pixels.

◆ pdf_page_number

uint32 RR_PAGE_DEFINE_PAGE::pdf_page_number

PDF page number of this page. This is a 1-based page number of the page or tile, selected from the original PDF using PageRange and PageOrder. Pages that were generated from blank page insertion (and were not in the original PDF file) will have page number 0. When tiling, multiple adjacent tile entries in the SWMSG_RR_PAGE_DEFINE::pages array will share the same PDF page number.

◆ relative_page_number

uint32 RR_PAGE_DEFINE_PAGE::relative_page_number

Relative page number of this page or tile. This is a zero-based index of the page relative to the SWMSG_RR_PAGE_DEFINE::page_offset. It should be used to compute the output page number for this page or tile. When tiling, multiple adjacent tile entries in the SWMSG_RR_PAGE_DEFINE::pages array will share the same relative_page_number.

◆ w

uint32 RR_PAGE_DEFINE_PAGE::w

Width of the entire (untiled) page in pixels.

◆ x1

int32 RR_PAGE_DEFINE_PAGE::x1

Bounding box of this page or tile's raster. This is a normalized half-open bounding box (i.e., x1 < x2 and y1 < y2, pixels at x2 and y2 are not included in the raster). If not tiling, then x1 and y1 will be zero, x2 and y2 will be the page width and height, and the bounding box will represent the entire page dimensions.


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