Harlequin RIP SDK

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

#include "swraster.h"

Data Fields

size_t size
 Size of this structure.
 
uint32 frame_id
 
RASTER_PLANE ** planes
 
unsigned int n_planes
 
unsigned int n_rendered_planes
 
size_t rendered_size_per_band
 
size_t overall_size_per_band
 
size_t rendered_frame_size
 
size_t overall_frame_size
 
int index_omitted
 
unsigned int index_non_omitted
 

Detailed Description

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

Field Documentation

◆ frame_id

uint32 RASTER_FRAME::frame_id

An identifier for this frame. 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.

◆ index_non_omitted

unsigned int RASTER_FRAME::index_non_omitted

The frame index, including omitted frames.

◆ index_omitted

int RASTER_FRAME::index_omitted

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

◆ n_planes

unsigned int RASTER_FRAME::n_planes

The number of planes in each band of the frame. A plane is a contiguous block of memory with one or more channels interleaved in it that are represented and manipulated in the same way. There will always be at least one plane in a frame.

◆ n_rendered_planes

unsigned int RASTER_FRAME::n_rendered_planes

The number of non-omitted planes in each band of the frame that can be iterated over.

◆ overall_frame_size

size_t RASTER_FRAME::overall_frame_size

The size of the data in all planes in all bands of the frame, including omitted planes. This is adjusted as necessary if the last band of the frame is not the full band height.

◆ overall_size_per_band

size_t RASTER_FRAME::overall_size_per_band

The size of the data in all planes in each band of the frame, including omitted planes.

◆ planes

RASTER_PLANE** RASTER_FRAME::planes

An array of RASTER_FRAME::n_planes pointers to plane structures.

◆ rendered_frame_size

size_t RASTER_FRAME::rendered_frame_size

The size of the data in all rendered planes in all bands of the frame. This is adjusted as necessary if the last band of the frame is not the full band height. If the frame is omitted, this will be zero.

◆ rendered_size_per_band

size_t RASTER_FRAME::rendered_size_per_band

The size of the data in all rendered planes in each band of the frame.


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