FGFS-4.1/OpenSceneGraph
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

From Magnus Kessler, typo and documentation fixes

Browse Source
This commit is contained in:
Robert Osfield
2012-03-29 15:08:15 +00:00
parent ba2432ca45
commit c0bd5cda99
12 changed files with 45 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
include/osg/Image
View File

@@ -236,7 +236,7 @@ class OSG_EXPORT Image : public BufferData
void setPacking(unsigned int packing) { _packing = packing; }
inline unsigned int getPacking() const { return _packing; }
/** return true of the pixel format is an OpenGL compressed pixel format.*/
/** Return true of the pixel format is an OpenGL compressed pixel format.*/
bool isCompressed() const;
/** Set the pixel aspect ratio, defined as the pixel width divided by the pixel height.*/
@@ -415,13 +415,13 @@ class OSG_EXPORT Image : public BufferData
/** Get the const PixelBufferObject.*/
const PixelBufferObject* getPixelBufferObject() const { return dynamic_cast<const PixelBufferObject*>(_bufferObject.get()); }
/** return whether the update(NodeVisitor* nv) should be required on each frame to enable proper working of osg::Image.*/
/** Return whether the update(NodeVisitor* nv) should be required on each frame to enable proper working of osg::Image.*/
virtual bool requiresUpdateCall() const { return false; }
/** update method for osg::Image subclasses that update themselves during the update traversal.*/
virtual void update(NodeVisitor* /*nv*/) {}
/** convience update callback class that can be attached to StateAttribute (such as Textures) to ensure
/** Convenience update callback class that can be attached to a StateAttribute (such as Textures) to ensure
* that the Image::update(NodeVisitor*) method is called during the update traversal. This callback
* is automatically attached when Image::requiresUpdateCall() is true (it's false by default.)
*/
@@ -430,16 +430,16 @@ class OSG_EXPORT Image : public BufferData
virtual void operator () (osg::StateAttribute* attr, osg::NodeVisitor* nv);
};
/** method for hinting whether to enable or disable focus to images acting as front ends to interactive surfaces such as a vnc or browser window. Return true if handled. */
/** Hint whether to enable or disable focus to images acting as front ends to interactive surfaces such as a vnc or browser window. Return true if handled. */
virtual bool sendFocusHint(bool /*focus*/) { return false; }
/** method for sending pointer events to images that are acting as front ends to interactive surfaces such as a vnc or browser window. Return true if handled. */
/** Send pointer events to images that are acting as front ends to interactive surfaces such as a vnc or browser window. Return true if handled. */
virtual bool sendPointerEvent(int /*x*/, int /*y*/, int /*buttonMask*/) { return false; }
/** method for sending key events to images that are acting as front ends to interactive surfaces such as a vnc or browser window. Return true if handled.*/
/** Send key events to images that are acting as front ends to interactive surfaces such as a vnc or browser window. Return true if handled.*/
virtual bool sendKeyEvent(int /*key*/, bool /*keyDown*/) { return false; }
/** method for passing frame information to the custom Image classes, to be called only when objects associated with imagery are not culled.*/
/** Pass frame information to the custom Image classes, to be called only when objects associated with imagery are not culled.*/
virtual void setFrameLastRendered(const osg::FrameStamp* /*frameStamp*/) {}
protected :