Harlequin RIP SDK

Structure describing raster layout for a single channel (data stream) in a plane. More...

#include "swraster.h"

Data Fields

size_t size
 Size of this structure.
 
uint32 channel_id
 
RASTER_COLORANT ** colorants
 
unsigned int n_colorants
 
unsigned int values
 
unsigned int depth_bits
 
unsigned int offset_bits
 
int index_omitted
 
unsigned int index_non_omitted
 
const uint8name
 
int sheet_render_ordinal
 

Detailed Description

Structure describing raster layout for a single channel (data stream) in a plane.

Field Documentation

◆ channel_id

uint32 RASTER_CHANNEL::channel_id

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

◆ colorants

RASTER_COLORANT** RASTER_CHANNEL::colorants

An array of RASTER_CHANNEL::n_colorants pointers to colorant structures.

◆ depth_bits

unsigned int RASTER_CHANNEL::depth_bits

The number of bits the channel data is represented in. This must be large enough to include RASTER_CHANNEL::values in the representation.

◆ index_non_omitted

unsigned int RASTER_CHANNEL::index_non_omitted

The channel index, including omitted channels.

◆ index_omitted

int RASTER_CHANNEL::index_omitted

The channel index, excluding omitted channels, or -1 if omitted. Unlike plane, frame, and sheet omission, channels, channel omission is not entirely derivative of colorant omission. If this index is -1, the colorant will also be omitted, and the channel takes no space in the raster data. However, this index may be non-negative (indicating the channel is present), but the sole colorant within the channel may be omitted: in this case, the data for the channel will not be valid, but its space will be reserved within the interleaved channel set. Omitted channels are provided for informational purposes. This index will always be less than or equal to index_non_omitted.

◆ n_colorants

unsigned int RASTER_CHANNEL::n_colorants

The number of channels in the plane. A colorant is information about the name and type of channel data. More than one colorant may be mapped onto each channel. There will always be at least one colorant in a channel, however the colorant may be marked as omitted, even if the channel is not omitted.

◆ name

const uint8* RASTER_CHANNEL::name

The name of the channel. Note that this is not the name of the colorant mapped onto the channel, but the name of the channel in the pagedevice's CompositeColorNames array.

◆ offset_bits

unsigned int RASTER_CHANNEL::offset_bits

The offset of this channel within each set of interleaved channels. Channels in a plane may not overlap, but there may be gaps between them. Channels will be presented in order of increasing offset.

◆ sheet_render_ordinal

int RASTER_CHANNEL::sheet_render_ordinal

The ordinal of this channel within the sheet (starting with zero for the first channel), or -1 if the channel is omitted in all render passes. This ordinal is stable across all render passes for a page, even if channels are rendered in partial passes but omitted in the final render pass.

◆ values

unsigned int RASTER_CHANNEL::values

The range of represented values in the channel data. This must be less than or equal to 1 << RASTER_CHANNEL::depth_bits.


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