Copyright (c) 1994 The Board of Trustees of The Leland Stanford
Junior University. All rights reserved.

Permission to use, copy, modify and distribute this software and its
documentation for any purpose is hereby granted without fee, provided
that the above copyright notice and this permission notice appear in
all copies of this software and that you do not sell the software.
Commercial licensing is available by contacting the author.

THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Author:
Phil Lacroute
Computer Systems Laboratory
Electrical Engineering Dept.
Stanford University

$Date: 1994/12/31 19:49:53 $
$Revision: 1.1 $

Macros
.FS <type> -- function start
<type> is return type of function
name and arguments follow on next line

0v

\\$1

8 .. .FA -- function arguments
one argument declaration follows on next line

.. .FE -- function end
end of function declaration

.. .DS -- display start

.. .DE -- display done

..

vpStoreRawVolume, vpStoreMinMaxOctree, vpStoreClassifiedVolume, vpStoreContext - store volume data structures to a file #include <volpack.h> .FS vpResult vpStoreRawVolume(vpc, fd) .FA vpContext *vpc; .FA int fd; .FE .FS vpResult vpStoreMinMaxOctree(vpc, fd) .FA vpContext *vpc; .FA int fd; .FE .FS vpResult vpStoreClassifiedVolume(vpc, fd) .FA vpContext *vpc; .FA int fd; .FE .FS vpResult vpStoreContext(vpc, fd) .FA vpContext *vpc; .FA int fd; .FE VolPack context from vpCreateContext. File descriptor from open(2), open for writing. These functions are used to store volume data structures from a rendering context into files in the format read by the VolPack file reading routines (see vpLoadRawVolume(3)).

vpStoreRawVolume creates a 3D voxel array file. The file includes information about the size of the volume and the layout of the voxels as well as the volume data itself.

vpStoreMinMaxOctree creates a min-max octree file. The file includes information about the size of the volume and the layout of the voxels as well as the octree itself.

vpStoreClassifiedVolume creates a preclassified volume data file. The file includes information about the size of the volume and the layout of the voxels as well as the volume data itself.

vpStoreContext creates a rendering context file. The file includes all rendering parameters except volume data and callback functions. The contents of any lookup tables for shading and classification are also stored.

The function used to write data to the files can be set by calling vpSetCallback with the VP_WRITE_FUNC option. This could be used to implement a file-compression system, for example.

The current file I/O parameters can be retrieved with the following state variable codes (see vpGeti(3)): VP_WRITE_FUNC. The normal return value is VP_OK. The following error return values are possible: The file writing function returned an error value (in which case the external variable errno should contain an operating-system specific error code), or the file system is full. The volume dimensions are invalid, or there is no voxel data in the context. There is no min-max octree in the volume (vpStoreMinMaxOctree only). The voxel fields in the rendering context have not been properly defined. VolPack(3), vpCreateContext(3), vpLoadRawVolume(3)