zaki
/
irrlicht
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix some docs. 

Removed special depth comparison enum in favor of the general comparison func enum.

git-svn-id: svn://svn.code.sf.net/p/irrlicht/code/trunk@2151 dfc29bdd-3216-0410-991c-e03cc46cb475
master
hybrid 2009-01-27 23:08:06 +00:00
parent 2f315b4349
commit 19957e6167
5 changed files with 14 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
include/IGUIFont.h
View File

@ -74,21 +74,23 @@ public:
//! Gets kerning values (distance between letters) for the font. If no parameters are provided,
/** the global kerning distance is returned.
\param thisLetter: If this parameter is provided, the left side kerning for this letter is added
to the global kerning value. For example, a space might only be one pixel wide, but it may
be displayed as several pixels.
\param previousLetter: If provided, kerning is calculated for both letters and added to the global
kerning value. For example, in a font which supports kerning pairs a string such as 'Wo' may have
the 'o' tucked neatly under the 'W'.
\param thisLetter: If this parameter is provided, the left side kerning
for this letter is added to the global kerning value. For example, a
space might only be one pixel wide, but it may be displayed as several
pixels.
\param previousLetter: If provided, kerning is calculated for both
letters and added to the global kerning value. For example, in a font
which supports kerning pairs a string such as 'Wo' may have the 'o'
tucked neatly under the 'W'.
*/
virtual s32 getKerningWidth(const wchar_t* thisLetter=0, const wchar_t* previousLetter=0) const = 0;
//! Returns the distance between letters
virtual s32 getKerningHeight() const = 0;
//! define which characters should not be drawn by the font. for example " " would
// not draw any space which is usually blank in most fonts.
/**
//! Define which characters should not be drawn by the font.
/** For example " " would not draw any space which is usually blank in
most fonts.
\param invisible: string of symbols, which are not send down to the videodriver
*/
virtual void setInvisibleCharacters( const wchar_t *s ) = 0;

4
include/IGUITable.h
View File

@ -127,7 +127,7 @@ namespace gui
//! Returns which row is currently selected
virtual s32 getSelected() const = 0;
//! Returns amount of rows in the tabcontrol
//! Get amount of rows in the tabcontrol
virtual s32 getRowCount() const = 0;
//! adds a row to the table
@ -137,7 +137,7 @@ namespace gui
number of row by more than one, it won't be created. Note that
if you create a row that's not at the end, there might be
performance issues.
\returns: index of inteserted row*/
\return index of inserted row. */
virtual u32 addRow(u32 rowIndex) = 0;
//! Remove a row from the table

1
include/IGUIWindow.h
View File

@ -31,7 +31,6 @@ namespace gui
//! Returns pointer to the maximize button
virtual IGUIButton* getMaximizeButton() const = 0;
};

2
include/IQ3Shader.h
View File

@ -189,7 +189,7 @@ namespace quake3
// return a z-test
inline u8 getDepthFunction ( const core::stringc &string )
{
u8 ret = video::EMDF_DEPTH_LESS_EQUAL;
u8 ret = video::ECFN_LESSEQUAL;
if ( string.size() == 0 )
return ret;

12
include/SMaterial.h
View File

@ -98,18 +98,6 @@ namespace video
dstFact = E_BLEND_FACTOR ( ( state & 0x000000FF ) );
}
//! These flags are used to specify the DebthBuffer Function for the Material
/** Usally this is set to less equal
*/
//! DebthBuffer Function
enum E_DEPTHBUFFER_FUNC
{
EMDF_DEPTH_OFF = 0,
EMDF_DEPTH_LESS_EQUAL = 1,
EMDF_DEPTH_EQUAL = 2,
EMDF_DEPTH_GREATER_EQUAL = 3
};
//! These flags are used to specify the anti-aliasing and smoothing modes
/** Techniques supported are multisampling, geometry smoothing, and alpha
to coverage.