SoDepthBuffer(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoDepthBuffer(3) 💖

okay so bestie, welcome to SoDepthBuffer(3) from the Library Functions Manual — yes it's a whole manual page, and yes it's a long one, so we're doing this in parts. This is part 1. Buckle up, hydrate, let's go 🫶

✨ NAME ✨

SoDepthBuffer — the class that is a node used to control the GL depth buffer. it's giving depth-buffer CEO, honestly 👑

✨ SYNOPSIS ✨

#include <SoDepthBuffer.h>

Inherits SoNode.

🌸 Public Types 🌸

enum DepthWriteFunction { NEVER = SoDepthBufferElement::NEVER, ALWAYS =
    SoDepthBufferElement::ALWAYS, LESS = SoDepthBufferElement::LESS,
    LEQUAL = SoDepthBufferElement::LEQUAL, EQUAL =
    SoDepthBufferElement::EQUAL, GEQUAL = SoDepthBufferElement::GEQUAL,
    GREATER = SoDepthBufferElement::GREATER, NOTEQUAL =
    SoDepthBufferElement::NOTEQUAL }

💫 Public Types inherited from SoNode 💫

enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002,
    INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010,
    INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080,
    COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 =
    0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 }

🌸 Public Member Functions 🌸

virtual SoType getTypeId (void) const
SoDepthBuffer (void)
virtual void GLRender (SoGLRenderAction *action)

💫 Public Member Functions inherited from SoNode 💫

void setOverride (const SbBool state)
SbBool isOverride (void) const
void setNodeType (const NodeType type)
NodeType getNodeType (void) const
virtual SoNode * copy (SbBool copyconnections=FALSE) const
virtual SbBool affectsState (void) const
virtual void doAction (SoAction *action)
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void pick (SoPickAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void audioRender (SoAudioRenderAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
virtual void notify (SoNotList *l)
uint32_t getNodeId (void) const
virtual SoChildList * getChildren (void) const
virtual void writeInstance (SoOutput *out)
virtual SoNode * addToCopyDict (void) const
virtual void copyContents (const SoFieldContainer *from, SbBool
    copyconnections)
virtual SoFieldContainer * copyThroughConnection (void) const

💫 Public Member Functions inherited from SoFieldContainer 💫

void setToDefaults (void)
SbBool hasDefaultValues (void) const
SbBool fieldsAreEqual (const SoFieldContainer *container) const
void copyFieldValues (const SoFieldContainer *container, SbBool
    copyconnections=FALSE)
SbBool set (const char *const fielddata)
void get (SbString &fielddata)
virtual int getFields (SoFieldList &l) const
virtual int getAllFields (SoFieldList &l) const
virtual SoField * getField (const SbName &name) const
virtual SoField * getEventIn (const SbName &name) const
virtual SoField * getEventOut (const SbName &name) const
SbBool getFieldName (const SoField *const field, SbName &name) const
SbBool enableNotify (const SbBool flag)
SbBool isNotifyEnabled (void) const
SbBool set (const char *fielddata, SoInput *input)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
SbBool getIsBuiltIn (void) const
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged)
    const
void setUserData (void *userdata) const
void * getUserData (void) const

💫 Public Member Functions inherited from SoBase 💫

void ref (void) const
void unref (void) const
void unrefNoDelete (void) const
int32_t getRefCount (void) const
void touch (void)
SbBool isOfType (SoType type) const
virtual SbName getName (void) const
virtual void setName (const SbName &newname)
void addAuditor (void *const auditor, const SoNotRec::Type type)
void removeAuditor (void *const auditor, const SoNotRec::Type type)
const SoAuditorList & getAuditors (void) const
SbBool shouldWrite (void)
void assertAlive (void) const

🌸 Static Public Member Functions 🌸

static SoType getClassTypeId (void)
static void initClass (void)

💫 Static Public Member Functions inherited from SoNode 💫

static uint32_t getCompatibilityTypes (const SoType &nodetype)
static SoType getClassTypeId (void)
static SoNode * getByName (const SbName &name)
static int getByName (const SbName &name, SoNodeList &l)
static void initClass (void)
static void initClasses (void)
static uint32_t getNextNodeId (void)
static int getActionMethodIndex (const SoType type)
static void getBoundingBoxS (SoAction *action, SoNode *node)
static void GLRenderS (SoAction *action, SoNode *node)
static void callbackS (SoAction *action, SoNode *node)
static void getMatrixS (SoAction *action, SoNode *node)
static void handleEventS (SoAction *action, SoNode *node)
static void pickS (SoAction *action, SoNode *node)
static void rayPickS (SoAction *action, SoNode *node)
static void searchS (SoAction *action, SoNode *node)
static void writeS (SoAction *action, SoNode *node)
static void audioRenderS (SoAction *action, SoNode *node)
static void getPrimitiveCountS (SoAction *action, SoNode *node)

💫 Static Public Member Functions inherited from SoFieldContainer 💫

static void initClass (void)
static SoType getClassTypeId (void)
static void cleanupClass (void)
static void initCopyDict (void)
static void addCopy (const SoFieldContainer *orig, const
    SoFieldContainer *copy)
static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
static SoFieldContainer * findCopy (const SoFieldContainer *orig, const
    SbBool copyconnections)
static void copyDone (void)

💫 Static Public Member Functions inherited from SoBase 💫

static void initClass (void)
static SoType getClassTypeId (void)
static void addName (SoBase *const base, const char *const name)
static void removeName (SoBase *const base, const char *const name)
static void incrementCurrentWriteCounter (void)
static void decrementCurrentWriteCounter (void)
static SoBase * getNamedBase (const SbName &name, SoType type)
static int getNamedBases (const SbName &name, SoBaseList &baselist,
    SoType type)
static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *input, const SbName &fromnodename,
    const SbName &fromfieldname, const SbName &tonodename, const SbName
    &tofieldname)
