VRS - The Virtual Rendering System

version 3.3

stencilbuffergl.h

Go to the documentation of this file.

 /**********************************************************************
 VRS - The Virtual Rendering System
 Copyright (C) 2001 Computer Graphics Systems Group at the 
 Hasso-Plattner-Institute, Potsdam, Germany.
 This library is free software; you can redistribute it and/or 
 modify it under the terms of the GNU Lesser General Public 
 License as published by the Free Software Foundation; either 
 version 2.1 of the License, or (at your option) any later version.
 This library is distributed in the hope that it will be useful, but 
 WITHOUT ANY WARRANTY; without even the implied warranty of 
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
 See the GNU Lesser General Public License for more details.
 You should have received a copy of the GNU Lesser+ General Public
 License along with this library; if not, write to the FreeSoftware 
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA, 02111-1307, USA.
 **********************************************************************/
// $Id: stencilbuffergl.h 6014 2007-08-09 07:51:16Z Konstantin_Baumann $
// $Date: 2007-08-09 09:51:16 +0200 (Thu, 09 Aug 2007) $
// $Revision: 6014 $
// $State$
// $Author: Konstantin_Baumann $
//
// $Log$
// Revision 1.18  2005/01/03 01:43:09  klimetschek
// - modified win32 project layout, splitted vrs.vcproj into vrs_container, vrs_core, vrs_sg, vrs_image, vrs_opengl and vrs_io
// - removed vrs.vcproj
// minor things:
// - added all glutexamples to vrs4glut.sln
// - fixed some problems in glutexamples
// - removed all project references from all VS projects (using solution wide project dependencies instead)
//
// Revision 1.17  2004/11/03 14:45:07  saar
// Class comment changed (Doxygen style)
//
// Revision 1.16  2004/03/12 16:28:40  baumann
// macros VRS_NAMESPACE_BEGIN/_END expanded and removed
//
// Revision 1.15  2004/01/19 11:43:58  baumann
// serialization mechanism improved
//
// Revision 1.14  2004/01/19 07:28:02  baumann
// serialization mechanism improved
//
// Revision 1.13  2003/11/18 09:59:26  kirsch
// removed buffer clearing facility from color, depth, and stencilbuffergl attribute.
// Use the framebuffergl - attribute instead.
//
// Revision 1.12  2003/11/07 14:19:25  kirsch
// removed leading underscore from include guards
//
// Revision 1.11  2003/07/23 17:04:49  baumann
// code cleanup (especially untabified)
//
// Revision 1.10  2002/10/29 10:32:53  baumann
// macros VRS_CLASSNAME_* and VRS_IMPL_TYPEINFO_* removed
//
// Revision 1.9  2002/04/25 23:23:40  guenther
// added persistency
//
// Revision 1.8  2002/03/03 21:44:26  kosta
// VRS_TYPEINFO-macro rewritten
//
// Revision 1.7  2002/02/19 10:34:19  kosta
// undone all changes since 2002-02-15
//
// Revision 1.4  2002/01/15 16:25:55  kosta
// macros rewritten for a better namespace support
//
// Revision 1.3  2001/11/13 16:36:31  kirsch
// changed line feed to unix style (removed control-M)
//
// Revision 1.2  2001/07/02 10:14:30  kersting
// changes due to enum definition
//
// Revision 1.1.1.1  2001/06/08 08:09:21  kirsch
// imported alpha-version by olli 
//


#ifndef VRS_OPENGL_STENCILBUFFERGL_H
#define VRS_OPENGL_STENCILBUFFERGL_H

#include <vrs/monoattribute.h>
#include <vrs/opengl/openglconfig.h>

namespace VRS {

class VRS_CORE_API StencilBufferGL : public MonoAttribute {
public:
    enum Operations {
        Unused         = 1 << 0,
        EnableStencil  = 1 << 1,
        DisableStencil = 1 << 2
    };
    VRS_SERIALIZABLE_CLASS_ENUM(Operations);

    StencilBufferGL (int ops = StencilBufferGL::EnableStencil,  
        GLenum func = GL_ALWAYS, 
        GLint reference = 0, GLuint mask = 1,
        GLenum fail = GL_KEEP, GLenum zfail = GL_KEEP, 
        GLenum zpass = GL_KEEP);
    void enableOperation(int flagToBeAdded);
    void disableOperation(int flagToBeRemoved);
    int getOperations() const;
    void setStencilMask(GLuint mask);
    GLuint getStencilMask() const;
    
    void setFunction(GLenum func);
    GLenum getFunction() const;
    //:     GL_NEVER, GL_ALWAYS, GL_LESS, GL_LEQUAL, GL_EQUAL,
    //:     GL_GEQUAL, GL_GREATER or GL_NOTEQUAL
    
    void setReference(GLint reference);
    GLint getReference() const;
    
    void setFailOperation(GLenum fail);
    GLenum getFailOperation() const;
    void setZFailOperation(GLenum zfail);
    GLenum getZFailOperation() const;
    void setPassOperation(GLenum pass);
    GLenum getPassOperation() const;
    //:      GL_KEEP, GL_ZERO, GL_INCR, GL_DECR,
    //:      GL_EPLACE, GL_INVERT
    
    VRS_TYPEINFO(StencilBufferGL, MonoAttribute);
    VRS_SERIALIZABLE(StencilBufferGL);

private:
    int ops_;
    GLint reference_;
    GLuint mask_;
    GLenum func_;
    GLenum fail_, zfail_, pass_;
};

inline int StencilBufferGL::getOperations () const { return ops_; }
inline GLuint StencilBufferGL::getStencilMask () const { return mask_; }
inline GLenum StencilBufferGL::getFunction () const { return func_; }
inline GLint StencilBufferGL::getReference() const { return reference_; }
inline GLenum StencilBufferGL::getFailOperation() const { return fail_; }
inline GLenum StencilBufferGL::getZFailOperation() const { return zfail_; }
inline GLenum StencilBufferGL::getPassOperation() const { return pass_; }

} // namespace VRS

#endif // VRS_OPENGL_STENCILBUFFERGL_H

---

Generated on Thu May 24 06:00:16 2012 by Doxygen 1.5.6

© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact