Commit 3c8b2d70797f28ab6918bdc41d093c5894bca526
2001-11-11T23:57:31
Changed to html from txt
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
diff --git a/docs/FTGL.html b/docs/FTGL.html
new file mode 100644
index 0000000..b9f93f8
--- /dev/null
+++ b/docs/FTGL.html
@@ -0,0 +1,283 @@
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
+ <title>FTGL User Guide</title>
+</head>
+<body>
+
+<TABLE BORDER="0" WIDTH="70%" CELLSPACING="0" CELLPADDING="0" ALIGN="center">
+ <TR>
+ <TD>
+
+<h1>FTGL User Guide
+</h1>
+<h2>(work in progress)
+</h2>
+<P ALIGN="center">
+<IMG SRC="images/ftgldemo.jpg" ALT="FTGL Demo screen shot" WIDTH="480" HEIGHT="383" BORDER="0">
+</P>
+
+<H2>Contents</H2>
+<UL>
+ <LI><H3><a href="#INT">Introduction</a></H3></LI>
+ <LI><H3><a href="#CFT">Choosing a font type</a></H3></LI>
+ <LI><H3><a href="#CAT">Creating a font</a></H3></LI>
+ <LI><H3><a href="#MFC">More font commands</a></H3></LI>
+ <LI><H3><a href="#FAQ">FAQ</a></H3></LI>
+</UL>
+<HR ALIGN="center" SIZE="2" WIDTH="80%">
+<A NAME="INT">
+<h2>Introduction
+</h2>
+<P>
+OpenGL doesn't provide direct font support, so the application must use any of OpenGL's other features for font rendering, such as drawing bitmaps or pixmaps, creating texture maps containing an entire character set, drawing character outlines, or creating 3D geometry for each character.
+</P>
+
+
+<P>
+One thing all of these systems have in comman is they require a pre-processing stage to take the native fonts and convert them into proprietry format.
+</P>
+
+<P>
+FTGL was borne out of the need to treat fonts in OpenGL applications just like any other application. For example when using Adobe Photoshop or Microsoft Word you don't need an intermediate pre-processing step to use high quality scalable fonts.
+</P>
+
+<HR ALIGN="center" SIZE="2" WIDTH="80%">
+<A NAME="CFT">
+<H2>Choosing a font type</H2>
+<P>
+FTGL supports 5 font output types in 3 groups, raster fonts, vector fonts and texure fonts which are a mixture of both. Each font type has it's advantages and disadvantages
+</P>
+The two raster types are
+<UL>
+ <LI>Bitmapped</LI>
+ <LI>Antialiased pixmapped</LI>
+</UL>
+
+
+
+The vector types are
+<UL>
+ <LI>Outline</LI>
+ <LI>Polygonal</LI>
+ <LI>Extruded polygon</LI>
+</UL>
+
+
+
+
+<UL>
+ <LI>Texture mapped</LI>
+</UL>
+<P>
+This is probably the most versatile type. It is fast, antialised and can be transformed just like any openGL primitive.
+</P>
+
+<HR ALIGN="center" SIZE="2" WIDTH="80%">
+
+<A NAME="CAF">
+<H2>Creating a font
+</H2>
+<font color="blue"><PRE>
+ FTGLPixmapFont font;
+
+ font.Open( "Fonts:Arial");
+ font.FaceSize( 72);
+
+ font.render( "Hello World!");
+
+ FTFont::Open( string, cache);
+ const char* string;
+ bool cache;
+</PRE></font>
+
+<P>
+A side effect of this is you can specify a sub set of glyphs to be pre-loaded. This will let you use larger higher quality glyphs without consuming huge amounts of ram as you would if you laoded the entire font. For example if your application only needs numbers, eg for scores, you can use the following code to preload them.
+</P>
+
+<font color="blue"><PRE>
+ // Open the font with pre-cache set to false
+ font.Open( "Fonts:Arial", false);
+
+ // Set the size
+ font.FaceSize( 72);
+
+ // Cause the font to preload the number chars without rendering them.
+ font.Advance( "0123456789");
+</PRE></font>
+
+
+
+<HR ALIGN="center" SIZE="2" WIDTH="80%">
+
+<A NAME="MFC">
+<H2>More font commands</H2>
+<H3>Font Metrics</H3>
+<P ALIGN="center">
+<IMG SRC="images/metrics.png" ALT="glyph metrics" WIDTH="388" HEIGHT="253" BORDER="0">
+</P>
+
+<P>
+If you ask a font to render at 0.0, 0.0 the bottom left most pixel or polygon may not be aligned to 0.0, 0.0.
+</P>
+
+<font color="blue"><PRE>
+ int FTFont::Ascender() const;
+ int FTFont::Descender() const;
+
+ float FTFont::Advance( string);
+</PRE></font>
+
+
+<P>
+With these three functions an approximate bounding box can be calculated. For an exact bounding box use the FTFont::BBox function.
+</P>
+
+<font color="blue"><PRE>
+ void FTFont::BBox( string, llx, lly, llz, urx, ury, urz);
+ const char* string: String of text to be tested
+ int& llx: The bottom left near most ?? in the x axis
+ int& lly: The bottom left near most ?? in the y axis
+ int& llz: The bottom left near most ?? in the z axis
+ int& urx: The top right far most ?? in the x axis
+ int& ury: The top right far most ?? in the y axis
+ int& urz: The top right far most ?? in the z axis
+</PRE></font>
+
+<P>
+This function returns the extent of the volume containing 'string'. 0.0 on the y axis will be aligned with the font baseline.
+</P>
+
+<H3>Specifying a character map encoding.
+</H3>
+From the freetype docs...<br>
+"By default, when a new face object is created, (freetype) lists all the charmaps contained in the font face and selects the one that supports Unicode character codes if it finds one. Otherwise, it tries to find support for Latin-1, then ASCII."
+
+It then gives up. In this case FTGL will set the charmap to the first it finds in the fonts charmap list.
+
+You can expilcitly set the char encoding with Charmap:
+<font color="blue"><PRE>
+ bool FTFont::CharMap( encoding);
+ FT_Encoding encoding; Freetype code
+</PRE></font>
+
+Valid encodings as at Freetype 2.0.4
+<font color="blue"><PRE>
+ ft_encoding_none
+ ft_encoding_symbol
+ ft_encoding_unicode
+ ft_encoding_latin_2
+ ft_encoding_sjis
+ ft_encoding_gb2312
+ ft_encoding_big5
+ ft_encoding_wansung
+ ft_encoding_johab
+ ft_encoding_adobe_standard
+ ft_encoding_adobe_expert
+ ft_encoding_adobe_custom
+ ft_encoding_apple_roman
+</PRE></font>
+
+for example...
+<font color="blue"><PRE>
+font.CharMap( ft_encoding_apple_roman);
+</PRE></font>
+
+This will return an error if the requested encoding can't be found in the font.
+
+
+
+<HR ALIGN="center" SIZE="2" WIDTH="80%">
+
+<A NAME="FAQ">
+<H2>FAQ</H2>
+
+Sample font manager class.
+
+
+<font color="blue"><pre>
+FTGLTextureFont* myFont = FTGLFontManager::Instance().GetFont( "arial.ttf", 72);
+
+#include <map>
+#include "FTGLTextureFont.h"
+
+using namespace std;
+
+typedef map< string, FTFont*> FontList;
+typedef FontList::const_iterator FontIter;
+
+class FTGLFontManager
+{
+ public:
+ static FTGLFontManager& Instance()
+ {
+ static FTGLFontManager tm;
+ return tm;
+ }
+
+ ~FTGLFontManager()
+ {
+ FontIter font;
+ for( font = fonts.begin(); font != fonts.end(); font++)
+ {
+ delete (*font).second;;
+ }
+
+ fonts.clear();
+ }
+
+
+ FTFont* GetFont( const char *filename, int size)
+ {
+ char buf[256];
+ sprintf(buf, "%s%i", filename, size);
+ string fontKey = string(buf);
+
+ FontIter result = fonts.find( fontKey);
+ if( result != fonts.end())
+ {
+ LOGMSG( "Found font %s in list", filename);
+ return result->second;
+ }
+
+ FTFont* font = new FTGLTextureFont;
+
+ string fullname = path + string( filename);
+
+ if( !font->Open( fullname.c_str()))
+ {
+ LOGERROR( "Font %s failed to open", fullname.c_str());
+ return NULL;
+ }
+
+ if( !font->FaceSize( size))
+ {
+ LOGERROR( "Font %s failed to set size %i", filename, size);
+ return NULL;
+ }
+
+ fonts[fontKey] = font;
+
+ return font;
+
+ }
+
+
+ private:
+ // Hide these 'cause this is a singleton.
+ FTGLFontManager(){}
+ FTGLFontManager( const FTGLFontManager&){};
+ FTGLFontManager& operator = ( const FTGLFontManager&){ return *this;};
+
+ // container for fonts
+ FontList fonts;
+
+};
+</PRE></font>
+
+
+ </TD>
+ </TR>
+</TABLE>
+</body>
+</html>
diff --git a/docs/FTGL.txt b/docs/FTGL.txt
deleted file mode 100644
index 67e3054..0000000
--- a/docs/FTGL.txt
+++ /dev/null
@@ -1,177 +0,0 @@
-FTGL User Guide
-(work in progress)
-
-Introduction
-
-OpenGL doesn't provide direct font support, so the application must use any of OpenGL's other features for font rendering, such as drawing bitmaps or pixmaps, creating texture maps containing an entire character set, drawing character outlines, or creating 3D geometry for each character.
-
-
-One thing all of these systems have in commen is they require a pre-processing stage to take the native fonts and convert them into proprietry format.
-
-FTGL was borne out of the need to treat fonts in openGL applications just like any other application. For example when using Photoshop you don't need an intermediate pre-processing step to use high quality scalable fonts.
-
-Choosing a font type
-FTGL supports 5 font output types in 3 groups, raster fonts, vector fonts and texure fonts which are a mixture of both. Each font type has it's advantages and disadvantages
-
-The two raster types are
-- Bitmapped
-- Antialiased pixmapped
-
-
-
-
-The vector types are
-- Outline
-- Polygonal
-
-
-
-
-- Texture mapped
-This is probably the most versatile type. It is fast, antialised and can be transformed just like any openGL primitive.
-
-Creating a font
-
- FTGLPixmapFont font;
-
- font.Open( "Fonts:Arial");
- font.FaceSize( 72);
-
- font.render( "Hello World!");
-
- FTFont::Open( string, cache);
- const char* string;
- bool cache;
-
-A side effect of this is you can specify a sub set of glyphs to be pre-loaded. This will let you use larger higher quality glyphs without consuming huge amounts of ram as you would if you laoded the entire font. For example if your application only needs numbers, eg for scores, you can use the following code to preload them.
-
- // Open the font with pre-cache set to false
- font.Open( "Fonts:Arial", false);
-
- // Set the size
- font.FaceSize( 72);
-
- // Cause the font to preload the number chars without rendering them.
- font.Advance( "0123456789");
-
-
-
-More font commands
-
-
-
-
-Specifying a character map encoding.
-
-From the freetype docs...
-"By default, when a new face object is created, (freetype) lists all the charmaps contained in the font face and selects the one that supports Unicode character codes if it finds one. Otherwise, it tries to find support for Latin-1, then ASCII."
-
-It then gives up. In this case FTGL will set the charmap to the first it finds in the fonts charmap list.
-
-You can expilcitly set the char encoding with Charmap:
- bool FTFont::CharMap( encoding);
- FT_Encoding encoding; Freetype code
-
-for example...
-font.CharMap( ft_encoding_apple_roman);
-
-Valid encodings as at Freetype 2.0.4
- ft_encoding_none
- ft_encoding_symbol
- ft_encoding_unicode
- ft_encoding_latin_2
- ft_encoding_sjis
- ft_encoding_gb2312
- ft_encoding_big5
- ft_encoding_wansung
- ft_encoding_johab
- ft_encoding_adobe_standard
- ft_encoding_adobe_expert
- ft_encoding_adobe_custom
- ft_encoding_apple_roman
-
-This will return an error if the requested encoding can't be found in the font.
-
-
-
-FAQ
-
-Sample font manager class.
-
-FTGLTextureFont* myFont = FTGLFontManager::Instance().GetFont( "arial.ttf", 72);
-
-#include <map>
-#include "FTGLTextureFont.h"
-
-using namespace std;
-
-typedef map< string, FTFont*> FontList;
-typedef FontList::const_iterator FontIter;
-
-class FTGLFontManager
-{
- public:
- static FTGLFontManager& Instance()
- {
- static FTGLFontManager tm;
- return tm;
- }
-
- ~FTGLFontManager()
- {
- FontIter font;
- for( font = fonts.begin(); font != fonts.end(); font++)
- {
- delete (*font).second;;
- }
-
- fonts.clear();
- }
-
-
- FTFont* GetFont( const char *filename, int size)
- {
- char buf[256];
- sprintf(buf, "%s%i", filename, size);
- string fontKey = string(buf);
-
- FontIter result = fonts.find( fontKey);
- if( result != fonts.end())
- {
- LOGMSG( "Found font %s in list", filename);
- return result->second;
- }
-
- FTFont* font = new FTGLTextureFont;
-
- string fullname = path + string( filename);
-
- if( !font->Open( fullname.c_str()))
- {
- LOGERROR( "Font %s failed to open", fullname.c_str());
- return NULL;
- }
-
- if( !font->FaceSize( size))
- {
- LOGERROR( "Font %s failed to set size %i", filename, size);
- return NULL;
- }
-
- fonts[fontKey] = font;
-
- return font;
-
- }
-
-
- private:
- // Hide these 'cause this is a singleton.
- FTGLFontManager(){}
- FTGLFontManager( const FTGLFontManager&){};
- FTGLFontManager& operator = ( const FTGLFontManager&){ return *this;};
-
- // container for fonts
- FontList fonts;
-
-};