static SbBool readRoute (SoInput *input)

🌸 Public Attributes 🌸

these are the moment, the actual knobs you get to turn ✨

SoSFBool test
SoSFBool write
SoSFEnum function
SoSFVec2f range

🌸 Protected Member Functions 🌸

virtual const SoFieldData * getFieldData (void) const
virtual ~SoDepthBuffer ()

💫 Protected Member Functions inherited from SoNode 💫

SoNode (void)
virtual ~SoNode ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)

💫 Protected Member Functions inherited from SoFieldContainer 💫

SoFieldContainer (void)
virtual ~SoFieldContainer ()

💫 Protected Member Functions inherited from SoBase 💫

SoBase (void)
virtual ~SoBase ()
virtual void destroy (void)
SbBool hasMultipleWriteRefs (void) const
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine)
    const
void writeFooter (SoOutput *out) const
virtual const char * getFileFormatName (void) const

🌸 Static Protected Member Functions 🌸

static const SoFieldData ** getFieldDataPtr (void)

💫 Static Protected Member Functions inherited from SoNode 💫

static const SoFieldData ** getFieldDataPtr (void)
static void setNextActionMethodIndex (int index)
static int getNextActionMethodIndex (void)
static void incNextActionMethodIndex (void)
static void setCompatibilityTypes (const SoType &nodetype, const
    uint32_t bitmask)

💫 Static Protected Member Functions inherited from SoBase 💫

static uint32_t getCurrentWriteCounter (void)
static void staticDataLock (void)
static void staticDataUnlock (void)

🌸 Additional Inherited Members 🌸

💫 Protected Types inherited from SoBase 💫

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

💫 Protected Attributes inherited from SoNode 💫

uint32_t uniqueId

💫 Protected Attributes inherited from SoFieldContainer 💫

SbBool isBuiltIn

💫 Static Protected Attributes inherited from SoNode 💫

static uint32_t nextUniqueId = 1
static int nextActionMethodIndex = 0

✨ Detailed Description ✨

The SoDepthBuffer class is a node used to control the GL depth buffer. no cap, that's the whole job 💅

With this node you can control properties related to the OpenGL depth buffer in a variety of ways. the range of ways? iconic, honestly:

you can enable and disable depth buffer testing during rendering,
you can enable and disable writing to the depth buffer during rendering,
you can set the function used for the depth buffer testing, and
you can set the value range used in the depth buffer.

The value range setting is useful if you need to segment the 3D world into different segments with different depth buffer resolutions to get a more optimal depth buffer resolution distribution than what a single, uniform depth buffer value range can give you. literally slicing your world into zones so the depth precision actually goes where you need it 🎀

