Physical print medium description. More...

Data Fields
struct caps_rect	medium_sz

struct caps_area	margins

int	rotation_favoured

enum caps_colour_format	cf

double	resolution_horizontal

double	resolution_vertical

Detailed Description

This information instructs the rasterizer how to prepare the raster to fit to the medium.

It's filled-in by the printing driver and used by the CAPS infrastructure.

The printing driver defines the medium's size, corresponding print margins and the required colour format of the raster data to be rasterized from the document.

Attention: Read the comment about the rotation_favoured setup.; Read the comment about the medium_sz member setup.

Field Documentation

◆ medium_sz

struct caps_rect medium_sz

Print medium size, in [pts]
The caps_rect::width component is always expected as the leading edge when printing.

Print medium leading edges: width <= length (left) and width > length (right)

◆ margins

struct caps_area margins

Margins as printer's restrictions, in [pts] related to medium_sz

Target media with restricted margin areas

The caps_area::top member always defines the margin at the leading edge when printing, e.g. the four values are meant in the same orientation as medium_sz

Note: This is a misuse of caps_area, since the information herein are four values, not two coordinates!

◆ rotation_favoured

int rotation_favoured

The favoured rotation for the content to fit to the medium_sz orientation on demand. The rotation_favoured member must always be set. It must be one of:

FAV_ROTATION_NONE
FAV_ROTATION_COUNTERCLOCKWISE

Left: view orientation, right: print orientation
and FAV_ROTATION_CLOCKWISE

Left: view orientation, right: print orientation

And it should always be set for the currently loaded medium, e.g. the medium the following process will print to. The setting should be made regarding possible printer specific local user settings (in contrast to the generic rotation related printing parameters).
If nothing is known, FAV_ROTATION_NONE can be used instead. In this case the regular defaults are used.

Note: Using a different value than FAV_ROTATION_NONE here has no impact to the values in medium_sz and margins (regarding their orientation)

◆ cf

enum caps_colour_format cf

Dot colour format the raster should have
Keep in mind (e.g. be prepared), the corresponding document format rasterizer may not be able to support this colour format

◆ resolution_horizontal

double resolution_horizontal

Horizontal rasterizing resolution [DPI]

◆ resolution_vertical

double resolution_vertical

Vertical rasterizing resolution [DPI]

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

libcapsraster/src/libcapsraster-api.h

Data Fields