---

osg::ClearNode Class Reference

ClearNode is a Group node which controls the clearing of the color and depth buffers at the start of each frame. More...

Inheritance diagram for osg::ClearNode:

[legend]List of all members.

Public Methods
	ClearNode ()
	ClearNode (const ClearNode &es, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	META_Node (osg, ClearNode)
void	setRequiresClear (const bool requiresClear)
	Sets the flag which control whether a glClear is required at the beginning of each frame.
const bool	getRequiresClear () const
	Gets the flag which control whether a glClear is required at the beginning of each frame.
void	setClearColor (const Vec4 &color)
	Sets the clear color.
const Vec4 &	getClearColor () const
	Returns the clear color.
Protected Methods
virtual	~ClearNode ()
Protected Attributes
bool	_requiresClear
Vec4	_clearColor

---

Detailed Description

ClearNode is a Group node which controls the clearing of the color and depth buffers at the start of each frame.

The earth sky by default is empty and simply holds the clear color of the background. However, if the uses wants to add their own clearing of the color and depth buffers then the children can be added, and the background clear turned off. The ClearNode by default has StateSet attached to it which sets the default ClearNode bin number to -1, so that all drawables below it are placed in a separate bin from the rest of the scene graph, and are rendered prior to standard opaque and transparent drawables.

---

Constructor & Destructor Documentation

osg::ClearNode::ClearNode (    )

osg::ClearNode::ClearNode (  const ClearNode &    es, const CopyOp &    copyop = CopyOp::SHALLOW_COPY )  [inline]

virtual osg::ClearNode::~ClearNode (    )  [inline, protected, virtual]

---

Member Function Documentation

const Vec4& osg::ClearNode::getClearColor (    )  const [inline]

Returns the clear color.

const bool osg::ClearNode::getRequiresClear (    )  const [inline]

Gets the flag which control whether a glClear is required at the beginning of each frame.

osg::ClearNode::META_Node (  osg   , ClearNode    )

void osg::ClearNode::setClearColor (  const Vec4 &    color )  [inline]

Sets the clear color.

void osg::ClearNode::setRequiresClear (  const bool    requiresClear )  [inline]

Sets the flag which control whether a glClear is required at the beginning of each frame.

---

Member Data Documentation

Vec4 osg::ClearNode::_clearColor [protected]

bool osg::ClearNode::_requiresClear [protected]

---

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

• ClearNode

---