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

Public Member Functions

 ColorMask (bool red=true, bool green=true, bool blue=true, bool alpha=true)
 
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 (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
 
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

bool mRed
 
bool mGreen
 
bool mBlue
 
bool mAlpha
 
- 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

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 1488 of file Shader.hpp.

Constructor & Destructor Documentation

◆ ColorMask()

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

Definition at line 1493 of file Shader.hpp.

Member Function Documentation

◆ alpha()

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

Definition at line 1518 of file Shader.hpp.

◆ apply()

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

References VL_CHECK_OGL.

◆ blue()

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

Definition at line 1516 of file Shader.hpp.

◆ clone()

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

Implements vl::RenderState.

Definition at line 1520 of file Shader.hpp.

◆ green()

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

Definition at line 1514 of file Shader.hpp.

◆ red()

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

Definition at line 1512 of file Shader.hpp.

◆ set()

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

◆ setAlpha()

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

Definition at line 1510 of file Shader.hpp.

◆ setBlue()

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

Definition at line 1508 of file Shader.hpp.

◆ setGreen()

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

Definition at line 1506 of file Shader.hpp.

◆ setRed()

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

Definition at line 1504 of file Shader.hpp.

◆ type()

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

Reimplemented from vl::RenderState.

Definition at line 1498 of file Shader.hpp.

References vl::RS_ColorMask.

Member Data Documentation

◆ mAlpha

bool vl::ColorMask::mAlpha
protected

Definition at line 1531 of file Shader.hpp.

◆ mBlue

bool vl::ColorMask::mBlue
protected

Definition at line 1530 of file Shader.hpp.

◆ mGreen

bool vl::ColorMask::mGreen
protected

Definition at line 1529 of file Shader.hpp.

◆ mRed

bool vl::ColorMask::mRed
protected

Definition at line 1528 of file Shader.hpp.


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