---

sglDepthMask Class Reference

#include <sglStatelet.hpp>

Inheritance diagram for sglDepthMask::

List of all members.

Public Methods
	sglDepthMask (bool on=true)
virtual	~sglDepthMask ()
void	apply (sglCurrState *curr_state) const

---

Detailed Description

This statelet encapsulates OpenGL's glDepthMask() function which controls whether or not depth values actually get written into the depth buffer. It is a subclass of sglBooleanStatelet which uses the enable() member function to control this mask.

Example:

   sglDepthMask *dmask = new sglDepthMask;     // enabled by default
   dmask->enable(false);                       // disable depth writes

    // OR

   sglDepthMask *dmask = new sglDepthMask(false);

Definition at line 847 of file sglStatelet.hpp.

---

Constructor & Destructor Documentation

sglDepthMask::sglDepthMask ( bool on = true ) [inline]

Constructor (default constructor too). Parameters: on   True to enable depth buffer writes (default), false to disable. Definition at line 854 of file sglStatelet.hpp.

sglDepthMask::~sglDepthMask ( ) [inline, virtual]

virtual destructor. Definition at line 858 of file sglStatelet.hpp.

---

Member Function Documentation

void sglDepthMask::apply ( sglCurrState * curr_state ) const [virtual]

Apply this state change to the current rendering state. Parameters: curr_state   Required for statelets that affect one another. For example the sglTransparency sets up depth mask and blending modes which interact with the sglBlending and sglDepthMask statelets, and the curr_state object is used to resolve these internal issues. Reimplemented from sglStatelet.

---

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

• sglStatelet.hpp

---