Harlequin RIP SDK

Top-level structure describing raster layout for all separations, frames, planes, channels, and colorants in a page. More...

#include "swraster.h"

Data Fields

size_t size
 Size of this structure.
 
uint32 layout_id
 
RASTER_SHEET ** sheets
 
unsigned int n_sheets
 
unsigned int n_rendered_sheets
 
hq_atomic_counter_t refcount
 
unsigned int width
 
unsigned int height
 
unsigned int bandheight
 
unsigned int bands_per_frame
 

Detailed Description

Top-level structure describing raster layout for all separations, frames, planes, channels, and colorants in a page.

Field Documentation

◆ bandheight

unsigned int RASTER_LAYOUT::bandheight

The number of lines in a regular band, in pixels. The last band in each frame may contain fewer lines than this.

◆ bands_per_frame

unsigned int RASTER_LAYOUT::bands_per_frame

The number of bands in each frame of each sheet. This is ceiling(height/bandheight).

◆ height

unsigned int RASTER_LAYOUT::height

The height of the raster, in pixels (equivalently, the number of lines represented in the raster).

◆ layout_id

uint32 RASTER_LAYOUT::layout_id

The layout identifier changes whenever there are significant changes to a layout. It may be used as a first check to determine if layouts are different, but should not be used as a definitive equality check. Copies of a raster layout may share the same ID until modified. The ID zero is never used by the RIP.

◆ n_rendered_sheets

unsigned int RASTER_LAYOUT::n_rendered_sheets

The number of non-omitted sheets in the page. This is the number of separations that will be rendered.

◆ n_sheets

unsigned int RASTER_LAYOUT::n_sheets

The number of sheets in the layout. A sheet is a unit of output. There will always be at least one sheet in a raster layout.

◆ refcount

hq_atomic_counter_t RASTER_LAYOUT::refcount

Reference count for the raster layout. References to the raster layout may be acquired to prevent pointers to the sub-structures becoming invalid. All references acquired must be released. This field should not be manipulated directly by the user, only through the provided function calls.

◆ sheets

RASTER_SHEET** RASTER_LAYOUT::sheets

An array of RASTER_LAYOUT::n_sheets pointers to sheet structures.

◆ width

unsigned int RASTER_LAYOUT::width

The width of the raster, in pixels. This excludes any padding for alignment or strides.


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