1VolPack(3) Library Functions Manual VolPack(3)
2
6 VolPack - introduction to VolPack, a library for volume rendering
7
9 #include <volpack.h>
10 cc file.c -lvolpack -lm
12
14 VolPack is a portable software library for volume rendering. It is
15 based on a new family of fast volume rendering algorithms (see Philippe
16 Lacroute and Marc Levoy, Fast Volume Rendering Using a Shear-Warp Fac‐
17 torization of the Viewing Transformation, Proc. SIGGRAPH '94, in Com‐
18 puter Graphics, Annual Conference Series, 1994, pp. 451-458). For a
19 tutorial introduction to the library see the VolPack User's Guide.
20 The following list includes all of the functions in the library grouped
22 by general function, along with the corresponding man pages.
23 Rendering Contexts
25 vpCreateContext vpCreateContext(3)
26 vpDestroyContext vpCreateContext(3)
27 Volumes
29 vpSetVolumeSize vpSetVolumeSize(3)
30 vpSetVoxelSize vpSetVoxelSize(3)
31 vpSetVoxelField vpSetVoxelField(3)
32 vpFieldOffset vpSetVoxelField(3)
33 vpSetRawVoxels vpSetRawVoxels(3)
34 vpVolumeNormals vpVolumeNormals(3)
35 vpScanlineNormals vpScanlineNormals(3)
36 vpNormalIndex vpNormalIndex(3)
37 vpNormal vpNormalIndex(3)
38 Classified Volumes
40 vpSetClassifierTable vpSetClassifierTable(3)
41 vpClassifyVolume vpClassifyVolume(3)
42 vpDestroyClassifiedVolume vpClassifyVolume(3)
43 vpClassifyScalars vpClassifyScalars(3)
44 vpClassifyScanline vpClassifyScanline(3)
45 Min-Max Octrees
47 vpCreateMinMaxOctree vpCreateMinMaxOctree(3)
48 vpMinMaxOctreeThreshold vpCreateMinMaxOctree(3)
49 vpDestroyMinMaxOctree vpCreateMinMaxOctree(3)
50 vpOctreeMask vpOctreeMask(3)
51 View Transformations
53 vpCurrentMatrix vpCurrentMatrix(3)
54 vpIdentityMatrix vpIdentityMatrix(3)
55 vpTranslate vpTranslate(3)
56 vpRotate vpRotate(3)
57 vpScale vpScale(3)
58 vpMultMatrix vpMultMatrix(3)
59 vpSetMatrix vpSetMatrix(3)
60 vpWindow vpWindow(3)
61 vpWindowPHIGS vpWindowPHIGS(3)
62 Shading and Lighting
64 vpSetLookupShader vpSetLookupShader(3)
65 vpSetShadowLookupShader vpSetShadowLookupShader(3)
66 vpSetLight vpSetLight(3)
67 vpSetMaterial vpSetMaterial(3)
68 vpShadeTable vpShadeTable(3)
69 vpSetDepthCueing vpSetDepthCueing(3)
70 Rendering
72 vpSetImage vpSetImage(3)
73 vpRenderClassifiedVolume vpRenderRawVolume(3)
74 vpRenderRawVolume vpRenderRawVolume(3)
75 State Variables
77 vpEnable vpEnable(3)
78 vpSeti vpSeti(3)
79 vpSetd vpSeti(3)
80 vpGeti vpGeti(3)
81 vpGetd vpGeti(3)
82 vpGetp vpGeti(3)
83 vpGetMatrix vpGetMatrix(3)
84 vpGetMaterial vpGetvpSetMaterial(3)
85 vpGetLight vpGetvpSetLight(3)
86 vpSetCallback vpSetCallback(3)
87 vpSetClientData vpSetClientData(3)
88 File I/O
90 vpLoadClassifiedVolume vpLoadRawVolume(3)
91 vpLoadMinMaxOctree vpLoadRawVolume(3)
92 vpLoadRawVolume vpLoadRawVolume(3)
93 vpLoadContext vpLoadRawVolume(3)
94 vpStoreClassifiedVolume vpStoreRawVolume(3)
95 vpStoreMinMaxOctree vpStoreRawVolume(3)
96 vpStoreRawVolume vpStoreRawVolume(3)
97 vpStoreContext vpStoreRawVolume(3)
98 Utility Functions
100 vpRamp vpRamp(3)
101 vpExtract vpExtract(3)
102 vpTranspose vpTranspose(3)
103 vpResample vpResample(3)
104 vpSetFilter vpSetFilter(3)
105 vpBoxFilter vpBoxFilter(3)
106 vpLinearFilter vpBoxFilter(3)
107 vpBicubicFilter vpBoxFilter(3)
108 vpGaussianFilter vpBoxFilter(3)
109 vpIdentity3 LinearAlgebra(3)
110 vpIdentity4 LinearAlgebra(3)
111 vpSetVector3 LinearAlgebra(3)
112 vpSetVector4 LinearAlgebra(3)
113 vpNormalize3 LinearAlgebra(3)
114 vpMatrixVectorMult4 LinearAlgebra(3)
115 vpMatrixMult4 LinearAlgebra(3)
116 vpCrossProduct LinearAlgebra(3)
117 vpSolveSystem4 LinearAlgebra(3)
118 Error Handling
120 vpGetError vpGetError(3)
121 vpGetErrorString vpGetError(3)
122 Debugging
124 vpSetDebug vpSetDebug(3)
125 vpTracePixel vpTracePixel(3)
126 vpGetImage vpGetvpSetImage(3)
127 vpBruteForceRender vpBruteForceRender(3)
128
130 The following data types are declared in the VolPack header file (vol‐
131 pack.h):
132 vpContext
134 An opaque handle for a rendering context. A context contains
135 all of the information required to render a volume, including
136 classification and shading parameters, the view transformation,
137 a description of the format of the volume data, and private data
138 structures used by the rendering routines.
139 vpResult
141 A result code. Most of the library routines return the code
142 VP_OK upon successful completion, or an error code if the
143 library call fails.
144 vpVector3
146 A three-element linear array of double-precision elements (dou‐
147 ble[3]).
148 vpVector4
150 A four-element linear array of double-precisions elements (dou‐
151 ble[4]).
152 vpMatrix3
154 A three-by-three array of double-precision elements (dou‐
155 ble[3][3]).
156 vpMatrix4
158 A four-by-four array of double-precision elements (dou‐
159 ble[4][4]).
160
162 Source code and documentation for VolPack are available free via the
163 World Wide Web (http://www-graphics.stanford.edu/software/volpack) or
164 by anonymous ftp (ftp://graphics.stanford.edu/pub/volpack).
165
167 VolPack User's Guide
168VolPack VolPack(3)