zfile - display driver for depth map output

DESCRIPTION

Zfile is a PhotoRealistic RenderMan display driver which produces an output file containing depth (z) information. The file format is peculiar to PhotoRealistic RenderMan. The zfile format is accepted by the renderer and the txmake utility program as the depth image required to make a shadow texture map.

The zfile driver creates a file whose name is specified in the RiDisplay call.

Like most other image file display drivers, the zfile driver must receive image data in raster scan order, one scanline at a time. The display server buffers image data as necessary to reorder it into raster scan order before sending it to the zfile driver.

DEFAULTS

resolution		1024 × 1024


pixel aspect ratio	no default


zfile name		ri.zfile

ERROR MESSAGES

The following messages can be produced by the zfile display driver. Each message will be preceded by the generic message number D00001.

DspyOpen_zfile: Only Z data, please

The driver can be used only to display Z data. It is an error to select the driver when display modes other than RI_Z are specified.

DspyOpen_zfile: Z must be 32-bit IEEE float.

The depth data received by the driver must be in 32-bit IEEE floating point format. This message probably results from an inappropriate RiQuantize command. It is best not to specify Z quantization (ie. let it default) i if you wish to use this driver.

DspyOpen_zfile: Can not open "name"

The output zfile name could not be created or opened for writing by the driver.

DspyOpen_zfile: File is already open

DspySetW_zfile: Not open

These messages should never occur, and indicate bugs in the display driver or display server.

DspySetW_zfile: Bad scanline window

This message should never occur. It may result from improper installation of the display driver (DSPY_SCANLINE flag missing), or a bug in the display server.

DRIVER INSTALLATION NOTES

If the zfile display driver is not already installed in your display server, it may be possible to add it as described in the PhotoRealistic RenderMan Display Driver Guide. The file /usr/local/prman/etc/dspyinst/dspy_zfile.o must exist in order to install this display driver. The installation guide tells you how to modify the display server Makefile in order to add a display driver. The relevant symbols to add for this driver are as follows:

Add -DDISPLAY_ZFILE to DRIVERDEFS.

Add dspy_zfile.o to DRIVEROBJS.

Add ${DLIB_ZFILE} to DRIVERLIBS. If DLIB_ZFILE is not already defined, add the line:

DLIB_ZFILE=