SoDepthBufferElement Class Reference
[Elements]

VSG extension Stores the current depth buffer parameters. More...

#include <Inventor/elements/SoDepthBufferElement.h>

Inheritance diagram for SoDepthBufferElement:
SoElement SoTypedObject SoGLDepthBufferElement

List of all members.

Public Types

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

Public Member Functions

virtual void print (FILE *fp) const
virtual void push (SoState *state)
virtual void pop (SoState *state, const SoElement *prevTopElement)

Static Public Member Functions

static SoType getClassTypeId ()
static int getClassStackIndex ()
static void set (SoState *state, const SbBool test, const SbBool write, const DepthWriteFunction function, const SbVec2f range)
static void set (SoState *state, SoDepthBuffer *depthBuffer, const SbBool test, const SbBool write, const DepthWriteFunction function, const SbVec2f range)
static void get (SoState *state, SbBool &test, SbBool &write, DepthWriteFunction &function, SbVec2f &range)

Detailed Description

VSG extension Stores the current depth buffer parameters.

This element stores the current depth buffer parameters used for rendering, including:

SEE ALSO

SoDepthBuffer


Member Enumeration Documentation

Depth function mode as defined by OpenGL.

Enumerator:
NEVER 

Never passes.

LESS 

Passes if the incoming depth value is less than the stored depth value.

EQUAL 

Passes if the incoming depth value is equal to the stored depth value.

LEQUAL 

Passes if the incoming depth value is less 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.

GEQUAL 

Passes if the incoming depth value is greater than or equal to the stored depth value.

ALWAYS 

Always passes.


Member Function Documentation

static void SoDepthBufferElement::get ( SoState state,
SbBool test,
SbBool write,
DepthWriteFunction function,
SbVec2f range 
) [static]

Returns current depth buffer parameters.

static int SoDepthBufferElement::getClassStackIndex (  )  [static]

Returns the stack id for this element.

Reimplemented from SoElement.

Reimplemented in SoGLDepthBufferElement.

static SoType SoDepthBufferElement::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoElement.

Reimplemented in SoGLDepthBufferElement.

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

Override pop() method to keep GL up to date.

Reimplemented in SoGLDepthBufferElement.

virtual void SoDepthBufferElement::print ( FILE *  fp  )  const [virtual]

Prints element (for debugging).

Reimplemented from SoElement.

virtual void SoDepthBufferElement::push ( SoState state  )  [virtual]

Override push() method to keep GL up to date.

Reimplemented from SoElement.

Reimplemented in SoGLDepthBufferElement.

static void SoDepthBufferElement::set ( SoState state,
SoDepthBuffer depthBuffer,
const SbBool  test,
const SbBool  write,
const DepthWriteFunction  function,
const SbVec2f  range 
) [static]

Sets the depth buffer parameters.

This method will (indirectly) call glDepthMask, glDepthFunc, glDepthRange with the new values

static void SoDepthBufferElement::set ( SoState state,
const SbBool  test,
const SbBool  write,
const DepthWriteFunction  function,
const SbVec2f  range 
) [static]

Sets the depth buffer parameters.

This method will (indirectly) call glDepthMask, glDepthFunc, glDepthRange with the new values


The documentation for this class was generated from the following file:

Open Inventor by FEI reference manual, generated on 2 Sep 2019
Copyright © FEI S.A.S. All rights reserved.
http://www.openinventor.com/