vpSetDebug(3)

💖 vpSetDebug — the manual page, but make it cute 💖

okay bestie, welcome to vpSetDebug(3) from the Library Functions Manual — yes this is a real manpage, and yes we're gonna make it slay ✨

---

🌸 NAME 🌸

vpSetDebug — turn your debugging options on and off, literally that's it 🎀

---

🦋 SYNOPSIS 🦋

#include <volpack.h>

vpResult
vpSetDebug(vpc, flag, value)
    vpContext *vpc;
    int flag;
    int value;

---

✨ ARGUMENTS ✨

• vpc — the VolPack context you got from vpCreateContext. your main character 🫶
• flag — a constant that says which debugging option we're adjusting. pick your fighter 💅
• value — the new value for that option. it's a boolean, so it's giving 0 or 1, no in-between 🌈

---

👑 DESCRIPTION 👑

so vpSetDebug is the girl who enables or disables a debugging option inside a rendering context. what do debugging options do? they make messages print out while the code is running. and ngl, those messages are probably useless unless you have a genuinely good understanding of the source code — like, they're not for the casuals, iykyk 😭

the logic is simple: if value is 0, the option is disabled. if it's anything else, it's enabled. periodt.

here's the full roster of options, all of them, no skips, we don't gatekeep:

• VPDEBUG_VIEW — view transform calculations 🔥
• VPDEBUG_RENDER — high-level rendering stages ✨
• VPDEBUG_RBUF — intermediate image (render buffer) allocation 🎀
• VPDEBUG_OPCCORRECT — opacity correction 💅
• VPDEBUG_DEPTHCUE — depth cueing 🌊
• VPDEBUG_PYRAMID — pyramid construction 🔺
• VPDEBUG_OCTREE — octree construction 🌳
• VPDEBUG_CLSFYOCTREE — octree classification 🏷️
• VPDEBUG_OCTREERUNS — runs computed from octree 🏃
• VPDEBUG_OCTREETRAVERSE — octree traversal 🚶
• VPDEBUG_TRANSPOSE — volume transposing 🔄
• VPDEBUG_COMPOSITE — compositing 🧚

⚠️ okay this is the important part, do not scroll past: the VolPack library must be compiled with the -DDEBUG compiler option for this function to have any effect at all. without it you're just out here calling a function that does nothing, which is lowkey tragic 💀

---

💀 ERRORS 💀

the normal return value is VP_OK — that's the good ending, we love her 💖

and here's the one error return value that's possible:

• VPERROR_BAD_OPTION — the flag argument is invalid. you passed something fake, bestie, and she noticed 🙈

---

🌈 SEE ALSO 🌈

VolPack(3), vpCreateContext(3)

---

and that's the whole page, you ate it, no crumbs left 💅

this has been the VolPack vpSetDebug(3) page, brought to you by VolPack itself — go read the source code, bestie, that's where the real lore lives ✨🫶