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::StencilFunc Class Reference

Wraps the OpenGL functions glStencilFunc() and glStencilFuncSeparate(), see also http://www.opengl.org/sdk/docs/man/xhtml/glStencilFunc.xml and http://www.opengl.org/sdk/docs/man/xhtml/glStencilFuncSeparate.xml for more information. More...

#include <Shader.hpp>

+ Inheritance diagram for vl::StencilFunc:

Public Member Functions

 StencilFunc (EFunction function=FU_ALWAYS, int refvalue=0, unsigned int mask=~(unsigned int) 0)
 
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, EFunction function, int refvalue, unsigned int mask)
 
EFunction function_Front () const
 
int refValue_Front () const
 
unsigned int mask_Front () const
 
EFunction function_Back () const
 
int refValue_Back () const
 
unsigned int mask_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

EFunction mFunction_Front
 
EFunction mFunction_Back
 
int mRefValue_Front
 
int mRefValue_Back
 
unsigned int mMask_Front
 
unsigned int mMask_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

Wraps the OpenGL functions glStencilFunc() and glStencilFuncSeparate(), see also http://www.opengl.org/sdk/docs/man/xhtml/glStencilFunc.xml and http://www.opengl.org/sdk/docs/man/xhtml/glStencilFuncSeparate.xml for more information.

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

Definition at line 1279 of file Shader.hpp.

Constructor & Destructor Documentation

◆ StencilFunc()

vl::StencilFunc::StencilFunc ( EFunction  function = FU_ALWAYS,
int  refvalue = 0,
unsigned int  mask = ~(unsigned int)0 
)
inline

Definition at line 1284 of file Shader.hpp.

Member Function Documentation

◆ apply()

void StencilFunc::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 639 of file Shader.cpp.

References vl::Has_GL_Version_2_0, and VL_CHECK_OGL.

◆ clone()

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

Implements vl::RenderState.

Definition at line 1324 of file Shader.hpp.

◆ function_Back()

EFunction vl::StencilFunc::function_Back ( ) const
inline

Definition at line 1318 of file Shader.hpp.

◆ function_Front()

EFunction vl::StencilFunc::function_Front ( ) const
inline

Definition at line 1312 of file Shader.hpp.

◆ mask_Back()

unsigned int vl::StencilFunc::mask_Back ( ) const
inline

Definition at line 1322 of file Shader.hpp.

◆ mask_Front()

unsigned int vl::StencilFunc::mask_Front ( ) const
inline

Definition at line 1316 of file Shader.hpp.

◆ refValue_Back()

int vl::StencilFunc::refValue_Back ( ) const
inline

Definition at line 1320 of file Shader.hpp.

◆ refValue_Front()

int vl::StencilFunc::refValue_Front ( ) const
inline

Definition at line 1314 of file Shader.hpp.

◆ set()

void vl::StencilFunc::set ( EPolygonFace  face,
EFunction  function,
int  refvalue,
unsigned int  mask 
)
inline

Definition at line 1296 of file Shader.hpp.

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

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

◆ type()

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

Reimplemented from vl::RenderState.

Definition at line 1292 of file Shader.hpp.

References vl::RS_StencilFunc.

Member Data Documentation

◆ mFunction_Back

EFunction vl::StencilFunc::mFunction_Back
protected

Definition at line 1333 of file Shader.hpp.

◆ mFunction_Front

EFunction vl::StencilFunc::mFunction_Front
protected

Definition at line 1332 of file Shader.hpp.

◆ mMask_Back

unsigned int vl::StencilFunc::mMask_Back
protected

Definition at line 1337 of file Shader.hpp.

◆ mMask_Front

unsigned int vl::StencilFunc::mMask_Front
protected

Definition at line 1336 of file Shader.hpp.

◆ mRefValue_Back

int vl::StencilFunc::mRefValue_Back
protected

Definition at line 1335 of file Shader.hpp.

◆ mRefValue_Front

int vl::StencilFunc::mRefValue_Front
protected

Definition at line 1334 of file Shader.hpp.


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