Improved the setContextID doxygen comment.
This commit is contained in:
parent
3979eb7755
commit
7b97a70c22
@ -140,15 +140,20 @@ class OSG_EXPORT State : public Referenced, public Observer
|
|||||||
|
|
||||||
|
|
||||||
/** Set the current OpenGL context uniqueID.
|
/** Set the current OpenGL context uniqueID.
|
||||||
Note, it is the application developers responsibility to
|
* The ContextID is used by classes like osg::StateAttribute's and osg::Drawable's to
|
||||||
set up unique ID for each OpenGL context. This value is
|
* help manage seperate OpenGL objects, such as display lists, vertex buffer objects
|
||||||
then used by osg::StateAttribute's and osg::Drawable's to
|
* and texture object for each graphics context. The ContextID simply acts as an index
|
||||||
help manage OpenGL display list and texture binds appropriate
|
* into arrays that these classes maintain for the purpose of storing GL object handles.
|
||||||
for each context, the contextID simply acts as an index in local
|
*
|
||||||
arrays that they maintain for the purpose.
|
* Note, osgViewer::GraphicsWindow will automatically set up the ContextID for you,
|
||||||
Typical settings for contextID are 0,1,2,3... up to the maximum
|
* so you will rearely need to set this yourself.
|
||||||
number of graphics contexts you have set up.
|
*
|
||||||
By default contextID is 0.*/
|
* The exceptions is when creating your own graphics context, where you should set
|
||||||
|
* the ContextID uniquely for each graphics context.
|
||||||
|
*
|
||||||
|
* Typical settings for ContextID are 0,1,2,3... up to the maximum
|
||||||
|
* number of graphics contexts you have set up. By default contextID is 0.
|
||||||
|
*/
|
||||||
inline void setContextID(unsigned int contextID) { _contextID=contextID; }
|
inline void setContextID(unsigned int contextID) { _contextID=contextID; }
|
||||||
|
|
||||||
/** Get the current OpenGL context unique ID.*/
|
/** Get the current OpenGL context unique ID.*/
|
||||||
|
Loading…
Reference in New Issue
Block a user