>From 8370c13db769282bd50e118ecc34395e1869ea6d Mon Sep 17 00:00:00 2001
From: Magnus Kessler <[email protected]>
Date: Fri, 28 Oct 2011 09:59:52 +0100
Subject: [PATCH 08/12] Documentation fixes for osg::Image
---
include/osg/Image | 14 +++++++-------
1 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/include/osg/Image b/include/osg/Image
index febe090..3678ee9 100644
--- a/include/osg/Image
+++ b/include/osg/Image
@@ -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 :
--
1.7.3.4
>From 8370c13db769282bd50e118ecc34395e1869ea6d Mon Sep 17 00:00:00 2001
From: Magnus Kessler <[email protected]>
Date: Fri, 28 Oct 2011 09:59:52 +0100
Subject: [PATCH 08/12] Documentation fixes for osg::Image
---
include/osg/Image | 14 +++++++-------
1 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/include/osg/Image b/include/osg/Image
index febe090..3678ee9 100644
--- a/include/osg/Image
+++ b/include/osg/Image
@@ -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 :
--
1.7.3.4
_______________________________________________
osg-submissions mailing list
[email protected]
http://lists.openscenegraph.org/listinfo.cgi/osg-submissions-openscenegraph.org
