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

From Jannik Heller, typo fixes

Browse Source 
git-svn-id: http://svn.openscenegraph.org/osg/OpenSceneGraph/trunk@14826 16af8721-9629-0410-8352-f15c8da7e697
This commit is contained in:
Robert Osfield
2015-04-07 18:01:12 +00:00
parent ab2fc1be76
commit 70b5297575
62 changed files with 104 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
include/osg/Array
View File

@@ -212,10 +212,10 @@ class OSG_EXPORT Array : public BufferData
bool _preserveDataType;
};
/** convinience function for getting the binding of array via a ptr that may be null.*/
/** convenience function for getting the binding of array via a ptr that may be null.*/
inline osg::Array::Binding getBinding(const osg::Array* array) { return array ? array->getBinding() : osg::Array::BIND_OFF; }
/** convinience function for getting the binding of array via a ptr that may be null.*/
/** convenience function for getting the binding of array via a ptr that may be null.*/
inline bool getNormalize(const osg::Array* array) { return array ? array->getNormalize() : false; }

4
include/osg/Callback
View File

@@ -120,7 +120,7 @@ public:
};
/** Convinience function for getting the CallbackObject associated with specificed name from an Object's UserDataContainer.*/
/** Convenience function for getting the CallbackObject associated with specificed name from an Object's UserDataContainer.*/
inline CallbackObject* getCallbackObject(osg::Object* object, const std::string& name)
{
osg::UserDataContainer* udc = object->getUserDataContainer();
@@ -128,7 +128,7 @@ inline CallbackObject* getCallbackObject(osg::Object* object, const std::string&
}
/** Convinience function for getting the CallbackObject associated with specificed name from an Object's UserDataContainer.*/
/** Convenience function for getting the CallbackObject associated with specificed name from an Object's UserDataContainer.*/
inline const CallbackObject* getCallbackObject(const osg::Object* object, const std::string& name)
{
const osg::UserDataContainer* udc = object->getUserDataContainer();

22
include/osg/Camera
View File

@@ -66,7 +66,7 @@ class OSG_EXPORT Camera : public Transform, public CullSettings
const View* getView() const { return _view; }
/** Set the Stats object used for collect various frame related
/** Set the Stats object used to collect various frame related
* timing and scene graph stats. */
void setStats(osg::Stats* stats) { _stats = stats; }
@@ -309,14 +309,14 @@ class OSG_EXPORT Camera : public Transform, public CullSettings
/** Set the draw buffer used at the start of each frame draw.
* Note, a buffer value of GL_NONE is used to sepecify that the rendering back-end should choose the most appropriate buffer.*/
* Note, a buffer value of GL_NONE is used to specify that the rendering back-end should choose the most appropriate buffer.*/
void setDrawBuffer(GLenum buffer) { _drawBuffer = buffer; applyMaskAction( DRAW_BUFFER ); }
/** Get the draw buffer used at the start of each frame draw. */
GLenum getDrawBuffer() const { return _drawBuffer; }
/** Set the read buffer for any required copy operations to use.
* Note, a buffer value of GL_NONE is used to sepecify that the rendering back-end should choose the most appropriate buffer.*/
* Note, a buffer value of GL_NONE is used to specify that the rendering back-end should choose the most appropriate buffer.*/
void setReadBuffer(GLenum buffer) { _readBuffer = buffer; applyMaskAction( READ_BUFFER ); }
/** Get the read buffer for any required copy operations to use. */
@@ -447,23 +447,23 @@ class OSG_EXPORT Camera : public Transform, public CullSettings
Implicit buffers are automatically substituted when user have not attached such buffer.
Camera may set up two FBOs: primary Render FBO and secondary Resolve FBO for multisample usage.
So in practive we have two masks defined for the Camera:
So in practice we have two masks defined for the Camera:
implicitBufferAttachmentRenderMask
implicitBufferAttachmentResolveMask
They can be set together by setImplicitBufferAttachmentMask method, or separately
by setImplicitBufferAttachmentRenderMask and setImplicitBufferAttachmentResolveMask.
Camera defaults are USE_DISPLAY_SETTINGS_MASK which means that by default
Camera chooses to substitue buffer attachments as defined by DisplaySettings.
Camera chooses to substitute buffer attachments as defined by DisplaySettings.
Usually DisplaySettings implicit buffer attachment selection defaults to: DEPTH and COLOR
for both primary (Render) FBO and seconday Multisample (Resolve) FBO
ie: IMPLICT_DEPTH_BUFFER_ATTACHMENT | IMPLICIT_COLOR_BUFFER_ATTACHMENT
ie: IMPLICIT_DEPTH_BUFFER_ATTACHMENT | IMPLICIT_COLOR_BUFFER_ATTACHMENT
If these masks are not changed and user did not attach depth buffer and/or color buffer
to Camera, then OSG implicitly substitues these buffers.
to Camera, then OSG implicitly substitutes these buffers.
By default it does not implicitly allocate a stencil buffer.
Use implicti buffer attachment masks to override default behavior:
Use implicit buffer attachment masks to override default behavior:
to turn off DEPTH or COLOR buffer substitution or to enforce STENCIL buffer substitution.
Note that both values are ignored if not using FBO.
@@ -496,7 +496,7 @@ class OSG_EXPORT Camera : public Transform, public CullSettings
}
/**
Get mask selecting implict buffer attachments for Camera primary FBO
Get mask selecting implicit buffer attachments for Camera primary FBO
if effectiveMask parameter is set, method follows USE_DISPLAY_SETTINGS_MASK dependence and returns effective mask
if effectiveMask parameter is reset, method returns nominal mask set by the Camera
*/
@@ -514,7 +514,7 @@ class OSG_EXPORT Camera : public Transform, public CullSettings
}
/**
Get mask selecting implict buffer attachments for Camera secondary MULTISAMPLE FBO
Get mask selecting implicit buffer attachments for Camera secondary MULTISAMPLE FBO
if effectiveMask parameter is set, method follows USE_DISPLAY_SETTINGS_MASK dependence and returns effective mask
if effectiveMask parameter is reset, method returns nominal mask set by the Camera
*/
@@ -710,7 +710,7 @@ class OSG_EXPORT Camera : public Transform, public CullSettings
};
/** Functor to assist with ordering camers in the order they should be rendered in.*/
/** Functor to assist with ordering cameras in the order they should be rendered in.*/
struct CameraRenderOrderSortOp
{
inline bool operator() (const Camera* lhs,const Camera* rhs) const

2
include/osg/CullSettings
View File

@@ -218,7 +218,7 @@ class OSG_EXPORT CullSettings
float getLODScale() const { return _LODScale; }
/** Threshold at which small features are culled.
\param value Boulding volume size in screen space. Default is 2.0. */
\param value Bounding volume size in screen space. Default is 2.0. */
void setSmallFeatureCullingPixelSize(float value) { _smallFeatureCullingPixelSize=value; applyMaskAction(SMALL_FEATURE_CULLING_PIXEL_SIZE); }
/** Get the Small Feature Culling Pixel Size.*/

2
include/osg/CullingSet
View File

@@ -162,7 +162,7 @@ class OSG_EXPORT CullingSet : public Referenced
const Vec4& getPixelSizeVector() const { return _pixelSizeVector; }
/** Threshold at which small features are culled.
\param value Boulding volume size in screen space. Default is 2.0. */
\param value Bounding volume size in screen space. Default is 2.0. */
void setSmallFeatureCullingPixelSize(float value) { _smallFeatureCullingPixelSize=value; }
float& getSmallFeatureCullingPixelSize() { return _smallFeatureCullingPixelSize; }

8
include/osg/DisplaySettings
View File

@@ -217,8 +217,8 @@ class OSG_EXPORT DisplaySettings : public osg::Referenced
For more info: See description of Camera::setImplicitBufferAttachment method
DisplaySettings implicit buffer attachment selection defaults to: DEPTH and COLOR
for both primary (Render) FBO and seconday Multisample (Resolve) FBO
ie: IMPLICT_DEPTH_BUFFER_ATTACHMENT | IMPLICIT_COLOR_BUFFER_ATTACHMENT
for both primary (Render) FBO and secondary Multisample (Resolve) FBO
ie: IMPLICIT_DEPTH_BUFFER_ATTACHMENT | IMPLICIT_COLOR_BUFFER_ATTACHMENT
**/
enum ImplicitBufferAttachment
{
@@ -246,10 +246,10 @@ class OSG_EXPORT DisplaySettings : public osg::Referenced
_implicitBufferAttachmentResolveMask = implicitBufferAttachmentResolveMask;
}
/** Get mask selecting default implict buffer attachments for Cameras primary FBOs. */
/** Get mask selecting default implicit buffer attachments for Cameras primary FBOs. */
ImplicitBufferAttachmentMask getImplicitBufferAttachmentRenderMask() const { return _implicitBufferAttachmentRenderMask; }
/** Get mask selecting default implict buffer attachments for Cameras secondary MULTISAMPLE FBOs. */
/** Get mask selecting default implicit buffer attachments for Cameras secondary MULTISAMPLE FBOs. */
ImplicitBufferAttachmentMask getImplicitBufferAttachmentResolveMask() const { return _implicitBufferAttachmentResolveMask;}
enum SwapMethod

4
include/osg/GLU
View File

@@ -70,10 +70,10 @@ extern OSG_EXPORT GLint gluBuild2DMipmaps (GLenum target, GLint internalFormat,
typedef void (GL_APIENTRY * GLTexImage3DProc) ( GLenum target, GLint level, GLenum internalFormat, GLsizei width, GLsizei height, GLsizei depth, GLint border, GLenum format, GLenum type, const GLvoid *pixels);
/** Small variation on normal gluBuild3DMipmapLevels as we pass in the function pointer to glTexImage3D rather than rely on GLU style querry for this functon pointer.*/
/** Small variation on normal gluBuild3DMipmapLevels as we pass in the function pointer to glTexImage3D rather than rely on GLU style query for this function pointer.*/
extern OSG_EXPORT GLint gluBuild3DMipmapLevels (GLTexImage3DProc glTextImage3DProc, GLenum target, GLint internalFormat, GLsizei width, GLsizei height, GLsizei depth, GLenum format, GLenum type, GLint level, GLint base, GLint max, const void *data);
/** Small variation on normal gluBuild3DMipmapLevels as we pass in the function pointer to glTexImage3D rather than rely on GLU style querry for this functon pointer.*/
/** Small variation on normal gluBuild3DMipmapLevels as we pass in the function pointer to glTexImage3D rather than rely on GLU style query for this function pointer.*/
extern OSG_EXPORT GLint gluBuild3DMipmaps (GLTexImage3DProc glTextImage3DProc, GLenum target, GLint internalFormat, GLsizei width, GLsizei height, GLsizei depth, GLenum format, GLenum type, const void *data);
/* ErrorCode */

2
include/osg/GraphicsContext
View File

@@ -421,7 +421,7 @@ class OSG_EXPORT GraphicsContext : public Object
/** Get the const swap callback which overrides the GraphicsContext::swapBuffersImplementation().*/
const SwapCallback* getSwapCallback() const { return _swapCallback.get(); }
/** convinience method for handling whether to call swapbuffers callback or the standard context swapBuffersImplementation.
/** Convenience method for handling whether to call swapbuffers callback or the standard context swapBuffersImplementation.
* swapBuffersCallbackOrImplemenation() is called by swapBuffers() and osg::SwapBuffersOperation, end users should normally
* call swapBuffers() rather than swapBuffersCallbackOrImplemenation(). */
void swapBuffersCallbackOrImplemenation()

2
include/osg/Image
View File

@@ -388,7 +388,7 @@ class OSG_EXPORT Image : public BufferData
/** Flip the image vertically, around t dimension. */
void flipVertical();
/** Flip the image around the r dimension. Only relevent for 3D textures. */
/** Flip the image around the r dimension. Only relevant for 3D textures. */
void flipDepth();
/** Ensure image dimensions are a power of two.

2
include/osg/ImageUtils
View File

@@ -69,7 +69,7 @@ void readImage(const osg::Image* image, O& operation)
}
}
/** Convinience method for making it easy to cast all pixel channels types to a unit float RGBA form.*/
/** Convenience method for making it easy to cast all pixel channels types to a unit float RGBA form.*/
struct CastAndScaleToFloatOperation
{
float cast(char v) { return static_cast<float>(v)*(1.0f/128.0f); }

6
include/osg/Object
View File

@@ -137,7 +137,7 @@ class OSG_EXPORT Object : public Referenced
/** get the const UserDataContainer attached to this object.*/
const osg::UserDataContainer* getUserDataContainer() const { return _userDataContainer; }
/** Convinience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns
/** Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns
* a DefaultUserDataContainer to the Object and then return this new UserDataContainer.*/
osg::UserDataContainer* getOrCreateUserDataContainer();
@@ -158,12 +158,12 @@ class OSG_EXPORT Object : public Referenced
/** Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
/** Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
* To use this template method you need to include the osg/ValueObject header.*/
template<typename T>
bool getUserValue(const std::string& name, T& value) const;
/** Convinience method that creates the osg::TemplateValueObject<T> to store the
/** Convenience method that creates the osg::TemplateValueObject<T> to store the
* specified value and adds it as a named UserObject.
* To use this template method you need to include the osg/ValueObject header. */
template<typename T>

2
include/osg/State
View File

@@ -200,7 +200,7 @@ class OSG_EXPORT State : public Referenced
/** Get the unform list in which to inject any uniforms that StateAttribute::apply(State&) methods provide.*/
StateSet::UniformList& getCurrentShaderCompositionUniformList() { return _currentShaderCompositionUniformList; }
/** Convinience method for StateAttribute:::apply(State&) methods to pass on their uniforms to osg::State so it can apply them at the appropriate point.*/
/** Convenience method for StateAttribute:::apply(State&) methods to pass on their uniforms to osg::State so it can apply them at the appropriate point.*/
void applyShaderCompositionUniform(const osg::Uniform* uniform, StateAttribute::OverrideValue value=StateAttribute::ON)
{
StateSet::RefUniformPair& up = _currentShaderCompositionUniformList[uniform->getName()];

4
include/osg/UserDataContainer
View File

@@ -188,14 +188,14 @@ protected:
};
/** Convinience function for getting the User Object associated with specificed name from an Object's UserDataContainer.*/
/** Convenience function for getting the User Object associated with specificed name from an Object's UserDataContainer.*/
inline Object* getUserObject(osg::Object* object, const std::string& name)
{
osg::UserDataContainer* udc = object->getUserDataContainer();
return udc ? udc->getUserObject(name) : 0;
}
/** Convinience function for getting the User Object associated with specificed name from an Object's UserDataContainer.*/
/** Convenience function for getting the User Object associated with specificed name from an Object's UserDataContainer.*/
inline const Object* getUserObject(const osg::Object* object, const std::string& name)
{
const osg::UserDataContainer* udc = object->getUserDataContainer();

2
include/osg/View
View File

@@ -40,7 +40,7 @@ class OSG_EXPORT View : public virtual osg::Object
virtual void take(View& rhs);
/** Set the Stats object used for collect various frame related timing and scene graph stats.*/
/** Set the Stats object used to collect various frame related timing and scene graph stats.*/
void setStats(osg::Stats* stats) { _stats = stats; }
/** Get the Viewers Stats object.*/