⚠️ okay important bestie — be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. so if you're porting old-school Inventor code, do not expect this one to show up. it's a Coin original 🦋

Since Coin 3.0

✨ Member Enumeration Documentation ✨

🌸 enum SoDepthBuffer::DepthWriteFunction 🌸

Enumeration for the various depth functions. eight whole moods, and each one decides whether a fragment gets to pass the vibe check 🧚

NEVER — Never passes. ever. zero chance, not today 💀
ALWAYS — Always passes. everyone gets in, it's a party 🔥
LESS — Passes if the incoming depth value is less than the stored depth value.
LEQUAL — Passes if the incoming depth value is less than or equal to the stored depth value.
EQUAL — Passes if the incoming depth value is equal to the stored depth value.
GEQUAL — Passes if the incoming depth value is greater than or equal to the stored depth value.
GREATER — Passes if the incoming depth value is greater than the stored depth value.
NOTEQUAL — Passes if the incoming depth value is not equal to the stored depth value.

✨ Constructor & Destructor Documentation ✨

🌸 SoDepthBuffer::SoDepthBuffer (void ) 🌸

Constructor. 🫶

🌸 SoDepthBuffer::~SoDepthBuffer () [protected], [virtual] 🌸

Destructor. say bye bye 💜

and that's a wrap on part 1, bestie — more parts follow, so don't go anywhere 🌈

💅 Member Function Documentation 💅

🦋 `SoType SoDepthBuffer::getTypeId (void ) const [virtual]`

okay bestie, this one hands you back the type identification of any object that derives from SoBase. what's it for? run-time type checking and "downward" casting. it's literally how you find out what you're actually holding before you go poking at it. 🔍

Usage example, direct from the source, no edits:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

so like — if you're an application programmer and you wanna extend the library with new nodes, engines, nodekits, draggers or others? you have to override this method in all subclasses. no skipping, no "eh it'll probably be fine." this is typically done as part of setting up the full type system for your extension classes, and that's usually accomplished by using the pre-defined macros available through, for instance, Inventor/nodes/SoSubNode.h (that's where SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR live, for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. the macro girlies are doing the heavy lifting fr fr. ✨

for more info on writing Coin extensions, go read the class documentation of the toplevel superclasses for the various class groups. iykyk. 📚

implements SoBase. 👑

🎀 `const SoFieldData * SoDepthBuffer::getFieldData (void ) const [protected], [virtual]`

returns a pointer to the class-wide field data storage object for this instance. and if there are no fields present? it returns NULL. that's the whole vibe. 🌸

reimplemented from SoFieldContainer.

🌈 `void SoDepthBuffer::GLRender (SoGLRenderAction * action) [virtual]`

this is an action method for the SoGLRenderAction — you know, the one that actually makes pixels appear. ✨

it gets called during rendering traversals. any node that influences the rendering state in any way, or that wants to throw geometry primitives at OpenGL, overrides this method. that's you, that's the assignment, go off. 💅

reimplemented from SoNode.

👑 Member Data Documentation 👑

🍓 `SoSFBool SoDepthBuffer::test`

Enable depth buffer testing. Defaults to TRUE. 💖

🧚 `SoSFBool SoDepthBuffer::write`

Enable depth buffer writing. Defaults to TRUE. 💖

🦋 `SoSFEnum SoDepthBuffer::function`

Which depth function to use. Defaults to LESS. 📐

⭐ `SoSFVec2f SoDepthBuffer::range`

The value range for the depth buffer data. Defaults to [0.0-1.0].

heads up bestie: the range will be clamped to [0.0-1.0]. so if you try to get cute with values outside that, the clamp is gonna clamp. no cap. 🫶

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. (yes, the robots wrote it, and honestly? they ate. 🤖✨)

and that's a wrap on the whole page, my love 💜 this was SoDepthBuffer(3) from Coin, Version 3.1.3 — go forth, test those depth buffers, and remember to clamp your ranges. mwah. 🎀💖🦋

📦 where this page comes from

fedora 43: Coin3-devel 3.1.3-40.fc43 · GPL-2.0-only
fedora 43: Coin3-devel 3.1.3-40.fc43 · GPL-2.0-only
fedora 44: Coin3-devel 3.1.3-42.fc44 · GPL-2.0-only
fedora 44: Coin3-devel 3.1.3-42.fc44 · GPL-2.0-only
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms