|
Harlequin RIP SDK
|
|
|
|
Harlequin RIP SDK
|
|
The following structures will hold all of the device parameters. More...
The following structures will hold all of the device parameters.
The example does not process all the parameters set for the device; it chooses to ignore some. This is important functionality since new parameters will be introduced from time to time and the code should be written with upward compatibility in mind. It is unlikely that the implementation will require all of the parameters which are included here, so can be removed as appropriate. This example makes direct use of very few, but they are present mainly as an initial checklist.
The system allows for you to add your own additional pagebuffer parameters. This is also shown below (see also the file Sys/ExtraPageDeviceKeys).
See:
for documentation on pagebuffer parameters that has been exposed to OEMs. Some of those documented have been withdrawn, they are no longer usable because the information is not valid at the global scope.
| int32 PageBufferInParameters::BandHeight |
number of scanlines in each band - that is, the number of scanlines in the data delivered on each write call (except possibly the last, which may be shorter). Not used, but left because documented readable in Extensions Manual. Use raster layout instead.
| int32 PageBufferInParameters::BandLines |
Number of lines in this band
| int32 PageBufferInParameters::BottomMargin |
in pixels
| int32 PageBufferInParameters::Collate |
Flag specifying how the output is to be organized when multiple copies are requested.
| uint8 PageBufferInParameters::ColorantFamily[64] |
the colorant family to which the colorants of this raster belong
| uint8 PageBufferInParameters::ColorName[MAX_COLOR_NAME_LENGTH] |
Color Name as calculated by the core RIP.
| int32 PageBufferInParameters::Compositing |
Boolean indicating if this pass is compositing.
| int32 PageBufferInParameters::Duplex |
Flag determining whether the output is to be printed duplex or simplex.
| int32 PageBufferInParameters::Exposure |
output recorder exposure setting
| int32 PageBufferInParameters::fAllowBandCompression |
Governs whether band data is compressed at all.
| int32 PageBufferInParameters::fFavorSpeedOverCompression |
Governs how band data is compressed.
| int32 PageBufferInParameters::fTrimPage |
Indicates whether blank lines have been trimmed from top and bottom of page
| int32 PageBufferInParameters::ImageHeight |
number of scanlines in the complete image. Not used, but left because documented readable in Extensions Manual. Use raster layout instead.
| int32 PageBufferInParameters::ImageWidth |
width (in pixels) of one scanline of the active part of the image (not including any padding). Not used, but left because documented readable in Extensions Manual. Use raster layout instead.
| int32 PageBufferInParameters::InputAttributes |
The index of the media cassette selected from among those in the InputAttributes dictionary in the page device
| int32 PageBufferInParameters::InterleavingStyle |
monochrome (1), pixel-, band- or frame-interleaved
| int32 PageBufferInParameters::LeftMargin |
in pixels
| int32 PageBufferInParameters::MaxBandCacheKiB |
Maximum size of the band cache in KiB.
| int32 PageBufferInParameters::NegativePrint |
image requires negation by the output recorder or the pagebuffer implementation
| int32 PageBufferInParameters::NTiles |
Farm RIP number of tiles on this page. If 0, there are no tiles on this page.
| int32 PageBufferInParameters::NumBands |
the number of bands which will be delivered before memory will be reused by the rip; Note: NOT the total number of bands making up a page
| int32 PageBufferInParameters::NumCopies |
number of copies to print - will be 1 if RASTER_REQUIREMENTS::copies_handled_by_output is set to TRUE.
| int32 PageBufferInParameters::Orientation |
A code specifying the orientation of the page image.
| int32 PageBufferInParameters::OutputAttributes |
The index of the output destination selected from among those in the OutputAttributes dictionary in the page device
| int32 PageBufferInParameters::OutputFaceUp |
Flag specifying the order pages are stacked in the output tray.
| uint8 PageBufferInParameters::OutputTarget[MAX_OUTPUT_TARGET_LENGTH] |
Passed through to the back-end in the RasterDescription, allowing switching between different "devices" (or file output methodologies).
| uint8 PageBufferInParameters::PageBufferType[MAX_PGB_TYPE_LENGTH] |
Stored in the RasterDescription, this allows switching between different output backends.
| int32 PageBufferInParameters::PageNumber |
One-based page number of current page. the page number will only be changed when all the (automatically produced) separations making up a page have been delivered; the raster layout's sheets[] array describes these.
| int32 PageBufferInParameters::PageNumberOffset |
page number offset provided by user, passed through to the raster description. The RIP just passes this through, it doesn't ascribe semantics to this.
| int32 PageBufferInParameters::PageRelativeBBox[4] |
Relative offsets from the tile/imaging bbox to the page raster bbox.
| int32 PageBufferInParameters::PDFPageNumber |
For PDF input, the number of the page in the PDF corresponding to this page of output.
| int32 PageBufferInParameters::PrintPage |
0 is partial paint, 1 is really output
| uint8 PageBufferInParameters::ProcessColorModel[64] |
the PCM of the device
| int32 PageBufferInParameters::RasterDepth |
bits per channel, 1, 8, 10 (RLE only), or 16
| int32 PageBufferInParameters::RightMargin |
in pixels
| int32 PageBufferInParameters::RipID |
Farm RIP ID in a Scalable RIP or RIP Farm environment. Will be > 0 when valid.
| int32 PageBufferInParameters::RunLength |
TRUE if the RIP is generating RLE output format
| int32 PageBufferInParameters::RunLineComplete |
TRUE if next RLE write completes line.
| int32 PageBufferInParameters::RunLineOutput |
TRUE if RLE output includes the block headers.
| int32 PageBufferInParameters::SeparationStyle |
monochrome (0), black seps, colored seps, progressives, or composite
| int32 PageBufferInParameters::TopMargin |
in pixels
| int32 PageBufferInParameters::TrimEnd |
If fTrimPage is true, the index of the last line of raster received
| int32 PageBufferInParameters::TrimStart |
If fTrimPage is true, the index of the first line of raster received
| int32 PageBufferInParameters::Tumble |
Flag specifying the relative orientation of page images on opposite sides of a sheet of medium in duplex output.
| int32 PageBufferInParameters::ValuesPerComponent |
Number of values per component.
| float PageBufferInParameters::XResFrac |
plus fractional part
| int32 PageBufferInParameters::XResolution |
resolution (in dpi) in the x (width) direction
| int32 PageBufferInParameters::YResolution |
resolution (in dpi) in the y (height) direction