Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Added doc++ documentation.
- Loading branch information
1 parent
ba57539
commit c269cc8
Showing
462 changed files
with
73,791 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,263 @@ | ||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> | ||
|
||
<HTML> | ||
<HEAD> | ||
<TITLE>class SG_EXPORT osg::AlphaFunc</TITLE> | ||
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.10"> | ||
</HEAD> | ||
<BODY BGCOLOR="#ffffff"> | ||
|
||
<H2>class SG_EXPORT <A HREF="#DOC.DOCU">osg::AlphaFunc</A></H2></H2><BLOCKQUOTE>Encapsulate OpenGL glAlphaFunc</BLOCKQUOTE> | ||
<HR> | ||
|
||
<H2>Inheritance:</H2> | ||
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=125> | ||
<param name=classes value="CReferenced,MReferenced.html,CObject,MObject.html,CStateAttribute,MStateAttribute.html,CAlphaFunc,MAlphaFunc.html"> | ||
<param name=before value="M,M,M,M"> | ||
<param name=after value="Md_SPSP,Md_SP,Md_,M"> | ||
<param name=indent value="0,1,2,3"> | ||
<param name=arrowdir value="down"> | ||
</APPLET> | ||
<HR> | ||
|
||
<DL> | ||
<P><DL> | ||
<DT><H3>Public Methods</H3><DD><DT> | ||
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.1.1">AlphaFunc</A></B>() | ||
<DT> | ||
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.1.2">AlphaFunc</A></B>(const <!1><A HREF="AlphaFunc.html#DOC.2.1.2">AlphaFunc</A>& af, const <!1><A HREF="CopyOp.html">CopyOp</A>& copyop=CopyOp::SHALLOW_COPY) | ||
<DD><I>Copy constructor using CopyOp to manage deep vs shallow copy</I> | ||
<DT> | ||
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.1.3">META_StateAttribute</A></B>(<!1><A HREF="osg.html">osg</A>, <!1><A HREF="AlphaFunc.html">AlphaFunc</A>, <!1><A HREF="StateAttribute.html#DOC.2.175.6.5">ALPHAFUNC</A>) | ||
<DT> | ||
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual int <B><A HREF="#DOC.2.1.4">compare</A></B>(const <!1><A HREF="StateAttribute.html">StateAttribute</A>& sa) const | ||
<DD><I>return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs</I> | ||
<DT> | ||
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.1.5">getAssociatedModes</A></B>(std::vector<<!1><A HREF="StateAttribute.html#DOC.2.175.1">GLMode</A>>& modes) const | ||
<DT> | ||
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.1.7">setFunction</A></B>(<!1><A HREF="AlphaFunc.html#DOC.2.1.6">ComparisonFunction</A> func, float <!1><A HREF="Referenced.html#DOC.2.144.6">ref</A>) | ||
<DT> | ||
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="AlphaFunc.html#DOC.2.1.6">ComparisonFunction</A> <B><A HREF="#DOC.2.1.8">getFunction</A></B>() const | ||
<DT> | ||
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline float <B><A HREF="#DOC.2.1.9">getReferenceValue</A></B>() const | ||
<DT> | ||
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.1.10">apply</A></B>(<!1><A HREF="State.html">State</A>& state) const | ||
</DL></P> | ||
|
||
<P><DL> | ||
<DT><H3>Public Members</H3><DD><DT> | ||
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>enum <B><A HREF="#DOC.2.1.6">ComparisonFunction</A></B> | ||
</DL></P> | ||
|
||
<P><DL> | ||
<DT><H3>Protected Fields</H3><DD><DT> | ||
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="AlphaFunc.html#DOC.2.1.6">ComparisonFunction</A> <B><A HREF="#DOC.2.1.12">_comparisonFunc</A></B> | ||
<DT> | ||
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>float <B><A HREF="#DOC.2.1.13">_referenceValue</A></B> | ||
</DL></P> | ||
|
||
<P><DL> | ||
<DT><H3>Protected Methods</H3><DD><DT> | ||
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual <B><A HREF="#DOC.2.1.11">~AlphaFunc</A></B>() | ||
</DL></P> | ||
|
||
</DL> | ||
<HR><H3>Inherited from <A HREF="StateAttribute.html">StateAttribute</A>:</H3> | ||
<DL> | ||
<P><DL> | ||
<DT><H3>Public Methods</H3><DD><DT> | ||
<IMG ALT="o" SRC=icon2.gif>virtual <!1><A HREF="Object.html">Object</A>* <B>cloneType</B>() const | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>virtual <!1><A HREF="Object.html">Object</A>* <B>clone</B>(const <!1><A HREF="CopyOp.html">CopyOp</A>&) const | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>virtual bool <B>isSameKindAs</B>(const <!1><A HREF="Object.html">Object</A>* obj) const | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>virtual const char* <B>libraryName</B>() const | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>virtual const char* <B>className</B>() const | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>virtual <!1><A HREF="StateAttribute.html#DOC.2.175.5">Type</A> <B>getType</B>() const | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>virtual bool <B>isTextureAttribute</B>() const | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>bool <B>operator < </B>(const <!1><A HREF="StateAttribute.html">StateAttribute</A>& rhs) const | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>bool <B>operator == </B>(const <!1><A HREF="StateAttribute.html">StateAttribute</A>& rhs) const | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>bool <B>operator != </B>(const <!1><A HREF="StateAttribute.html">StateAttribute</A>& rhs) const | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>virtual void <B>compile</B>(<!1><A HREF="State.html">State</A>&) const | ||
</DL></P> | ||
|
||
<P><DL> | ||
<DT><H3>Public Members</H3><DD><DT> | ||
<IMG ALT="o" SRC=icon2.gif>typedef GLenum <B>GLMode</B> | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>typedef unsigned int <B>GLModeValue</B> | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>typedef unsigned int <B>OverrideValue</B> | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>enum <B>Values</B> | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>typedef unsigned int <B>Type</B> | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>enum <B>Types</B> | ||
</DL></P> | ||
|
||
</DL> | ||
<HR><H3>Inherited from <A HREF="Object.html">Object</A>:</H3> | ||
<DL> | ||
<P><DL> | ||
<DT><H3>Public Methods</H3><DD><DT> | ||
<IMG ALT="o" SRC=icon2.gif>inline void <B>setDataVariance</B>(<!1><A HREF="Object.html#DOC.2.117.8">DataVariance</A> dv) | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>inline <!1><A HREF="Object.html#DOC.2.117.8">DataVariance</A> <B>getDataVariance</B>() const | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>inline void <B>setUserData</B>(<!1><A HREF="Referenced.html">Referenced</A>* obj) | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>inline <!1><A HREF="Referenced.html">Referenced</A>* <B>getUserData</B>() | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>inline const <!1><A HREF="Referenced.html">Referenced</A>* <B>getUserData</B>() const | ||
</DL></P> | ||
|
||
<P><DL> | ||
<DT><H3>Public Members</H3><DD><DT> | ||
<IMG ALT="o" SRC=icon2.gif>enum <B>DataVariance</B> | ||
</DL></P> | ||
|
||
<P><DL> | ||
<DT><H3>Protected Fields</H3><DD><DT> | ||
<IMG ALT="o" SRC=icon2.gif><!1><A HREF="Object.html#DOC.2.117.8">DataVariance</A> <B>_dataVariance</B> | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif><!1><A HREF="ref_ptr.html">ref_ptr</A><<!1><A HREF="Referenced.html">Referenced</A>> <B>_userData</B> | ||
</DL></P> | ||
|
||
</DL> | ||
<HR><H3>Inherited from <A HREF="Referenced.html">Referenced</A>:</H3> | ||
<DL> | ||
<P><DL> | ||
<DT><H3>Public Methods</H3><DD><DT> | ||
<IMG ALT="o" SRC=icon2.gif>inline <!1><A HREF="Referenced.html">Referenced</A>& <B>operator = </B>(<!1><A HREF="Referenced.html">Referenced</A>&) | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>static void <B>setDeleteHandler</B>(<!1><A HREF="DeleteHandler.html">DeleteHandler</A>* handler) | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>static <!1><A HREF="DeleteHandler.html">DeleteHandler</A>* <B>getDeleteHandler</B>() | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>inline void <B>ref</B>() const | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>inline void <B>unref_nodelete</B>() const | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>inline int <B>referenceCount</B>() const | ||
<DT> | ||
<IMG ALT="o" SRC=icon2.gif>inline void <B>unref</B>() const | ||
</DL></P> | ||
|
||
<P><DL> | ||
<DT><H3>Protected Fields</H3><DD><DT> | ||
<IMG ALT="o" SRC=icon2.gif>mutable int <B>_refCount</B> | ||
</DL></P> | ||
|
||
</DL> | ||
|
||
<A NAME="DOC.DOCU"></A> | ||
<HR> | ||
<H2>Documentation</H2> | ||
<BLOCKQUOTE>Encapsulate OpenGL glAlphaFunc</BLOCKQUOTE> | ||
<DL> | ||
|
||
<A NAME="AlphaFunc"></A> | ||
<A NAME="DOC.2.1.1"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> AlphaFunc()</B></TT> | ||
<DL><DT><DD></DL><P> | ||
<A NAME="AlphaFunc"></A> | ||
<A NAME="DOC.2.1.2"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> AlphaFunc(const <!1><A HREF="AlphaFunc.html#DOC.2.1.2">AlphaFunc</A>& af, const <!1><A HREF="CopyOp.html">CopyOp</A>& copyop=CopyOp::SHALLOW_COPY)</B></TT> | ||
<DD>Copy constructor using CopyOp to manage deep vs shallow copy | ||
<DL><DT><DD></DL><P> | ||
<A NAME="META_StateAttribute"></A> | ||
<A NAME="DOC.2.1.3"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> META_StateAttribute(<!1><A HREF="osg.html">osg</A>, <!1><A HREF="AlphaFunc.html">AlphaFunc</A>, <!1><A HREF="StateAttribute.html#DOC.2.175.6.5">ALPHAFUNC</A>)</B></TT> | ||
<DL><DT><DD></DL><P> | ||
<A NAME="compare"></A> | ||
<A NAME="DOC.2.1.4"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual int compare(const <!1><A HREF="StateAttribute.html">StateAttribute</A>& sa) const </B></TT> | ||
<DD>return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs | ||
<DL><DT><DD></DL><P> | ||
<A NAME="getAssociatedModes"></A> | ||
<A NAME="DOC.2.1.5"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void getAssociatedModes(std::vector<<!1><A HREF="StateAttribute.html#DOC.2.175.1">GLMode</A>>& modes) const </B></TT> | ||
<DL><DT><DD></DL><P> | ||
<A NAME="ComparisonFunction"></A> | ||
<A NAME="DOC.2.1.6"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>enum ComparisonFunction</B></TT> | ||
<DL><DT><DD></DL><P><DL> | ||
|
||
<A NAME="NEVER"></A> | ||
<A NAME="DOC.2.1.6.1"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> NEVER</B></TT> | ||
<DL><DT><DD></DL><P> | ||
<A NAME="LESS"></A> | ||
<A NAME="DOC.2.1.6.2"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> LESS</B></TT> | ||
<DL><DT><DD></DL><P> | ||
<A NAME="EQUAL"></A> | ||
<A NAME="DOC.2.1.6.3"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> EQUAL</B></TT> | ||
<DL><DT><DD></DL><P> | ||
<A NAME="LEQUAL"></A> | ||
<A NAME="DOC.2.1.6.4"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> LEQUAL</B></TT> | ||
<DL><DT><DD></DL><P> | ||
<A NAME="GREATER"></A> | ||
<A NAME="DOC.2.1.6.5"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> GREATER</B></TT> | ||
<DL><DT><DD></DL><P> | ||
<A NAME="NOTEQUAL"></A> | ||
<A NAME="DOC.2.1.6.6"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> NOTEQUAL</B></TT> | ||
<DL><DT><DD></DL><P> | ||
<A NAME="GEQUAL"></A> | ||
<A NAME="DOC.2.1.6.7"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> GEQUAL</B></TT> | ||
<DL><DT><DD></DL><P> | ||
<A NAME="ALWAYS"></A> | ||
<A NAME="DOC.2.1.6.8"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ALWAYS</B></TT> | ||
<DL><DT><DD></DL><P></DL> | ||
|
||
<A NAME="setFunction"></A> | ||
<A NAME="DOC.2.1.7"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setFunction(<!1><A HREF="AlphaFunc.html#DOC.2.1.6">ComparisonFunction</A> func, float <!1><A HREF="Referenced.html#DOC.2.144.6">ref</A>)</B></TT> | ||
<DL><DT><DD></DL><P> | ||
<A NAME="getFunction"></A> | ||
<A NAME="DOC.2.1.8"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="AlphaFunc.html#DOC.2.1.6">ComparisonFunction</A> getFunction() const </B></TT> | ||
<DL><DT><DD></DL><P> | ||
<A NAME="getReferenceValue"></A> | ||
<A NAME="DOC.2.1.9"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline float getReferenceValue() const </B></TT> | ||
<DL><DT><DD></DL><P> | ||
<A NAME="apply"></A> | ||
<A NAME="DOC.2.1.10"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void apply(<!1><A HREF="State.html">State</A>& state) const </B></TT> | ||
<DL><DT><DD></DL><P> | ||
<A NAME="~AlphaFunc"></A> | ||
<A NAME="DOC.2.1.11"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual ~AlphaFunc()</B></TT> | ||
<DL><DT><DD></DL><P> | ||
<A NAME="_comparisonFunc"></A> | ||
<A NAME="DOC.2.1.12"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="AlphaFunc.html#DOC.2.1.6">ComparisonFunction</A> _comparisonFunc</B></TT> | ||
<DL><DT><DD></DL><P> | ||
<A NAME="_referenceValue"></A> | ||
<A NAME="DOC.2.1.13"></A> | ||
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>float _referenceValue</B></TT> | ||
<DL><DT><DD></DL><P></DL> | ||
|
||
<HR><DL><DT><B>This class has no child classes.</B></DL> | ||
|
||
<DL><DT><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I> <I><A HREF="HIER.html">HTML hierarchy of classes</A> or <A HREF="HIERjava.html">Java</A></I></P><HR> | ||
<BR> | ||
This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>. | ||
</BODY> | ||
</HTML> |
Oops, something went wrong.