SoDebug(3)

💅 SoDebug — the manual page, but make it a vibe

okay bestie, so this is SoDebug(3) from the Library Functions Manual, and honestly? it's giving "tiny toolbox of debugging goodies" and I'm obsessed. let's get into it. 🎀

---

✨ NAME ✨

SoDebug — literally just that. that's the whole name. iconic of it.

---

🌸 SYNOPSIS 🌸

#include <SoDebug.h>

🫶 Static Public Member Functions 🫶

static const char * GetEnv (const char *var)
static void RTPrintf (const char *formatstr,...)
static void NamePtr (const char *name, void *ptr)
static const char * PtrName (void *ptr)
static void write (SoNode *node)
static void writeToFile (SoNode *node, const char *filename)
static void writeField (SoField *field)
static void printName (SoBase *base)

look at all those static lil cuties. every single one of them, no skips. 💖

---

💖 Detailed Description 💖

The SoDebug class is a small collection of debugging-related functions.

that's it. that's the description. small, humble, does exactly what it says on the tin. lowkey a whole mood. ✨

---

🦋 Member Function Documentation 🦋

const char * SoDebug::GetEnv (const char * var) [static]

This is a portable getenv-wrapper. so like, you wanna read an environment variable but you want it to work everywhere? yeah. this one. 🫶

See also: coin_getenv()

---

void SoDebug::RTPrintf (const char * formatstr, ...) [static]

Real-time printf designed for use when use of standard printf() would cause timing problems.

⚠️ NOT IMPLEMENTED. Currently it just forwards to printf(). so bestie, do not come for this function expecting real-time magic. it is not that. it is a forwarding service. 💀

---

void SoDebug::NamePtr (const char * name, void * ptr) [static]

Associate a name with an arbitrary pointer. You can fetch the name of the pointer later with PtrName(). like giving your pointer a little nickname so you can find it in the group chat later. 🏷️✨

See also: PtrName()

---

const char * SoDebug::PtrName (void * ptr) [static]

Returns the name set on a pointer with NamePtr(). If no name has been set, "<unnamed>" is returned.

so if your pointer has no name, it's not "mystery pointer", it's literally "<unnamed>". fr fr. 😭

See also: NamePtr()

---

void SoDebug::write (SoNode * node) [static]

Writes the node to stdout. boom. done. 🎀

---

void SoDebug::writeToFile (SoNode * node, const char * filename) [static]

Writes the node to the given filename, or /tmp/debug.iv if filename is NULL.

yep, /tmp/debug.iv is the fallback. if you pass NULL, that's where it goes. no cap. 🌈

---

void SoDebug::writeField (SoField * field) [static]

Not implemented.

literally not implemented. that's the whole documentation. it's giving "placeholder who showed up to the function party with nothing to bring". 💀 but we respect it. 💜

---

void SoDebug::printName (SoBase * base) [static]

Not implemented.

also not implemented. twinsies with writeField(). 👑💀

---

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. yes, a robot wrote this manpage. and a robot is, respectfully, eating. 🤖✨

---

and that's the whole page bestie!! no SEE ALSO section here (just the inline "See also" shoutouts to coin_getenv(), PtrName() and NamePtr() up above), so don't go looking for one. 💅

---

kisses, and this has been your girl covering Coin, Version 3.1.3, SoDebug(3) — slay, stay debugged, and always name your pointers 🎀💖🦋🌸✨