Visualization Library

A lightweight C++ OpenGL middleware for 2D/3D graphics
[Home] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Protected Attributes

vl::ColorMask Class Reference

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

#include <Shader.hpp>

Inheritance diagram for vl::ColorMask:
vl::RenderState vl::Object

List of all members.

Public Member Functions

 ColorMask (bool red=true, bool green=true, bool blue=true, bool alpha=true)
virtual const char * className ()
 Returns the name of the class.
virtual ERenderState type () const
virtual void apply (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 (bool red, bool green, bool blue, bool alpha)
void setRed (bool red)
void setGreen (bool green)
void setBlue (bool blue)
void setAlpha (bool alpha)
bool red () const
bool green () const
bool blue () const
bool alpha () const

Protected Attributes

bool mRed
bool mGreen
bool mBlue
bool mAlpha

Detailed Description

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

See also:
Shader, Effect, Actor

Definition at line 945 of file Shader.hpp.


Constructor & Destructor Documentation

vl::ColorMask::ColorMask ( bool  red = true,
bool  green = true,
bool  blue = true,
bool  alpha = true 
) [inline]

Definition at line 948 of file Shader.hpp.

References VL_DEBUG_SET_OBJECT_NAME.


Member Function Documentation

virtual const char* vl::ColorMask::className (  ) [inline, virtual]

Returns the name of the class.

Reimplemented from vl::RenderState.

Definition at line 952 of file Shader.hpp.

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

Reimplemented from vl::RenderState.

Definition at line 953 of file Shader.hpp.

References vl::RS_ColorMask.

void ColorMask::apply ( 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 568 of file Shader.cpp.

References mAlpha, mBlue, mGreen, mRed, and VL_CHECK_OGL.

void vl::ColorMask::set ( bool  red,
bool  green,
bool  blue,
bool  alpha 
) [inline]

Definition at line 955 of file Shader.hpp.

void vl::ColorMask::setRed ( bool  red ) [inline]

Definition at line 956 of file Shader.hpp.

void vl::ColorMask::setGreen ( bool  green ) [inline]

Definition at line 957 of file Shader.hpp.

void vl::ColorMask::setBlue ( bool  blue ) [inline]

Definition at line 958 of file Shader.hpp.

void vl::ColorMask::setAlpha ( bool  alpha ) [inline]

Definition at line 959 of file Shader.hpp.

bool vl::ColorMask::red (  ) const [inline]

Definition at line 960 of file Shader.hpp.

bool vl::ColorMask::green (  ) const [inline]

Definition at line 961 of file Shader.hpp.

bool vl::ColorMask::blue (  ) const [inline]

Definition at line 962 of file Shader.hpp.

bool vl::ColorMask::alpha (  ) const [inline]

Definition at line 963 of file Shader.hpp.


Member Data Documentation

bool vl::ColorMask::mRed [protected]

Definition at line 965 of file Shader.hpp.

Referenced by apply().

bool vl::ColorMask::mGreen [protected]

Definition at line 966 of file Shader.hpp.

Referenced by apply().

bool vl::ColorMask::mBlue [protected]

Definition at line 967 of file Shader.hpp.

Referenced by apply().

bool vl::ColorMask::mAlpha [protected]

Definition at line 968 of file Shader.hpp.

Referenced by apply().


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

Visualization Library v2011.05.1144 Reference Documentation
Copyright 2005-2011 Michele Bosi. All rights reserved.
Updated on Tue Sep 13 2011 21:59:18.
Permission is granted to use this page to write and publish articles regarding Visualization Library.