244 lines
10 KiB
HTML
244 lines
10 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||
|
|
|
||
|
|
<HTML>
|
||
|
|
<HEAD>
|
||
|
|
<TITLE>class SG_EXPORT osg::State</TITLE>
|
||
|
|
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.8">
|
||
|
|
</HEAD>
|
||
|
|
<BODY BGCOLOR="#ffffff">
|
||
|
|
|
||
|
|
<H2>class SG_EXPORT <A HREF="#DOC.DOCU">osg::State</A></H2></H2><BLOCKQUOTE>State class for managing a state stack.</BLOCKQUOTE>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<H2>Inheritance:</H2>
|
||
|
|
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=65>
|
||
|
|
<param name=classes value="CReferenced,MReferenced.html,CState,MState.html">
|
||
|
|
<param name=before value="M,M">
|
||
|
|
<param name=after value="Md_,M">
|
||
|
|
<param name=indent value="0,1">
|
||
|
|
<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.72.1">State</A></B>()
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual <B><A HREF="#DOC.2.72.2">~State</A></B>()
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.72.3">pushStateSet</A></B>(const <!1><A HREF="StateSet.html">StateSet</A>* dstate)
|
||
|
|
<DD><I>push stateset onto state stack</I>
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.72.4">popStateSet</A></B>()
|
||
|
|
<DD><I>pop drawstate off state stack</I>
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.72.5">reset</A></B>()
|
||
|
|
<DD><I>reset the state object to an empty stack</I>
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const bool <B><A HREF="#DOC.2.72.6">apply_mode</A></B>(const StateAttribute::GLMode mode, const bool enabled)
|
||
|
|
<DD><I>apply an OpenGL mode if required.</I>
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const bool <B><A HREF="#DOC.2.72.7">apply_attribute</A></B>(const <!1><A HREF="StateAttribute.html">StateAttribute</A>* attribute)
|
||
|
|
<DD><I>apply an attribute if required.</I>
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.72.8">apply</A></B>(const <!1><A HREF="StateSet.html">StateSet</A>* dstate)
|
||
|
|
<DD><I>apply stateset</I>
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.72.9">apply</A></B>()
|
||
|
|
<DD><I>apply the state</I>
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.72.10">have_applied</A></B>(const StateAttribute::GLMode mode, const StateAttribute::GLModeValue value)
|
||
|
|
<DD><I>mode has been set externally, update state to reflect this setting</I>
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.72.11">have_applied</A></B>(const <!1><A HREF="StateAttribute.html">StateAttribute</A>* attribute)
|
||
|
|
<DD><I>attribute has been applied externally, update state to reflect this setting</I>
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.72.12">setContextID</A></B>(unsigned int contextID)
|
||
|
|
<DD><I>Set the current OpenGL context uniqueID.</I>
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const unsigned int <B><A HREF="#DOC.2.72.13">getContextID</A></B>() const
|
||
|
|
<DD><I>Get the current OpenGL context unique ID</I>
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.72.14">setFrameNumber</A></B>(unsigned int fn)
|
||
|
|
<DD><I>Set the frame number</I>
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline unsigned int <B><A HREF="#DOC.2.72.15">getFrameNumber</A></B>() const
|
||
|
|
<DD><I>Get the frame number</I>
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.72.16">incrementFrameNumber</A></B>()
|
||
|
|
<DD><I>Increment the frame number.</I>
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.72.17">setFineGrainedErrorDetection</A></B>(const bool flag)
|
||
|
|
<DD><I>Set the hint to OpenGL routines to do fine grained OpenGL error checking</I>
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>const bool <B><A HREF="#DOC.2.72.18">getFineGrainedErrorDetection</A></B>() const
|
||
|
|
<DD><I>Get the hint to OpenGL routines to do fine grained OpenGL error checking</I>
|
||
|
|
</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>inline void <B>ref</B>() const
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="o" SRC=icon2.gif>inline void <B>unref</B>() const
|
||
|
|
<DT>
|
||
|
|
<IMG ALT="o" SRC=icon2.gif>inline const int <B>referenceCount</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>State class for managing a state stack.
|
||
|
|
Lazy state updating is used to minize state changes.</BLOCKQUOTE>
|
||
|
|
<DL>
|
||
|
|
|
||
|
|
<A NAME="State"></A>
|
||
|
|
<A NAME="DOC.2.72.1"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> State()</B></TT>
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="~State"></A>
|
||
|
|
<A NAME="DOC.2.72.2"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual ~State()</B></TT>
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="pushStateSet"></A>
|
||
|
|
<A NAME="DOC.2.72.3"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void pushStateSet(const <!1><A HREF="StateSet.html">StateSet</A>* dstate)</B></TT>
|
||
|
|
<DD>push stateset onto state stack
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="popStateSet"></A>
|
||
|
|
<A NAME="DOC.2.72.4"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void popStateSet()</B></TT>
|
||
|
|
<DD>pop drawstate off state stack
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="reset"></A>
|
||
|
|
<A NAME="DOC.2.72.5"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void reset()</B></TT>
|
||
|
|
<DD>reset the state object to an empty stack
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="apply_mode"></A>
|
||
|
|
<A NAME="DOC.2.72.6"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const bool apply_mode(const StateAttribute::GLMode mode, const bool enabled)</B></TT>
|
||
|
|
<DD>apply an OpenGL mode if required.
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="apply_attribute"></A>
|
||
|
|
<A NAME="DOC.2.72.7"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const bool apply_attribute(const <!1><A HREF="StateAttribute.html">StateAttribute</A>* attribute)</B></TT>
|
||
|
|
<DD>apply an attribute if required.
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="apply"></A>
|
||
|
|
<A NAME="DOC.2.72.8"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void apply(const <!1><A HREF="StateSet.html">StateSet</A>* dstate)</B></TT>
|
||
|
|
<DD>apply stateset
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="apply"></A>
|
||
|
|
<A NAME="DOC.2.72.9"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void apply()</B></TT>
|
||
|
|
<DD>apply the state
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="have_applied"></A>
|
||
|
|
<A NAME="DOC.2.72.10"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void have_applied(const StateAttribute::GLMode mode, const StateAttribute::GLModeValue value)</B></TT>
|
||
|
|
<DD>mode has been set externally, update state to reflect this setting
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="have_applied"></A>
|
||
|
|
<A NAME="DOC.2.72.11"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void have_applied(const <!1><A HREF="StateAttribute.html">StateAttribute</A>* attribute)</B></TT>
|
||
|
|
<DD>attribute has been applied externally, update state to reflect this setting
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="setContextID"></A>
|
||
|
|
<A NAME="DOC.2.72.12"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setContextID(unsigned int contextID)</B></TT>
|
||
|
|
<DD>Set the current OpenGL context uniqueID.
|
||
|
|
Note, it is the application developers responsiblity to
|
||
|
|
set up unique ID for each OpenGL context. This value is
|
||
|
|
then used by osg::StateAttribure's and osg::Drawable's to
|
||
|
|
help manage OpenGL display list and texture binds appropriate
|
||
|
|
for each context.
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="getContextID"></A>
|
||
|
|
<A NAME="DOC.2.72.13"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const unsigned int getContextID() const </B></TT>
|
||
|
|
<DD>Get the current OpenGL context unique ID
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="setFrameNumber"></A>
|
||
|
|
<A NAME="DOC.2.72.14"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setFrameNumber(unsigned int fn)</B></TT>
|
||
|
|
<DD>Set the frame number
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="getFrameNumber"></A>
|
||
|
|
<A NAME="DOC.2.72.15"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline unsigned int getFrameNumber() const </B></TT>
|
||
|
|
<DD>Get the frame number
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="incrementFrameNumber"></A>
|
||
|
|
<A NAME="DOC.2.72.16"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void incrementFrameNumber()</B></TT>
|
||
|
|
<DD>Increment the frame number. Done once per frame.
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="setFineGrainedErrorDetection"></A>
|
||
|
|
<A NAME="DOC.2.72.17"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setFineGrainedErrorDetection(const bool flag)</B></TT>
|
||
|
|
<DD>Set the hint to OpenGL routines to do fine grained OpenGL error checking
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="getFineGrainedErrorDetection"></A>
|
||
|
|
<A NAME="DOC.2.72.18"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>const bool getFineGrainedErrorDetection() const </B></TT>
|
||
|
|
<DD>Get the hint to OpenGL routines to do fine grained OpenGL error checking
|
||
|
|
<DL><DT><DD></DL><P><DL>
|
||
|
|
|
||
|
|
<A NAME="ModeStack"></A>
|
||
|
|
<A NAME="DOC.2.72.21.1"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ModeStack()</B></TT>
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="changed"></A>
|
||
|
|
<A NAME="DOC.2.72.21.2"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>bool changed</B></TT>
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="last_applied_value"></A>
|
||
|
|
<A NAME="DOC.2.72.21.3"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>bool last_applied_value</B></TT>
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="valueVec"></A>
|
||
|
|
<A NAME="DOC.2.72.21.4"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>ValueVec valueVec</B></TT>
|
||
|
|
<DL><DT><DD></DL><P></DL>
|
||
|
|
<DL>
|
||
|
|
|
||
|
|
<A NAME="AttributeStack"></A>
|
||
|
|
<A NAME="DOC.2.72.22.1"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> AttributeStack()</B></TT>
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="changed"></A>
|
||
|
|
<A NAME="DOC.2.72.22.2"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>bool changed</B></TT>
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="last_applied_attribute"></A>
|
||
|
|
<A NAME="DOC.2.72.22.3"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>const <!1><A HREF="StateAttribute.html">StateAttribute</A>* last_applied_attribute</B></TT>
|
||
|
|
<DL><DT><DD></DL><P>
|
||
|
|
<A NAME="attributeVec"></A>
|
||
|
|
<A NAME="DOC.2.72.22.4"></A>
|
||
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>AttributeVec attributeVec</B></TT>
|
||
|
|
<DL><DT><DD></DL><P></DL>
|
||
|
|
</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>
|