SoGLDepthBufferElement(3)

πŸ“¦ version 3.1.3, in fedora 43, fedora 44

πŸ’… SoGLDepthBufferElement β€” the Coin manual page, bestie edition πŸ’…

okay so this is SoGLDepthBufferElement(3), a Library Functions Manual page for Coin (yes, the 3D toolkit, the one your renderer is obsessed with). Sit down, grab a strawberry πŸ“, and let's get into it.


✨ NAME ✨

SoGLDepthBufferElement β€” the element that controls the OpenGL depth buffer. that's it, that's the whole job, and she does it flawlessly πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

#include <Inventor/elements/SoGLDepthBufferElement.h>

Inherits SoDepthBufferElement. so she's got a whole family tree, we'll get to that 🧚

Public Member Functions

  • virtual void init (SoState *state)
  • virtual void push (SoState *state)
  • virtual void pop (SoState *state, const SoElement *prevTopElement)

Public Member Functions inherited from SoDepthBufferElement

  • virtual SbBool matches (const SoElement *element) const
  • virtual SoElement * copyMatchInfo (void) const

Public Member Functions inherited from SoElement

  • const SoType getTypeId (void) const
  • int getStackIndex (void) const
  • void setDepth (const int depth)
  • int getDepth (void) const
  • virtual void print (FILE *file=stdout) const
  • virtual ~SoElement ()

Static Public Member Functions

  • static SoType getClassTypeId (void)
  • static int getClassStackIndex (void)
  • static void * createInstance (void)
  • static void initClass (void)

Static Public Member Functions inherited from SoDepthBufferElement

  • static SoType getClassTypeId (void)
  • static int getClassStackIndex (void)
  • static void * createInstance (void)
  • static void initClass (void)
  • static void set (SoState *state, SbBool test, SbBool write, DepthWriteFunction function, SbVec2f range)
  • static void get (SoState *state, SbBool &test_out, SbBool &write_out, DepthWriteFunction &function_out, SbVec2f &range_out)
  • static SbBool getTestEnable (SoState *state)
  • static SbBool getWriteEnable (SoState *state)
  • static DepthWriteFunction getFunction (SoState *state)
  • static SbVec2f getRange (SoState *state)

Static Public Member Functions inherited from SoElement

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static int getClassStackIndex (void)
  • static void initElements (void)
  • static int getNumStackIndices (void)
  • static SoType getIdFromStackIndex (const int stackIndex)

Protected Member Functions

  • virtual ~SoGLDepthBufferElement ()
  • virtual void setElt (SbBool test, SbBool write, DepthWriteFunction function, SbVec2f range)

Protected Member Functions inherited from SoDepthBufferElement

  • virtual ~SoDepthBufferElement ()

Protected Member Functions inherited from SoElement

  • SoElement (void)
  • void capture (SoState *const state) const
  • virtual void captureThis (SoState *state) const
  • void setTypeId (const SoType typeId)
  • void setStackIndex (const int index)
  • SoElement * getNextInStack (void) const
  • SoElement * getNextFree (void) const

Additional Inherited Members

Public Types inherited from SoDepthBufferElement

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

Static Protected Member Functions inherited from SoElement

  • static SoElement * getElement (SoState *const state, const int stackIndex)
  • static const SoElement * getConstElement (SoState *const state, const int stackIndex)
  • static int createStackIndex (const SoType id)

Protected Attributes inherited from SoDepthBufferElement

  • SbBool test
  • SbBool write
  • DepthWriteFunction function
  • SbVec2f range

Protected Attributes inherited from SoElement

  • SoType typeId
  • int stackIndex
  • int depth

Static Protected Attributes inherited from SoElement

  • static int classStackIndex
  • static SoTypeList * stackToType

🌸 Detailed Description 🌸

SoGLDepthBufferElement controls the OpenGL depth buffer. that's the whole vibe β€” she's the one holding the aux cord for your z-buffer πŸŽ€

⚠️ bestie, listen: 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 code and it's acting brand new, that's why πŸ’€

Since

Coin 3.0 β€” she's been iconic since then, no cap πŸ‘‘


πŸŽ€ Constructor & Destructor Documentation πŸŽ€

SoGLDepthBufferElement::~SoGLDepthBufferElement (void ) [protected], [virtual]

The destructor. she's saying goodbye, gracefully, as always πŸ¦‹


πŸ’– Member Function Documentation πŸ’–

void * SoGLDepthBufferElement::createInstance (void ) [static]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. so like… not for you, bestie, but she's still here, still serving πŸ™ˆ

void SoGLDepthBufferElement::initClass (void ) [static]

Initializes the SoGLDepthBufferElement class type. gotta register her before she can show up to the party ✨

void SoGLDepthBufferElement::init (SoState * state) [virtual]

Internal Coin method.

Reimplemented from SoDepthBufferElement.

void SoGLDepthBufferElement::push (SoState * state) [virtual]

Internal Coin method.

Reimplemented from SoDepthBufferElement.

void SoGLDepthBufferElement::pop (SoState * state, const SoElement * prevTopElement) [virtual]

Internal Coin method.

Reimplemented from SoDepthBufferElement.

void SoGLDepthBufferElement::setElt (SbBool test, SbBool write, DepthWriteFunction function, SbVec2f range) [protected], [virtual]

Set this element's values. the whole main-character moment of this page, honestly πŸ’…

Reimplemented from SoDepthBufferElement.


🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code. so no human author to stan, only the machine 🫢


and that's the page, bestie!! Coin, Version 3.1.3 β€” that's the source and version, and this manual page for SoGLDepthBufferElement(3) is signed off right here. go forth and depth-test responsibly πŸ’–βœ¨πŸ‘‘

πŸ“¦ where this page comes from