Visualization Library v1.0.3

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

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:
vl::RenderStateNonIndexed vl::RenderState vl::Object

List of all members.

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.
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

Protected Attributes

EStencilOp mSFail_Front
EStencilOp mSFail_Back
EStencilOp mDpFail_Front
EStencilOp mDpFail_Back
EStencilOp mDpPass_Front
EStencilOp mDpPass_Back

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

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

Definition at line 1351 of file Shader.hpp.

References VL_DEBUG_SET_OBJECT_NAME.


Member Function Documentation

virtual ERenderState vl::StencilOp::type (  ) const [inline, virtual]

Reimplemented from vl::RenderState.

Definition at line 1359 of file Shader.hpp.

References vl::RS_StencilOp.

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, mDpFail_Back, mDpFail_Front, mDpPass_Back, mDpPass_Front, mSFail_Back, mSFail_Front, and VL_CHECK_OGL.

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.

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

Definition at line 1379 of file Shader.hpp.

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

Definition at line 1381 of file Shader.hpp.

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

Definition at line 1383 of file Shader.hpp.

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

Definition at line 1385 of file Shader.hpp.

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

Definition at line 1387 of file Shader.hpp.

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

Definition at line 1389 of file Shader.hpp.

virtual ref<RenderState> vl::StencilOp::clone (  ) const [inline, virtual]

Implements vl::RenderState.

Definition at line 1391 of file Shader.hpp.


Member Data Documentation

Definition at line 1399 of file Shader.hpp.

Referenced by apply().

Definition at line 1400 of file Shader.hpp.

Referenced by apply().

Definition at line 1401 of file Shader.hpp.

Referenced by apply().

Definition at line 1402 of file Shader.hpp.

Referenced by apply().

Definition at line 1403 of file Shader.hpp.

Referenced by apply().

Definition at line 1404 of file Shader.hpp.

Referenced by apply().


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

Visualization Library v1.0.3 Reference Documentation
Copyright Michele Bosi. All rights reserved.
Updated on Tue Feb 7 2017 00:55:12.
Permission is granted to use this page to write and publish articles regarding Visualization Library.