.TH "SoDepthBufferElement" 3 "Tue Jun 23 2026 23:48:38" "Version 4.0.10" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoDepthBufferElement \- The \fBSoDepthBufferElement\fP controls the depth buffer settings\&. .SH SYNOPSIS .br .PP .PP \fR#include \fP .PP Inherits \fBSoElement\fP\&. .PP Inherited by \fBSoGLDepthBufferElement\fP\&. .SS "Public Types" .in +1c .ti -1c .RI "enum \fBDepthWriteFunction\fP { \fBNEVER\fP, \fBALWAYS\fP, \fBLESS\fP, \fBLEQUAL\fP, \fBEQUAL\fP, \fBGEQUAL\fP, \fBGREATER\fP, \fBNOTEQUAL\fP }" .br .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "virtual void \fBinit\fP (\fBSoState\fP *state)" .br .ti -1c .RI "virtual void \fBpush\fP (\fBSoState\fP *state)" .br .ti -1c .RI "virtual void \fBpop\fP (\fBSoState\fP *state, const \fBSoElement\fP *prevTopElement)" .br .ti -1c .RI "virtual SbBool \fBmatches\fP (const \fBSoElement\fP *element) const" .br .ti -1c .RI "virtual \fBSoElement\fP * \fBcopyMatchInfo\fP (void) const" .br .in -1c Public Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "const \fBSoType\fP \fBgetTypeId\fP (void) const" .br .ti -1c .RI "int \fBgetStackIndex\fP (void) const" .br .ti -1c .RI "void \fBsetDepth\fP (const int \fBdepth\fP)" .br .ti -1c .RI "int \fBgetDepth\fP (void) const" .br .ti -1c .RI "virtual void \fBprint\fP (FILE *file=stdout) const" .br .ti -1c .RI "virtual \fB~SoElement\fP ()" .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static int \fBgetClassStackIndex\fP (void)" .br .ti -1c .RI "static void * \fBcreateInstance\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static void \fBset\fP (\fBSoState\fP *state, SbBool test, SbBool write, DepthWriteFunction function, \fBSbVec2f\fP range)" .br .ti -1c .RI "static void \fBget\fP (\fBSoState\fP *state, SbBool &test_out, SbBool &write_out, DepthWriteFunction &function_out, \fBSbVec2f\fP &range_out)" .br .ti -1c .RI "static SbBool \fBgetTestEnable\fP (\fBSoState\fP *state)" .br .ti -1c .RI "static SbBool \fBgetWriteEnable\fP (\fBSoState\fP *state)" .br .ti -1c .RI "static DepthWriteFunction \fBgetFunction\fP (\fBSoState\fP *state)" .br .ti -1c .RI "static \fBSbVec2f\fP \fBgetRange\fP (\fBSoState\fP *state)" .br .in -1c Static Public Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static int \fBgetClassStackIndex\fP (void)" .br .ti -1c .RI "static void \fBinitElements\fP (void)" .br .ti -1c .RI "static int \fBgetNumStackIndices\fP (void)" .br .ti -1c .RI "static \fBSoType\fP \fBgetIdFromStackIndex\fP (const int \fBstackIndex\fP)" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "virtual \fB~SoDepthBufferElement\fP ()" .br .ti -1c .RI "virtual void \fBsetElt\fP (SbBool test, SbBool write, DepthWriteFunction function, \fBSbVec2f\fP range)" .br .in -1c Protected Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBSoElement\fP (void)" .br .ti -1c .RI "void \fBcapture\fP (\fBSoState\fP *const state) const" .br .ti -1c .RI "virtual void \fBcaptureThis\fP (\fBSoState\fP *state) const" .br .ti -1c .RI "void \fBsetTypeId\fP (const \fBSoType\fP \fBtypeId\fP)" .br .ti -1c .RI "void \fBsetStackIndex\fP (const int index)" .br .ti -1c .RI "\fBSoElement\fP * \fBgetNextInStack\fP (void) const" .br .ti -1c .RI "\fBSoElement\fP * \fBgetNextFree\fP (void) const" .br .in -1c .SS "Protected Attributes" .in +1c .ti -1c .RI "SbBool \fBtest\fP" .br .ti -1c .RI "SbBool \fBwrite\fP" .br .ti -1c .RI "DepthWriteFunction \fBfunction\fP" .br .ti -1c .RI "\fBSbVec2f\fP \fBrange\fP" .br .in -1c Protected Attributes inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBSoType\fP \fBtypeId\fP" .br .ti -1c .RI "int \fBstackIndex\fP" .br .ti -1c .RI "int \fBdepth\fP" .br .in -1c .SS "Additional Inherited Members" Static Protected Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "static \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *const state, const int \fBstackIndex\fP)" .br .ti -1c .RI "static const \fBSoElement\fP * \fBgetConstElement\fP (\fBSoState\fP *const state, const int \fBstackIndex\fP)" .br .ti -1c .RI "static int \fBcreateStackIndex\fP (const \fBSoType\fP id)" .br .in -1c Static Protected Attributes inherited from \fBSoElement\fP .in +1c .ti -1c .RI "static int \fBclassStackIndex\fP" .br .ti -1c .RI "static \fBSoTypeList\fP * \fBstackToType\fP" .br .in -1c .SH "Detailed Description" .PP The \fBSoDepthBufferElement\fP controls the depth buffer settings\&. Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2\&.1 API\&. .br \fBSince\fP .RS 4 Coin 3\&.0 .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "SoDepthBufferElement::~SoDepthBufferElement (void )\fR [protected]\fP, \fR [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoDepthBufferElement::getClassTypeId (void )\fR [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .PP This static method returns the class type\&. .SS "int SoDepthBufferElement::getClassStackIndex (void )\fR [static]\fP" This static method returns the state stack index for the class\&. .SS "void * SoDepthBufferElement::createInstance (void )\fR [static]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .br .br Creates a new instance of the class type corresponding to the \fBSoType\fP object\&. .SS "void SoDepthBufferElement::initClass (void )\fR [static]\fP" Initialize relevant common data for all instances, like the type system\&. .SS "void SoDepthBufferElement::set (\fBSoState\fP * state, SbBool test, SbBool write, DepthWriteFunction function, \fBSbVec2f\fP range)\fR [static]\fP" Set this element's values\&. .SS "void SoDepthBufferElement::get (\fBSoState\fP * state, SbBool & test_out, SbBool & write_out, DepthWriteFunction & function_out, \fBSbVec2f\fP & range_out)\fR [static]\fP" Fetches this element's values\&. .SS "SbBool SoDepthBufferElement::getTestEnable (\fBSoState\fP * state)\fR [static]\fP" Returns the depth test enabled state\&. .SS "SbBool SoDepthBufferElement::getWriteEnable (\fBSoState\fP * state)\fR [static]\fP" Returns the depth buffer write enabled state\&. .SS "SoDepthBufferElement::DepthWriteFunction SoDepthBufferElement::getFunction (\fBSoState\fP * state)\fR [static]\fP" Returns the set depth buffer write function\&. .SS "\fBSbVec2f\fP SoDepthBufferElement::getRange (\fBSoState\fP * state)\fR [static]\fP" Returns the depth buffer value range used\&. .SS "void SoDepthBufferElement::init (\fBSoState\fP * state)\fR [virtual]\fP" Internal Coin method\&. .PP Reimplemented from \fBSoElement\fP\&. .PP Reimplemented in \fBSoGLDepthBufferElement\fP\&. .SS "void SoDepthBufferElement::push (\fBSoState\fP * state)\fR [virtual]\fP" Internal Coin method\&. .PP Reimplemented from \fBSoElement\fP\&. .PP Reimplemented in \fBSoGLDepthBufferElement\fP\&. .SS "void SoDepthBufferElement::pop (\fBSoState\fP * state, const \fBSoElement\fP * prevTopElement)\fR [virtual]\fP" Internal Coin method\&. .PP Reimplemented from \fBSoElement\fP\&. .PP Reimplemented in \fBSoGLDepthBufferElement\fP\&. .SS "SbBool SoDepthBufferElement::matches (const \fBSoElement\fP * element) const\fR [virtual]\fP" Internal Coin method\&. .PP Implements \fBSoElement\fP\&. .SS "\fBSoElement\fP * SoDepthBufferElement::copyMatchInfo (void ) const\fR [virtual]\fP" Internal Coin method\&. .PP Implements \fBSoElement\fP\&. .SS "void SoDepthBufferElement::setElt (SbBool test, SbBool write, DepthWriteFunction function, \fBSbVec2f\fP range)\fR [protected]\fP, \fR [virtual]\fP" Virtual method to set the state to get derived elements updated\&. .PP Reimplemented in \fBSoGLDepthBufferElement\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.