file_print(3G)

NAME

file_print − print bitmapfile contents on a raster printer

SYNOPSIS

C Syntax:

void file_print(source,formatter,config,print_mode,
rotate,foreground,background,noback)
char *source,*formatter,*config;
int print_mode;
int rotate,foreground;
int background,noback;

FORTRAN77 Syntax:

subroutine file_print(source,formatter, config,
print_mode, rotate,foreground,background,noback)
character*(*) source,formatter,config
integer*4 print_mode
integer*4 rotate,foreground
integer*4 background,noback

Pascal Syntax:

procedure file_print(source,formatter,config:string255;
print_mode,rotate,foreground,background,
noback:integer);

DESCRIPTION

Input Parameters

source Pathname of a raster file containing data to be printed.

formatter Character representation of the formatter to be selected. See Starbase Device Drivers Library (formatter sections) for details.

config Pathname of a configuration file where information pertaining to the raster formatter and output device will be found. The contents of this file are formatter-dependent.

print_mode Integer value indicating how the data is to be read. If print_mode is non-negative, it specifies a single plane to be printed. If it exceeds the number of planes available, a failure flag is returned. If print_mode is negative or equals ALL_PLANES, all planes in the file are printed.

rotate If TRUE (1), indicates that the formatter should rotate the data 90 degrees for output. The direction of the rotation is formatter-dependent. If FALSE (0), the formatter-dependent default orientation is used.

foreground, background
Color map indices to be used when printing a single plane. The color corresponding to foreground is printed for 1s in the source, and the color corresponding to background is printed for 0s (however, see the noback parameter, below).

noback If TRUE (1), the color map index specified by background is mapped to no color; that is, it is not printed. This parameter has effect whether a single plane or all planes are being printed. If FALSE (0), the background color in the file data (or the specified background color if a single plane) is printed just as any other color.

Discussion

The entire extent of the rectangle recorded in the file is printed, subject to clipping by the formatter to fit the output medium. RGB information is converted by the formatter (through dithering) according to the capabilities of the output device. Actual data written is controlled by the formatter and the configuration file.

If a color map was stored as part of the file, it is used to print the data. If no color map was stored, a default is used based on the color map mode recorded in the file: a CMAP_NORMAL file uses the equivalent of the Starbase default software color map; a CMAP_MONOTONIC or CMAP_FULL file uses the default color map that shade_mode would initialize for the same number of planes if double-buffering was disabled at the time.

Conditions under which the operation fails include specification of an invalid formatter string (one not found in the formatter table linked with the program) and conditions under which the formatter itself returns a failure indication. Inquire_gerror(3G) can be used to determine the error.

Museum

Related Articles