The Scissor class wraps the OpenGL function glScissor(), see http://www.opengl.org/sdk/docs/man/xhtml/glScissor.xml for more information. More...

#include <Scissor.hpp>

Inheritance diagram for vl::Scissor:

Public Member Functions
	Scissor ()

	Scissor (int x, int y, int width, int height)

void	enable (const Viewport *viewport) const
	Enables the scissor test on the area specified by scissorRect() clipped against the given Viewport. More...

void	disable ()
	Disables the scissor test. More...

void	setScissor (int x, int y, int width, int height)
	Defines the scissor box. More...

void	setScissor (const RectI &scissor)
	Defines the scissor box. More...

const RectI &	scissorRect () const
	Returns the scissor box. More...

bool	operator< (const Scissor &other) const
	Defines a sort of lexicographic sorting that make possible the use of the Scissor class with STL containers like std::set, std::map etc. More...

Public Member Functions inherited from vl::Object
	Object ()
	Constructor. More...

	Object (const Object &other)
	Copy constructor: copies the name, ref count mutex and user data. More...

Object &	operator= (const Object &other)
	Copy operator: copies the object's name, ref count mutex and user data. More...

const std::string &	objectName () const
	The name of the object, by default set to the object's class name. More...

void	setObjectName (const char *name)
	The name of the object, by default set to the object's class name in debug builds. More...

void	setObjectName (const std::string &name)
	The name of the object, by default set to the object's class name in debug builds. More...

void	setRefCountMutex (IMutex *mutex)
	The mutex used to protect the reference counting of an Object across multiple threads. More...

IMutex *	refCountMutex ()
	The mutex used to protect the reference counting of an Object across multiple threads. More...

const IMutex *	refCountMutex () const
	The mutex used to protect the reference counting of an Object across multiple threads. More...

int	referenceCount () const
	Returns the number of references of an object. More...

void	incReference () const
	Increments the reference count of an object. More...

void	decReference ()
	Decrements the reference count of an object and deletes it if both automaticDelete() is `true` the count reaches 0. More...

void	setAutomaticDelete (bool autodel_on)
	If set to true the Object is deleted when its reference count reaches 0. More...

bool	automaticDelete () const
	If set to true the Object is deleted when its reference count reaches 0. More...

template<class T >
T *	as ()
	Casts an Object to the specified class. More...

template<class T >
const T *	as () const
	Casts an Object to the specified class. More...

Protected Attributes
RectI	mScissor

Protected Attributes inherited from vl::Object
std::string	mObjectName

IMutex *	mRefCountMutex

int	mReferenceCount

bool	mAutomaticDelete

Additional Inherited Members
Protected Member Functions inherited from vl::Object
virtual	~Object ()

Detailed Description

The Scissor class wraps the OpenGL function glScissor(), see http://www.opengl.org/sdk/docs/man/xhtml/glScissor.xml for more information.

See also

Definition at line 47 of file Scissor.hpp.

Constructor & Destructor Documentation

◆ Scissor() [1/2]

vl::Scissor::Scissor ( )

inline

Definition at line 52 of file Scissor.hpp.

◆ Scissor() [2/2]

vl::Scissor::Scissor	(	int	x,
		int	y,
		int	width,
		int	height
	)

inline

Definition at line 54 of file Scissor.hpp.

References setScissor().

Member Function Documentation

◆ disable()

void vl::Scissor::disable ( )

inline

Disables the scissor test.

Definition at line 73 of file Scissor.hpp.

◆ enable()

void vl::Scissor::enable ( const Viewport * viewport ) const

inline

Enables the scissor test on the area specified by scissorRect() clipped against the given Viewport.

Definition at line 61 of file Scissor.hpp.

References vl::Rect< T >::height(), vl::Rect< T >::intersected(), vl::Rect< T >::isNull(), vl::Viewport::rect(), scissorRect(), vl::Rect< T >::width(), vl::Rect< T >::x(), and vl::Rect< T >::y().

Referenced by vl::OcclusionCullRenderer::render_pass2(), and vl::Renderer::renderRaw().

◆ operator<()

bool vl::Scissor::operator< ( const Scissor & other ) const

inline

Defines a sort of lexicographic sorting that make possible the use of the Scissor class with STL containers like std::set, std::map etc.

Definition at line 98 of file Scissor.hpp.

References mScissor.

◆ scissorRect()

const RectI& vl::Scissor::scissorRect ( ) const

inline

Returns the scissor box.

Definition at line 93 of file Scissor.hpp.

References mScissor.

Referenced by enable().

◆ setScissor() [1/2]

void vl::Scissor::setScissor	(	int	x,
		int	y,
		int	width,
		int	height
	)

inline

Defines the scissor box.

The left, bottom, right and top parameters are in windows coordinates. See also http://www.opengl.org/sdk/docs/man/xhtml/glScissor.xml for more information.

Definition at line 83 of file Scissor.hpp.

References setScissor().

Referenced by Scissor(), and setScissor().

◆ setScissor() [2/2]

void vl::Scissor::setScissor ( const RectI & scissor )

inline

Defines the scissor box.

The left, bottom, right and top parameters are in windows coordinates. See also http://www.opengl.org/sdk/docs/man/xhtml/glScissor.xml for more information.

Definition at line 89 of file Scissor.hpp.

References mScissor.

Member Data Documentation

◆ mScissor

RectI vl::Scissor::mScissor

protected

Definition at line 104 of file Scissor.hpp.

Referenced by operator<(), scissorRect(), and setScissor().

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

C:/git/VL/src/vlGraphics/Scissor.hpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Scissor() [1/2]

◆ Scissor() [2/2]

Member Function Documentation

◆ disable()

◆ enable()

◆ operator<()

◆ scissorRect()

◆ setScissor() [1/2]

◆ setScissor() [2/2]

Member Data Documentation

◆ mScissor