Harlequin RIP SDK

Structure describing raster layout for a single separation in a page. More...

#include "swraster.h"

Data Fields

size_t size
 Size of this structure.
 
uint32 sheet_id
 
RASTER_FRAME ** frames
 
unsigned int n_frames
 
unsigned int n_rendered_frames
 
unsigned int lines_in_all_frames
 
unsigned int n_rendered_bands
 
size_t rendered_sheet_size
 
size_t overall_sheet_size
 
int index_omitted
 
unsigned int index_non_omitted
 

Detailed Description

Structure describing raster layout for a single separation in a page.

Field Documentation

◆ frames

RASTER_FRAME** RASTER_SHEET::frames

An array of RASTER_SHEET::n_frames pointers to frame structures.

◆ index_non_omitted

unsigned int RASTER_SHEET::index_non_omitted

The sheet index, including omitted sheets.

◆ index_omitted

int RASTER_SHEET::index_omitted

The sheet index, excluding omitted sheets, or -1 if omitted. Sheet omission is entirely derivative of frame omission: if this index is -1, then all frames of the sheet are omitted, and conversely if this index is non-negative, then at least one frame in the sheet is not omitted. This index will always be less than or equal to index_non_omitted.

◆ lines_in_all_frames

unsigned int RASTER_SHEET::lines_in_all_frames

The total number of lines in all rendered frames of the sheet.

◆ n_frames

unsigned int RASTER_SHEET::n_frames

The number of frames in the sheet. Each frame consists of RASTER_LAYOUT::bands_per_frame bands, with all of the bands having the same structure. There will always be at least one frame in a sheet.

◆ n_rendered_bands

unsigned int RASTER_SHEET::n_rendered_bands

The number of non-omitted bands in the sheet that can be iterated over. This is the number of non-omitted frames in the sheet, multiplied by the number of bands in the frame. The iterable planes are used to identify a particular band for output.

◆ n_rendered_frames

unsigned int RASTER_SHEET::n_rendered_frames

The number of non-omitted frames in the sheet.

◆ overall_sheet_size

size_t RASTER_SHEET::overall_sheet_size

The size of the data in all frames in the whole sheet, including omitted frames and planes.

◆ rendered_sheet_size

size_t RASTER_SHEET::rendered_sheet_size

The size of the data in all rendered frames in the whole sheet. If the sheet is omitted, this will be zero.

◆ sheet_id

uint32 RASTER_SHEET::sheet_id

An identifier for this sheet. This identifier is stable across all render passes for a page, but cannot be used to compare layouts from different pages. Channel, plane, frame, and sheet IDs share the same namespace, so the IDs created by the RIP for an item of one type will not conflict with IDs for an item of a different type. The ID zero is never used by the RIP.


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