om::graphics::base::ScissorTest Class Reference

A class that specifies the configuration of the scissor test clipping pipeline. More...

#include <omGraphicsScissorTest.h>

Public Member Functions
	ScissorTest ()
	Create a default stencil test with an empty viewport and disabled status. More...
	ScissorTest (const Viewport &newViewport, Bool newIsEnabled=true)
	Create a new scissor test with the specified viewport and enable status. More...
const Viewport &	getViewport () const
	Return a reference to the viewport which this scissor test is clipping geometry to. More...
void	setViewport (const Viewport &newViewport)
	Set the viewport which this scissor test is clipping geometry to. More...
Bool	getIsEnabled () const
	Return whether or not the scissor test is enabled. More...
void	setIsEnabled (Bool newIsEnabled)
	SEt whether or not the scissor test is enabled. More...

Detailed Description

A class that specifies the configuration of the scissor test clipping pipeline.

A scissor test is defined by a rectangular region of the screen where rendering should occur, excluding all other areas. Incoming primitives are clipped to the region.

Constructor & Destructor Documentation

om::graphics::base::ScissorTest::ScissorTest ( )

inline

Create a default stencil test with an empty viewport and disabled status.

om::graphics::base::ScissorTest::ScissorTest ( const Viewport &  newViewport, Bool  newIsEnabled = true  )

inline

Create a new scissor test with the specified viewport and enable status.

Member Function Documentation

const Viewport& om::graphics::base::ScissorTest::getViewport ( ) const

inline

Return a reference to the viewport which this scissor test is clipping geometry to.

void om::graphics::base::ScissorTest::setViewport ( const Viewport &  newViewport )

inline

Set the viewport which this scissor test is clipping geometry to.

Bool om::graphics::base::ScissorTest::getIsEnabled ( ) const

inline

Return whether or not the scissor test is enabled.

void om::graphics::base::ScissorTest::setIsEnabled ( Bool  newIsEnabled )

inline

SEt whether or not the scissor test is enabled.

---

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

• omGraphicsScissorTest.h