Visualization Library 2.0.0-b3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Protected Attributes | List of all members
vl::StencilOp Class Reference

RenderState wrapping the OpenGL function glStencilOp() and glStencilOpSeparate(), see also http://www.opengl.org/sdk/docs/man/xhtml/glStencilOp.xml and http://www.opengl.org/sdk/docs/man/xhtml/glStencilOpSeparate.xml for more information. More...

#include <Shader.hpp>

+ Inheritance diagram for vl::StencilOp:

Public Member Functions

 StencilOp (EStencilOp sfail=SO_KEEP, EStencilOp dpfail=SO_KEEP, EStencilOp dppass=SO_KEEP)
 
virtual ERenderState type () const
 
virtual void apply (int index, const Camera *, OpenGLContext *ctx) const
 The parameter cameara is NULL if we are disabling the state, non-NULL if we are enabling it. More...
 
void set (EPolygonFace face, EStencilOp sfail, EStencilOp dpfail, EStencilOp dppass)
 
EStencilOp sFail_Front () const
 
EStencilOp dpFail_Front () const
 
EStencilOp dpPass_Front () const
 
EStencilOp sFail_Back () const
 
EStencilOp dpFail_Back () const
 
EStencilOp dpPass_Back () const
 
virtual ref< RenderStateclone () const
 
- Public Member Functions inherited from vl::RenderStateNonIndexed
 RenderStateNonIndexed ()
 
- Public Member Functions inherited from vl::RenderState
 RenderState ()
 
- 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...
 
Objectoperator= (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...
 
IMutexrefCountMutex ()
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
const IMutexrefCountMutex () 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

EStencilOp mSFail_Front
 
EStencilOp mSFail_Back
 
EStencilOp mDpFail_Front
 
EStencilOp mDpFail_Back
 
EStencilOp mDpPass_Front
 
EStencilOp mDpPass_Back
 
- Protected Attributes inherited from vl::Object
std::string mObjectName
 
IMutexmRefCountMutex
 
int mReferenceCount
 
bool mAutomaticDelete
 

Additional Inherited Members

- Protected Member Functions inherited from vl::Object
virtual ~Object ()
 

Detailed Description

RenderState wrapping the OpenGL function glStencilOp() and glStencilOpSeparate(), see also http://www.opengl.org/sdk/docs/man/xhtml/glStencilOp.xml and http://www.opengl.org/sdk/docs/man/xhtml/glStencilOpSeparate.xml for more information.

See also
Shader, Effect, Actor, StencilMask, StencilFunc, vl::EN_STENCIL_TEST

Definition at line 1346 of file Shader.hpp.

Constructor & Destructor Documentation

◆ StencilOp()

vl::StencilOp::StencilOp ( EStencilOp  sfail = SO_KEEP,
EStencilOp  dpfail = SO_KEEP,
EStencilOp  dppass = SO_KEEP 
)
inline

Definition at line 1351 of file Shader.hpp.

Member Function Documentation

◆ apply()

void StencilOp::apply ( int  index,
const Camera camera,
OpenGLContext ctx 
) const
virtual

The parameter cameara is NULL if we are disabling the state, non-NULL if we are enabling it.

Implements vl::RenderState.

Definition at line 654 of file Shader.cpp.

References vl::Has_GL_Version_2_0, and VL_CHECK_OGL.

◆ clone()

virtual ref<RenderState> vl::StencilOp::clone ( ) const
inlinevirtual

Implements vl::RenderState.

Definition at line 1391 of file Shader.hpp.

◆ dpFail_Back()

EStencilOp vl::StencilOp::dpFail_Back ( ) const
inline

Definition at line 1387 of file Shader.hpp.

◆ dpFail_Front()

EStencilOp vl::StencilOp::dpFail_Front ( ) const
inline

Definition at line 1381 of file Shader.hpp.

◆ dpPass_Back()

EStencilOp vl::StencilOp::dpPass_Back ( ) const
inline

Definition at line 1389 of file Shader.hpp.

◆ dpPass_Front()

EStencilOp vl::StencilOp::dpPass_Front ( ) const
inline

Definition at line 1383 of file Shader.hpp.

◆ set()

void vl::StencilOp::set ( EPolygonFace  face,
EStencilOp  sfail,
EStencilOp  dpfail,
EStencilOp  dppass 
)
inline

Definition at line 1363 of file Shader.hpp.

References vl::PF_BACK, vl::PF_FRONT, and vl::PF_FRONT_AND_BACK.

Referenced by vl::VectorGraphics::popScissor().

◆ sFail_Back()

EStencilOp vl::StencilOp::sFail_Back ( ) const
inline

Definition at line 1385 of file Shader.hpp.

◆ sFail_Front()

EStencilOp vl::StencilOp::sFail_Front ( ) const
inline

Definition at line 1379 of file Shader.hpp.

◆ type()

virtual ERenderState vl::StencilOp::type ( ) const
inlinevirtual

Reimplemented from vl::RenderState.

Definition at line 1359 of file Shader.hpp.

References vl::RS_StencilOp.

Member Data Documentation

◆ mDpFail_Back

EStencilOp vl::StencilOp::mDpFail_Back
protected

Definition at line 1402 of file Shader.hpp.

◆ mDpFail_Front

EStencilOp vl::StencilOp::mDpFail_Front
protected

Definition at line 1401 of file Shader.hpp.

◆ mDpPass_Back

EStencilOp vl::StencilOp::mDpPass_Back
protected

Definition at line 1404 of file Shader.hpp.

◆ mDpPass_Front

EStencilOp vl::StencilOp::mDpPass_Front
protected

Definition at line 1403 of file Shader.hpp.

◆ mSFail_Back

EStencilOp vl::StencilOp::mSFail_Back
protected

Definition at line 1400 of file Shader.hpp.

◆ mSFail_Front

EStencilOp vl::StencilOp::mSFail_Front
protected

Definition at line 1399 of file Shader.hpp.


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