vpSetRawVoxels(3)

💖 vpSetRawVoxels(3) — Library Functions Manual 💖

okay bestie, gather round, because this is the one where you hand VolPack your actual voxel data. yes, the data. the whole 3D volume. no big deal or anything 💅

---

✨ NAME ✨

vpSetRawVoxels — specify an array of volume data 🧚

---

🌸 SYNOPSIS 🌸

#include <volpack.h>

vpResult
vpSetRawVoxels(vpc, voxels, size, xstride, ystride, zstride)
    vpContext *vpc;
    void *voxels;
    int size;
    int xstride, ystride, zstride;

---

🎀 ARGUMENTS 🎀

• vpc — the VolPack context you got from vpCreateContext. your main character struct, fr.
• voxels — a 3D array of voxels. the actual goods. 🍓
• size — how big that voxel array is, in bytes. the vibe check on its size, if you will.
• xstride — number of bytes from the beginning of one voxel to the beginning of the next voxel in the first array dimension. (so: how far you gotta scoot to get to your neighbor along x)
• ystride — number of bytes from the beginning of one voxel to the beginning of the next voxel in the second array dimension.
• zstride — number of bytes from the beginning of one voxel to the beginning of the next voxel in the third array dimension. slay, three whole strides.

---

💜 DESCRIPTION 💜

vpSetRawVoxels is how you tell VolPack "hey, here's the 3D array holding my volume data." that's it, that's the job. 👑

the array must be large enough for the volume dimensions you set with vpSetVolumeSize and the voxel size you set with vpSetVoxelSize. no cap. if it's too small, that's on you, not on me. the data inside the array can be initialized either before or after you call vpSetRawVoxels — whenever, we're flexible like that ✨

lowkey a glow-up tip: some of the VolPack routines operate faster if the volume is stored in z-major order (xstride < ystride < zstride) — but it is not strictly necessary, so don't stress if that's not your arrangement. do it if you can, it's giving optimized.

🫶 important, bestie: the voxel array is not automatically deallocated when the context is destroyed with vpDestroyContext. the application is responsible for managing the memory associated with the volume array. that memory is yours. you freed it, you own it. periodt.

the voxel array can be a very large data structure, possibly larger than available main memory 😭 like, genuinely huge. and here's the iconic part: it is sometimes possible to precompute the optimized data structures required for the fast rendering algorithm without explicitly allocating a voxel array. see vpClassifyScalars(3) for that move. iykyk.

⚠️ also, heads up: during the call to vpSetRawVoxels, any existing precomputed volume data structures in the context are destroyed. gone. deleted. not me casually wiping your precomputed data 🙈. plan accordingly.

---

🌈 STATE VARIABLES 🌈

you can pull the current voxel array parameters back out with these state variable codes (peep vpGeti(3)):

• VP_VOXEL_DATA
• VP_VOXEL_DATA_SIZE
• VP_VOXEL_XSTRIDE
• VP_VOXEL_YSTRIDE
• VP_VOXEL_ZSTRIDE

---

⭐ ERRORS ⭐

the routine always returns VP_OK. always. it's never not okay. the most unproblematic function in the whole library, honestly. 💖

---

🦋 SEE ALSO 🦋

• VolPack(3)
• vpCreateContext(3)

---

and that's the whole page, bestie!! this lil manual page came to you straight from the VolPack library, and yes, it is literally titled vpSetRawVoxels(3) — go forth and set those raw voxels, you absolute icon 👑💅✨