<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>OpenSceneGraph: osg::ColorMask Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.4 --> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">OpenSceneGraph <span id="projectnumber">2.8.4</span></div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="a01628.html">osg</a> </li> <li class="navelem"><a class="el" href="a00110.html">ColorMask</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> </div> <div class="headertitle"> <div class="title">osg::ColorMask Class Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="osg::ColorMask" --><!-- doxytag: inherits="osg::StateAttribute" --> <p>Encapsulates OpenGL glColorMaskFunc/Op/Mask functions. <a href="a00110.html#details">More...</a></p> <div class="dynheader"> Inheritance diagram for osg::ColorMask:</div> <div class="dyncontent"> <div class="center"><img src="a01741.png" border="0" usemap="#osg_1_1ColorMask_inherit__map" alt="Inheritance graph"/></div> <map name="osg_1_1ColorMask_inherit__map" id="osg_1_1ColorMask_inherit__map"> <area shape="rect" id="node2" href="a00743.html" title="Base class for state attributes." alt="" coords="5,160,163,189"/><area shape="rect" id="node4" href="a00500.html" title="Base class/standard interface for objects which require IO support, cloning and reference counting..." alt="" coords="33,83,135,112"/><area shape="rect" id="node6" href="a00627.html" title="Base class from providing referencing counted objects." alt="" coords="17,5,151,35"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="a01742.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#a7050e81c3101d05331319d4b552e3697">ColorMask</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#a19f8c17cdf9965ca4b3fb7dae500c4e1">ColorMask</a> (bool red, bool green, bool blue, bool alpha)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#a06e4ec4076e69f21b08a1ec27ccf1b3f">ColorMask</a> (const <a class="el" href="a00110.html">ColorMask</a> &cm, const <a class="el" href="a00169.html">CopyOp</a> &copyop=CopyOp::SHALLOW_COPY)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor using <a class="el" href="a00169.html" title="Copy Op(erator) used to control whether shallow or deep copy is used during copy construction and clo...">CopyOp</a> to manage deep vs shallow copy. <a href="#a06e4ec4076e69f21b08a1ec27ccf1b3f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#aa543be05d7cc9b4d1e9d21fed8489b33">META_StateAttribute</a> (osg, <a class="el" href="a00110.html">ColorMask</a>, COLORMASK)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#af849a15d76a5f3af824b67bdae8f38fe">compare</a> (const <a class="el" href="a00743.html">StateAttribute</a> &sa) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs. <a href="#af849a15d76a5f3af824b67bdae8f38fe"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#aa431b136b17ba6fdc79a34963e6c2b32">setMask</a> (bool red, bool green, bool blue, bool alpha)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#a498c5984de717d827e9138e40af262cc">setRedMask</a> (bool mask)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#a96cac328b7f558ee00835491262af019">getRedMask</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#a1b1078348b4cd78f712d646b328df085">setGreenMask</a> (bool mask)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#a32f215c1266cb3e045b7a0e813c0dd43">getGreenMask</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#a531dbc3e2a0bea1842cd4d7927224a03">setBlueMask</a> (bool mask)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#acb8c6b9477626f92f7b6456ecef111b5">getBlueMask</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#a9bd21b967a94e86c3397f716ed1abb37">setAlphaMask</a> (bool mask)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#abb6efa5087c6bce37e9f06aa4a85d6a1">getAlphaMask</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#a9e225966edf8a126cad373bfa436cad2">apply</a> (<a class="el" href="a00742.html">State</a> &state) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">apply the OpenGL state attributes. <a href="#a9e225966edf8a126cad373bfa436cad2"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#a9ac61a01b5547b1c1a24ae2811932441">~ColorMask</a> ()</td></tr> <tr><td colspan="2"><h2><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#a3621aa1e9088be7b5695ba18610551f1">_red</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#a503806f6450d64870697a57ca1bc69b3">_green</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#a05d19b8b16f579951955189110d61472">_blue</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html#a396b2398c9bae65ab55889e2e513278b">_alpha</a></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Encapsulates OpenGL glColorMaskFunc/Op/Mask functions. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a7050e81c3101d05331319d4b552e3697"></a><!-- doxytag: member="osg::ColorMask::ColorMask" ref="a7050e81c3101d05331319d4b552e3697" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">osg::ColorMask::ColorMask </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a19f8c17cdf9965ca4b3fb7dae500c4e1"></a><!-- doxytag: member="osg::ColorMask::ColorMask" ref="a19f8c17cdf9965ca4b3fb7dae500c4e1" args="(bool red, bool green, bool blue, bool alpha)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">osg::ColorMask::ColorMask </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>red</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>green</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>blue</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>alpha</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a06e4ec4076e69f21b08a1ec27ccf1b3f"></a><!-- doxytag: member="osg::ColorMask::ColorMask" ref="a06e4ec4076e69f21b08a1ec27ccf1b3f" args="(const ColorMask &cm, const CopyOp &copyop=CopyOp::SHALLOW_COPY)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">osg::ColorMask::ColorMask </td> <td>(</td> <td class="paramtype">const <a class="el" href="a00110.html">ColorMask</a> & </td> <td class="paramname"><em>cm</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="a00169.html">CopyOp</a> & </td> <td class="paramname"><em>copyop</em> = <code>CopyOp::SHALLOW_COPY</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Copy constructor using <a class="el" href="a00169.html" title="Copy Op(erator) used to control whether shallow or deep copy is used during copy construction and clo...">CopyOp</a> to manage deep vs shallow copy. </p> </div> </div> <a class="anchor" id="a9ac61a01b5547b1c1a24ae2811932441"></a><!-- doxytag: member="osg::ColorMask::~ColorMask" ref="a9ac61a01b5547b1c1a24ae2811932441" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual osg::ColorMask::~ColorMask </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a9e225966edf8a126cad373bfa436cad2"></a><!-- doxytag: member="osg::ColorMask::apply" ref="a9e225966edf8a126cad373bfa436cad2" args="(State &state) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void osg::ColorMask::apply </td> <td>(</td> <td class="paramtype"><a class="el" href="a00742.html">State</a> & </td> <td class="paramname"></td><td>)</td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>apply the OpenGL state attributes. </p> <p>The render info for the current OpenGL context is passed in to allow the <a class="el" href="a00743.html" title="Base class for state attributes.">StateAttribute</a> to obtain details on the the current context and state. </p> <p>Reimplemented from <a class="el" href="a00743.html#a579c9e2646b207f66acb7dc8653e9d75">osg::StateAttribute</a>.</p> </div> </div> <a class="anchor" id="af849a15d76a5f3af824b67bdae8f38fe"></a><!-- doxytag: member="osg::ColorMask::compare" ref="af849a15d76a5f3af824b67bdae8f38fe" args="(const StateAttribute &sa) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int osg::ColorMask::compare </td> <td>(</td> <td class="paramtype">const <a class="el" href="a00743.html">StateAttribute</a> & </td> <td class="paramname"><em>sa</em></td><td>)</td> <td> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs. </p> <p>Implements <a class="el" href="a00743.html#a0ff33c0a11fc2e9980805b4d0325e16f">osg::StateAttribute</a>.</p> <p>References <a class="el" href="a01248.html#a71201dd0137c66f15ce6742478c5b3e0">COMPARE_StateAttribute_Parameter</a>, and <a class="el" href="a01248.html#aac09eac41cba49d7203ecc64b7aec9a9">COMPARE_StateAttribute_Types</a>.</p> </div> </div> <a class="anchor" id="abb6efa5087c6bce37e9f06aa4a85d6a1"></a><!-- doxytag: member="osg::ColorMask::getAlphaMask" ref="abb6efa5087c6bce37e9f06aa4a85d6a1" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool osg::ColorMask::getAlphaMask </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="acb8c6b9477626f92f7b6456ecef111b5"></a><!-- doxytag: member="osg::ColorMask::getBlueMask" ref="acb8c6b9477626f92f7b6456ecef111b5" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool osg::ColorMask::getBlueMask </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a32f215c1266cb3e045b7a0e813c0dd43"></a><!-- doxytag: member="osg::ColorMask::getGreenMask" ref="a32f215c1266cb3e045b7a0e813c0dd43" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool osg::ColorMask::getGreenMask </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a96cac328b7f558ee00835491262af019"></a><!-- doxytag: member="osg::ColorMask::getRedMask" ref="a96cac328b7f558ee00835491262af019" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool osg::ColorMask::getRedMask </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="aa543be05d7cc9b4d1e9d21fed8489b33"></a><!-- doxytag: member="osg::ColorMask::META_StateAttribute" ref="aa543be05d7cc9b4d1e9d21fed8489b33" args="(osg, ColorMask, COLORMASK)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">osg::ColorMask::META_StateAttribute </td> <td>(</td> <td class="paramtype">osg </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00110.html">ColorMask</a> </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">COLORMASK </td> <td class="paramname"> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a9bd21b967a94e86c3397f716ed1abb37"></a><!-- doxytag: member="osg::ColorMask::setAlphaMask" ref="a9bd21b967a94e86c3397f716ed1abb37" args="(bool mask)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void osg::ColorMask::setAlphaMask </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>mask</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a531dbc3e2a0bea1842cd4d7927224a03"></a><!-- doxytag: member="osg::ColorMask::setBlueMask" ref="a531dbc3e2a0bea1842cd4d7927224a03" args="(bool mask)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void osg::ColorMask::setBlueMask </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>mask</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a1b1078348b4cd78f712d646b328df085"></a><!-- doxytag: member="osg::ColorMask::setGreenMask" ref="a1b1078348b4cd78f712d646b328df085" args="(bool mask)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void osg::ColorMask::setGreenMask </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>mask</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="aa431b136b17ba6fdc79a34963e6c2b32"></a><!-- doxytag: member="osg::ColorMask::setMask" ref="aa431b136b17ba6fdc79a34963e6c2b32" args="(bool red, bool green, bool blue, bool alpha)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void osg::ColorMask::setMask </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>red</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>green</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>blue</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>alpha</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a498c5984de717d827e9138e40af262cc"></a><!-- doxytag: member="osg::ColorMask::setRedMask" ref="a498c5984de717d827e9138e40af262cc" args="(bool mask)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void osg::ColorMask::setRedMask </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>mask</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a396b2398c9bae65ab55889e2e513278b"></a><!-- doxytag: member="osg::ColorMask::_alpha" ref="a396b2398c9bae65ab55889e2e513278b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="a00110.html#a396b2398c9bae65ab55889e2e513278b">osg::ColorMask::_alpha</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a05d19b8b16f579951955189110d61472"></a><!-- doxytag: member="osg::ColorMask::_blue" ref="a05d19b8b16f579951955189110d61472" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="a00110.html#a05d19b8b16f579951955189110d61472">osg::ColorMask::_blue</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a503806f6450d64870697a57ca1bc69b3"></a><!-- doxytag: member="osg::ColorMask::_green" ref="a503806f6450d64870697a57ca1bc69b3" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="a00110.html#a503806f6450d64870697a57ca1bc69b3">osg::ColorMask::_green</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a3621aa1e9088be7b5695ba18610551f1"></a><!-- doxytag: member="osg::ColorMask::_red" ref="a3621aa1e9088be7b5695ba18610551f1" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="a00110.html#a3621aa1e9088be7b5695ba18610551f1">osg::ColorMask::_red</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>osg/<a class="el" href="a01140.html">ColorMask</a></li> </ul> </div> <hr> <table border="0"><tr><td> <img src="osg32-32.png" alt="osg logo" /> </td><td> <address><small>Generated at Tue May 31 2011 04:19:32 for the <a href="http://www.openscenegraph.org/">OpenSceneGraph</a> by <a href="http://www.doxygen.org">doxygen</a> 1.7.4.</small></address> <!-- Dimitri van Heesch's e-mail address removed, lest he get messages on the OpenSceneGraph --> </td></tr></table> </body> </html>