Commit d439c11f authored by cutealien's avatar cutealien

Unify spelling in documentation (color, behavior).


git-svn-id: svn://svn.code.sf.net/p/irrlicht/code/trunk@4252 dfc29bdd-3216-0410-991c-e03cc46cb475
parent b52a040f
This diff is collapsed.
......@@ -81,7 +81,7 @@ namespace gui
//! platform specific behavior flags for the cursor
enum ECURSOR_PLATFORM_BEHAVIOR
{
//! default - no platform specific behaviour
//! default - no platform specific behavior
ECPB_NONE = 0,
//! On X11 try caching cursor updates as XQueryPointer calls can be expensive.
......
......@@ -53,7 +53,7 @@ namespace irr
/** This is not used by Irrlicht and can be used to send user
specific data though the system. The Irrlicht 'window handle'
can be obtained from IrrlichtDevice::getExposedVideoData()
The usage and behaviour depends on the operating system:
The usage and behavior depends on the operating system:
Windows: send a WM_USER message to the Irrlicht Window; the
wParam and lParam will be used to populate the
UserData1 and UserData2 members of the SUserEvent.
......@@ -248,8 +248,8 @@ namespace irr
//! A tree view node was collapsed. See IGUITreeView::getLastEventNode().
EGET_TREEVIEW_NODE_COLLAPSE,
//! deprecated - use EGET_TREEVIEW_NODE_COLLAPSE instead. This
//! may be removed by Irrlicht 1.9
//! deprecated - use EGET_TREEVIEW_NODE_COLLAPSE instead. This
//! may be removed by Irrlicht 1.9
EGET_TREEVIEW_NODE_COLLAPS = EGET_TREEVIEW_NODE_COLLAPSE,
//! No real event. Just for convenience to get number of events
......
......@@ -11,7 +11,7 @@ namespace irr
{
namespace gui
{
//! Close behaviour.
//! Close behavior.
//! Default is ECMC_REMOVE
enum ECONTEXT_MENU_CLOSE
{
......@@ -40,10 +40,10 @@ namespace gui
IGUIContextMenu(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
: IGUIElement(EGUIET_CONTEXT_MENU, environment, parent, id, rectangle) {}
//! set behaviour when menus are closed
//! set behavior when menus are closed
virtual void setCloseHandling(ECONTEXT_MENU_CLOSE onClose) = 0;
//! get current behaviour when the menu will be closed
//! get current behavior when the menu will be closed
virtual ECONTEXT_MENU_CLOSE getCloseHandling() const = 0;
//! Get amount of menu items
......
......@@ -71,7 +71,7 @@ public:
/**
\param texture The texture to apply to the terrain.
\param heightmap An image that will be interpreted as a heightmap. The
brightness (average colour) of each pixel is interpreted as a height,
brightness (average color) of each pixel is interpreted as a height,
with a 255 brightness pixel producing the maximum height.
\param stretchSize The size that each pixel will produce, i.e. a
512x512 heightmap
......
......@@ -856,9 +856,9 @@ namespace scene
\param vertexColor: The default color of all the vertices. If no texture is associated
with the scene node, then all vertices will be this color. Defaults to white.
\param maxLOD: The maximum LOD (level of detail) for the node. Only change if you
know what you are doing, this might lead to strange behaviour.
know what you are doing, this might lead to strange behavior.
\param patchSize: patch size of the terrain. Only change if you
know what you are doing, this might lead to strange behaviour.
know what you are doing, this might lead to strange behavior.
\param smoothFactor: The number of times the vertices are smoothed.
\param addAlsoIfHeightmapEmpty: Add terrain node even with empty heightmap.
\return Pointer to the created scene node. Can be null
......@@ -894,9 +894,9 @@ namespace scene
\param vertexColor: The default color of all the vertices. If no texture is associated
with the scene node, then all vertices will be this color. Defaults to white.
\param maxLOD: The maximum LOD (level of detail) for the node. Only change if you
know what you are doing, this might lead to strange behaviour.
know what you are doing, this might lead to strange behavior.
\param patchSize: patch size of the terrain. Only change if you
know what you are doing, this might lead to strange behaviour.
know what you are doing, this might lead to strange behavior.
\param smoothFactor: The number of times the vertices are smoothed.
\param addAlsoIfHeightmapEmpty: Add terrain node even with empty heightmap.
\return Pointer to the created scene node. Can be null
......@@ -1603,7 +1603,7 @@ namespace scene
//! Register a custom callbacks manager which gets callbacks during scene rendering.
/** \param[in] lightManager: the new callbacks manager. You may pass 0 to remove the
current callbacks manager and restore the default behaviour. */
current callbacks manager and restore the default behavior. */
virtual void setLightManager(ILightManager* lightManager) = 0;
//! Get an instance of a geometry creator.
......
......@@ -517,8 +517,8 @@ namespace video
position of a pixel instead a color value.
\param zeroTexels \deprecated If set to true, then any texels that match
the color key will have their color, as well as their alpha, set to zero
(i.e. black). This behaviour matches the legacy (buggy) behaviour prior
to release 1.5 and is provided for backwards compatibility only.
(i.e. black). This behavior matches the legacy (buggy) behavior prior
to release 1.5 and is provided for backwards compatibility only.
This parameter may be removed by Irrlicht 1.9. */
virtual void makeColorKeyTexture(video::ITexture* texture,
video::SColor color,
......@@ -534,7 +534,7 @@ namespace video
described above.
\param zeroTexels \deprecated If set to true, then any texels that match
the color key will have their color, as well as their alpha, set to zero
(i.e. black). This behaviour matches the legacy (buggy) behaviour prior
(i.e. black). This behavior matches the legacy (buggy) behavior prior
to release 1.5 and is provided for backwards compatibility only.
This parameter may be removed by Irrlicht 1.9. */
virtual void makeColorKeyTexture(video::ITexture* texture,
......
......@@ -31,7 +31,7 @@ namespace scene
//! Sets the number of segments across the U axis
virtual void setSubDivideU(const u32 inU) =0;
//! Sets the number of segments across the V axis
virtual void setSubDivideV(const u32 inV) =0;
......@@ -42,10 +42,10 @@ namespace scene
virtual u32 getSubDivideV() const =0;
//! Sets the color of the base of the light
virtual void setFootColor(const video::SColor inColour) =0;
virtual void setFootColor(const video::SColor inColor) =0;
//! Sets the color of the tip of the light
virtual void setTailColor(const video::SColor inColour) =0;
virtual void setTailColor(const video::SColor inColor) =0;
//! Returns the color of the base of the light
virtual video::SColor getFootColor() const =0;
......
......@@ -9,7 +9,7 @@
\brief Header file containing all scene parameters for modifying mesh loading etc.
This file includes all parameter names which can be set using ISceneManager::getParameters()
to modify the behaviour of plugins and mesh loaders.
to modify the behavior of plugins and mesh loaders.
*/
namespace irr
......
......@@ -704,7 +704,7 @@ class map
Node* newNodesUncle = newNode->getParent()->getParent()->getRightChild();
if ( newNodesUncle!=0 && newNodesUncle->isRed())
{
// case 1 - change the colours
// case 1 - change the colors
newNode->getParent()->setBlack();
newNodesUncle->setBlack();
newNode->getParent()->getParent()->setRed();
......@@ -733,7 +733,7 @@ class map
Node* newNodesUncle = newNode->getParent()->getParent()->getLeftChild();
if ( newNodesUncle!=0 && newNodesUncle->isRed())
{
// case 1 - change the colours
// case 1 - change the colors
newNode->getParent()->setBlack();
newNodesUncle->setBlack();
newNode->getParent()->getParent()->setRed();
......@@ -890,7 +890,7 @@ class map
return Root == 0;
}
//! \deprecated Use empty() instead. This method may be removed by Irrlicht 1.9
//! \deprecated Use empty() instead. This method may be removed by Irrlicht 1.9
_IRR_DEPRECATED_ bool isEmpty() const
{
return empty();
......
......@@ -274,7 +274,7 @@ IAnimatedMesh* CDMFLoader::createMesh(io::IReadFile* file)
findFile(use_mat_dirs, path, materiali[i].pathName, materiali[i].textureName);
tex = driver->getTexture(materiali[i].textureName);
}
//Primary texture is just a colour
//Primary texture is just a color
else if(materiali[i].textureFlag==1)
{
video::SColor color(axtoi(materiali[i].textureName.c_str()));
......
......@@ -51,13 +51,13 @@ CGUIContextMenu::~CGUIContextMenu()
LastFont->drop();
}
//! set behaviour when menus are closed
//! set behavior when menus are closed
void CGUIContextMenu::setCloseHandling(ECONTEXT_MENU_CLOSE onClose)
{
CloseHandling = onClose;
}
//! get current behaviour when the menue will be closed
//! get current behavior when the menue will be closed
ECONTEXT_MENU_CLOSE CGUIContextMenu::getCloseHandling() const
{
return CloseHandling;
......
......@@ -31,10 +31,10 @@ namespace gui
//! destructor
virtual ~CGUIContextMenu();
//! set behaviour when menus are closed
//! set behavior when menus are closed
virtual void setCloseHandling(ECONTEXT_MENU_CLOSE onClose);
//! get current behaviour when the menue will be closed
//! get current behavior when the menue will be closed
virtual ECONTEXT_MENU_CLOSE getCloseHandling() const;
//! Returns amount of menu items
......
......@@ -1120,7 +1120,7 @@ void CGUIEditBox::breakText()
{
// TODO: I (Michael) think that we shouldn't change the text given by the user for whatever reason.
// Instead rework the cursor positioning to be able to handle this (but not in stable release
// branch as users might already expect this behaviour).
// branch as users might already expect this behavior).
Text.erase(i+1);
--size;
if ( CursorPos > i )
......
......@@ -39,7 +39,7 @@ namespace gui
virtual void updateAbsolutePosition();
//! Modalscreen is not a typical element, but rather acts like a state for it's children.
//! isVisible is overriden to give this a useful behaviour, so that a modal will no longer
//! isVisible is overriden to give this a useful behavior, so that a modal will no longer
//! be active when its parent is invisible or all its children are invisible.
virtual bool isVisible() const;
......
......@@ -402,7 +402,7 @@ bool CIrrDeviceStub::getGammaRamp( f32 &red, f32 &green, f32 &blue, f32 &brightn
return false;
}
//! Set the maximal elapsed time between 2 clicks to generate doubleclicks for the mouse. It also affects tripleclick behaviour.
//! Set the maximal elapsed time between 2 clicks to generate doubleclicks for the mouse. It also affects tripleclick behavior.
void CIrrDeviceStub::setDoubleClickTime( u32 timeMs )
{
MouseMultiClicks.DoubleClickTime = timeMs;
......
......@@ -125,7 +125,7 @@ namespace irr
//! Get the current Gamma Value for the Display
virtual bool getGammaRamp( f32 &red, f32 &green, f32 &blue, f32 &brightness, f32 &contrast );
//! Set the maximal elapsed time between 2 clicks to generate doubleclicks for the mouse. It also affects tripleclick behaviour.
//! Set the maximal elapsed time between 2 clicks to generate doubleclicks for the mouse. It also affects tripleclick behavior.
//! When set to 0 no double- and tripleclicks will be generated.
virtual void setDoubleClickTime( u32 timeMs );
......
......@@ -331,7 +331,7 @@ bool CMD2MeshFileLoader::loadFile(io::IReadFile* file, CAnimatedMeshMD2* mesh)
}
}
// populate interpolation buffer with texture coordinates and colours
// populate interpolation buffer with texture coordinates and colors
if (header.numFrames)
{
f32 dmaxs = 1.0f/(header.skinWidth);
......
......@@ -1017,7 +1017,7 @@ void CNullDriver::makeColorKeyTexture(video::ITexture* texture,
for (u32 pixel = 0; pixel < pixels; ++ pixel)
{
// If the colour matches the reference colour, ignoring alphas,
// If the color matches the reference color, ignoring alphas,
// set the alpha to zero.
if(((*p) & 0x7fff) == refZeroAlpha)
{
......@@ -1051,7 +1051,7 @@ void CNullDriver::makeColorKeyTexture(video::ITexture* texture,
const u32 pixels = pitch * dim.Height;
for (u32 pixel = 0; pixel < pixels; ++ pixel)
{
// If the colour matches the reference colour, ignoring alphas,
// If the color matches the reference color, ignoring alphas,
// set the alpha to zero.
if(((*p) & 0x00ffffff) == refZeroAlpha)
{
......
......@@ -187,7 +187,7 @@ IAnimatedMesh* COBJMeshFileLoader::createMesh(io::IReadFile* file)
{
c8 vertexWord[WORD_BUFFER_LENGTH]; // for retrieving vertex data
video::S3DVertex v;
// Assign vertex color from currently active material's diffuse colour
// Assign vertex color from currently active material's diffuse color
if (mtlChanged)
{
// retrieve the material
......@@ -468,8 +468,8 @@ const c8* COBJMeshFileLoader::readTextures(const c8* bufPtr, const c8* const buf
// currMaterial->Meshbuffer->Material.Textures[1] = texture;
// currMaterial->Meshbuffer->Material.MaterialType=video::EMT_REFLECTION_2_LAYER;
}
// Set diffuse material colour to white so as not to affect texture colour
// Because Maya set diffuse colour Kd to black when you use a diffuse colour map
// Set diffuse material color to white so as not to affect texture color
// Because Maya set diffuse color Kd to black when you use a diffuse color map
// But is this the right thing to do?
currMaterial->Meshbuffer->Material.DiffuseColor.set(
currMaterial->Meshbuffer->Material.DiffuseColor.getAlpha(), 255, 255, 255 );
......
......@@ -1013,7 +1013,7 @@ bool COpenGLDriver::updateVertexHardwareBuffer(SHWBufferLink_opengl *HWBuffer)
core::array<c8> buffer;
if (!FeatureAvailable[IRR_ARB_vertex_array_bgra] && !FeatureAvailable[IRR_EXT_vertex_array_bgra])
{
//buffer vertex data, and convert colours...
//buffer vertex data, and convert colors...
buffer.set_used(vertexSize * vertexCount);
memcpy(buffer.pointer(), vertices, vertexSize * vertexCount);
vbuf = buffer.const_pointer();
......
......@@ -4,7 +4,7 @@
/*
History:
- changed behaviour for log2 textures ( replaced multiplies by shift )
- changed behavior for log2 textures ( replaced multiplies by shift )
*/
#ifndef __S_VIDEO_2_SOFTWARE_HELPER_H_INCLUDED__
......@@ -714,7 +714,7 @@ inline void getTexel_fix ( tFixPoint &r, tFixPoint &g, tFixPoint &b,
}
// get video sample to fixpoint
REALINLINE void getTexel_fix ( tFixPoint &a,
REALINLINE void getTexel_fix ( tFixPoint &a,
const sInternalTexture * t, const tFixPointu tx, const tFixPointu ty
)
{
......
......@@ -29,7 +29,7 @@ namespace
{
/** A structure representing some DeleD infos.
This structure contains data about DeleD level file like: version, ambient colour, number of objects etc...*/
This structure contains data about DeleD level file like: version, ambient color, number of objects etc...*/
struct dmfHeader
{
//main file header
......@@ -84,7 +84,7 @@ struct dmfVert
/** A structure representing a single dynamic light.
This structure contains light position coordinates, diffuse colour, specular colour and maximum radius of light.*/
This structure contains light position coordinates, diffuse color, specular color and maximum radius of light.*/
struct dmfLight
{
core::vector3df pos;//!<Position of this light.
......@@ -94,7 +94,7 @@ struct dmfLight
};
/** A structure representing a single water plane.
This structure contains light position coordinates, diffuse colour, specular colour and maximum radius of light.*/
This structure contains light position coordinates, diffuse color, specular color and maximum radius of light.*/
struct dmfWaterPlane
{
u32 waterID;//!<ID of specified water plane.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment