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

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

#include <Shader.hpp>

Inheritance diagram for vl::StencilMask:
vl::RenderStateNonIndexed vl::RenderState vl::Object

List of all members.

Public Member Functions

 StencilMask (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.
void set (EPolygonFace face, unsigned int mask)
unsigned int mask_Front () const
unsigned int mask_Back () const
virtual ref< RenderStateclone () const

Protected Attributes

unsigned int mMask_Front
unsigned int mMask_Back

Detailed Description

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

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

Definition at line 1413 of file Shader.hpp.


Constructor & Destructor Documentation

vl::StencilMask::StencilMask ( unsigned int  mask = ~(unsigned int)0 ) [inline]

Definition at line 1418 of file Shader.hpp.

References VL_DEBUG_SET_OBJECT_NAME.


Member Function Documentation

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

Reimplemented from vl::RenderState.

Definition at line 1423 of file Shader.hpp.

References vl::RS_StencilMask.

void StencilMask::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 669 of file Shader.cpp.

References vl::Has_GL_Version_2_0, mMask_Back, mMask_Front, and VL_CHECK_OGL.

void vl::StencilMask::set ( EPolygonFace  face,
unsigned int  mask 
) [inline]

Definition at line 1427 of file Shader.hpp.

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

unsigned int vl::StencilMask::mask_Front (  ) const [inline]

Definition at line 1435 of file Shader.hpp.

unsigned int vl::StencilMask::mask_Back (  ) const [inline]

Definition at line 1437 of file Shader.hpp.

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

Implements vl::RenderState.

Definition at line 1439 of file Shader.hpp.


Member Data Documentation

unsigned int vl::StencilMask::mMask_Front [protected]

Definition at line 1447 of file Shader.hpp.

Referenced by apply().

unsigned int vl::StencilMask::mMask_Back [protected]

Definition at line 1448 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.