Commit 19957e61 authored by hybrid's avatar hybrid

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
parent 2f315b43
...@@ -74,21 +74,23 @@ public: ...@@ -74,21 +74,23 @@ public:
//! Gets kerning values (distance between letters) for the font. If no parameters are provided, //! Gets kerning values (distance between letters) for the font. If no parameters are provided,
/** the global kerning distance is returned. /** the global kerning distance is returned.
\param thisLetter: If this parameter is provided, the left side kerning for this letter is added \param thisLetter: If this parameter is provided, the left side kerning
to the global kerning value. For example, a space might only be one pixel wide, but it may for this letter is added to the global kerning value. For example, a
be displayed as several pixels. space might only be one pixel wide, but it may be displayed as several
\param previousLetter: If provided, kerning is calculated for both letters and added to the global pixels.
kerning value. For example, in a font which supports kerning pairs a string such as 'Wo' may have \param previousLetter: If provided, kerning is calculated for both
the 'o' tucked neatly under the 'W'. 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; virtual s32 getKerningWidth(const wchar_t* thisLetter=0, const wchar_t* previousLetter=0) const = 0;
//! Returns the distance between letters //! Returns the distance between letters
virtual s32 getKerningHeight() const = 0; virtual s32 getKerningHeight() const = 0;
//! define which characters should not be drawn by the font. for example " " would //! Define which characters should not be drawn by the font.
// not draw any space which is usually blank in most fonts. /** 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 \param invisible: string of symbols, which are not send down to the videodriver
*/ */
virtual void setInvisibleCharacters( const wchar_t *s ) = 0; virtual void setInvisibleCharacters( const wchar_t *s ) = 0;
......
...@@ -127,7 +127,7 @@ namespace gui ...@@ -127,7 +127,7 @@ namespace gui
//! Returns which row is currently selected //! Returns which row is currently selected
virtual s32 getSelected() const = 0; virtual s32 getSelected() const = 0;
//! Returns amount of rows in the tabcontrol //! Get amount of rows in the tabcontrol
virtual s32 getRowCount() const = 0; virtual s32 getRowCount() const = 0;
//! adds a row to the table //! adds a row to the table
...@@ -137,7 +137,7 @@ namespace gui ...@@ -137,7 +137,7 @@ namespace gui
number of row by more than one, it won't be created. Note that 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 if you create a row that's not at the end, there might be
performance issues. performance issues.
\returns: index of inteserted row*/ \return index of inserted row. */
virtual u32 addRow(u32 rowIndex) = 0; virtual u32 addRow(u32 rowIndex) = 0;
//! Remove a row from the table //! Remove a row from the table
......
...@@ -31,7 +31,6 @@ namespace gui ...@@ -31,7 +31,6 @@ namespace gui
//! Returns pointer to the maximize button //! Returns pointer to the maximize button
virtual IGUIButton* getMaximizeButton() const = 0; virtual IGUIButton* getMaximizeButton() const = 0;
}; };
......
...@@ -189,7 +189,7 @@ namespace quake3 ...@@ -189,7 +189,7 @@ namespace quake3
// return a z-test // return a z-test
inline u8 getDepthFunction ( const core::stringc &string ) inline u8 getDepthFunction ( const core::stringc &string )
{ {
u8 ret = video::EMDF_DEPTH_LESS_EQUAL; u8 ret = video::ECFN_LESSEQUAL;
if ( string.size() == 0 ) if ( string.size() == 0 )
return ret; return ret;
......
...@@ -98,18 +98,6 @@ namespace video ...@@ -98,18 +98,6 @@ namespace video
dstFact = E_BLEND_FACTOR ( ( state & 0x000000FF ) ); 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 //! These flags are used to specify the anti-aliasing and smoothing modes
/** Techniques supported are multisampling, geometry smoothing, and alpha /** Techniques supported are multisampling, geometry smoothing, and alpha
to coverage. to coverage.
......
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