1vpSetRawVoxels(3)          Library Functions Manual          vpSetRawVoxels(3)
2
3
4

NAME

6       vpSetRawVoxels - specify an array of volume data
7

SYNOPSIS

9       #include <volpack.h>
10
11       vpResult
12       vpSetRawVoxels(vpc, voxels, size, xstride, ystride, zstride)
13           vpContext *vpc;
14           void *voxels;
15           int size;
16           int xstride, ystride, zstride;
17

ARGUMENTS

19       vpc    VolPack context from vpCreateContext.
20
21       voxels 3D array of voxels.
22
23       size   Size of the voxel array in bytes.
24
25       xstride
26              Number of bytes from the beginning of one voxel to the beginning
27              of the next voxel in the first array dimension.
28
29       ystride
30              Number of bytes from the beginning of one voxel to the beginning
31              of the next voxel in the second array dimension.
32
33       zstride
34              Number of bytes from the beginning of one voxel to the beginning
35              of the next voxel in the third array dimension.
36

DESCRIPTION

38       vpSetRawVoxels is used to specify a 3D array that contains  the  volume
39       data.   The array must be large enough for the volume dimensions speci‐
40       fied with vpSetVolumeSize and the voxel size specified with vpSetVoxel‐
41       Size.  The data in the array may be initialized before or after calling
42       vpSetRawVoxels.
43
44       Some of the VolPack routines operate faster if the volume is stored  in
45       z-major order (xstride < ystride < zstride) but it is not strictly nec‐
46       essary.
47
48       The voxel array is not automatically deallocated when  the  context  is
49       destroyed  with  vpDestroyContext.   The application is responsible for
50       managing the memory associated with the volume array.
51
52       The voxel array can be a very large  data  structure,  possibly  larger
53       than available main memory.  It is sometimes possible to precompute the
54       optimized data structures required for  the  fast  rendering  algorithm
55       without explicitly allocating a voxel array.  See vpClassifyScalars(3).
56
57       During the call to vpSetRawVoxels, any existing precomputed volume data
58       structures in the context are destroyed.
59

STATE VARIABLES

61       The current voxel array parameters can be retrieved with the  following
62       state     variable     codes     (see     vpGeti(3)):    VP_VOXEL_DATA,
63       VP_VOXEL_DATA_SIZE,         VP_VOXEL_XSTRIDE,         VP_VOXEL_YSTRIDE,
64       VP_VOXEL_ZSTRIDE.
65

ERRORS

67       The routine always returns VP_OK.
68

SEE ALSO

70       VolPack(3), vpCreateContext(3)
71
72
73
74VolPack                                                      vpSetRawVoxels(3)
Impressum