1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 span.virtual_style 22 { 23 font-size : 8pt; 24 color : white; 25 font-weight : bold; 26 background : #0a0; 27 border-left : solid 1px #0f0; 28 border-top : solid 1px #0f0; 29 border-right : solid 1px #060; 30 border-bottom : solid 1px #060; 31 padding-left : 2px; 32 padding-right : 2px; 33 } 34 span.protected_style 35 { 36 font-size : 8pt; 37 color : white; 38 font-weight : bold; 39 background : #444; 40 border-left : solid 1px #ccc; 41 border-top : solid 1px #ccc; 42 border-right : solid 1px #222; 43 border-bottom : solid 1px #222; 44 padding-left : 2px; 45 padding-right : 2px; 46 } 47 --></style> 48 <title>nw::font::ResFont</title> 49 </head> 50 <body> 51 <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/font/Overview.html">font</a>::ResFont</CODE> Class</h1> 52 <h2>Syntax</h2> 53 <div class="section"> 54 <pre class="definition">class ResFont : public <a href="../../../nw/font/ResFontBase/Overview.html">nw::font::ResFontBase</a></pre> 55 </div> 56 <h2>Description</h2> 57 <div class="section"> 58 <p>The class for implementing operations on the font resource.</p> 59 </div> 60 <a name="enum" id="enum"> 61 <h2>Enumerated Types</h2> 62 <div class="section"> 63 <table class="members"> 64 <tr> 65 <td width="100"> </td> 66 <th> 67 <a href="../../../nw/font/Font/Type.html">Type</a> 68 </th> 69 <td> 70 (Derived from <CODE><a href="../../../nw/font/Font/Overview.html">Font</a></CODE>)</td> 71 </tr> </table> 72 </div> 73 </a> <a name="typedef" id="typedef"> 74 <h2><CODE>typedef</CODE> Definitions</h2> 75 <div class="section"> 76 <table class="members"> 77 <tr> 78 <td width="100" /> 79 <th> 80 <a href="../../../nw/font/ResFontBase/GlyphIndex.html">GlyphIndex</a> 81 </th> 82 <td> 83 (Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 84 </tr> </table> 85 </div> 86 </a> <a name="constant" id="constant"> 87 <h2>Member Constants</h2> 88 <div class="section"> 89 <table class="members"> 90 <tr> 91 <th class="category" colspan="4">Other</th> 92 </tr> 93 <tr> 94 <td width="100"> 95 <span class="protected_style" title="protected">protected</span> <span class="static_style" title="static">S</span> 96 </td> 97 <th> 98 <span class="argument"><a href="../../../nw/font/ResFontBase/GLYPH_INDEX_NOT_FOUND.html">GLYPH_INDEX_NOT_FOUND</a></span> 99 </th> 100 <td width="100">const <a href="../../../nw/font/ResFontBase/GlyphIndex.html">GlyphIndex</a></td> 101 <td> 102 (Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 103 </tr> 104 <tr> 105 <td width="100"> 106 <span class="static_style" title="static">S</span> 107 </td> 108 <th> 109 <span class="argument"><a href="../../../nw/font/Font/INVALID_CHARACTER_CODE.html">INVALID_CHARACTER_CODE</a></span> 110 </th> 111 <td width="100">const <a href="../../../nw/font/CharCode.html">CharCode</a></td> 112 <td> 113 (Derived from <CODE><a href="../../../nw/font/Font/Overview.html">Font</a></CODE>)</td> 114 </tr> </table> 115 </div> 116 </a> <a name="function" id="function"> 117 <h2>Member Functions</h2> 118 <div class="section"> 119 <table class="members"> 120 <tr> 121 <th class="category" colspan="3">Constructors/Destructors</th> 122 </tr> 123 <tr> 124 <td width="100"> </td> 125 <th> 126 <a href="../../../nw/font/ResFont/ResFont.html">ResFont</a> 127 </th> 128 <td>Constructor.</td> 129 </tr> 130 <tr> 131 <td width="100"> <span class="virtual_style" title="virtual">V</span> 132 </td> 133 <th> 134 <a href="../../../nw/font/ResFont/~ResFont.html">~ResFont</a> 135 </th> 136 <td>Destructor.</td> 137 </tr> 138 <tr> 139 <th class="category" colspan="3">Binding/Releasing Resources</th> 140 </tr> 141 <tr> 142 <td width="100"> </td> 143 <th> 144 <a href="../../../nw/font/ResFont/SetResource.html">SetResource</a> 145 </th> 146 <td>Enables the use of a font by associating the font resource.</td> 147 </tr> 148 <tr> 149 <td width="100"> </td> 150 <th> 151 <a href="../../../nw/font/ResFont/RemoveResource.html">RemoveResource</a> 152 </th> 153 <td>Deallocates the font resource.</td> 154 </tr> 155 <tr> 156 <td width="100"> </td> 157 <th> 158 <a href="../../../nw/font/ResFont/GetDrawBuffer.html">GetDrawBuffer</a> 159 </th> 160 <td>Gets the pointer to the buffer required for drawing.</td> 161 </tr> 162 <tr> 163 <td width="100"> </td> 164 <th> 165 <a href="../../../nw/font/ResFont/SetDrawBuffer.html">SetDrawBuffer</a> 166 </th> 167 <td>Sets the buffer required for drawing. The size of the buffer being set is obtained with the <CODE>GetDrawBufferSize</CODE> function. </td> 168 </tr> 169 <tr> 170 <td width="100"> 171 <span class="static_style" title="static">S</span> </td> 172 <th> 173 <a href="../../../nw/font/ResFont/GetDrawBufferSize.html">GetDrawBufferSize</a> 174 </th> 175 <td>Calculates the buffer size required for drawing.</td> 176 </tr> 177 <tr> 178 <th class="category" colspan="3">Getting Font Data</th> 179 </tr> 180 <tr> 181 <td width="100"> <span class="virtual_style" title="virtual">V</span> 182 </td> 183 <th> 184 <a href="../../../nw/font/ResFont/GetWidth.html">GetWidth</a> 185 </th> 186 <td>Gets the width of the font.</td> 187 </tr> 188 <tr> 189 <td width="100"> <span class="virtual_style" title="virtual">V</span> 190 </td> 191 <th> 192 <a href="../../../nw/font/ResFont/GetHeight.html">GetHeight</a> 193 </th> 194 <td>Gets the font height.</td> 195 </tr> 196 <tr> 197 <td width="100"> <span class="virtual_style" title="virtual">V</span> 198 </td> 199 <th> 200 <a href="../../../nw/font/ResFont/GetAscent.html">GetAscent</a> 201 </th> 202 <td>Gets the ascent of the font.</td> 203 </tr> 204 <tr> 205 <td width="100"> <span class="virtual_style" title="virtual">V</span> 206 </td> 207 <th> 208 <a href="../../../nw/font/ResFont/GetDescent.html">GetDescent</a> 209 </th> 210 <td>Gets the font descent.</td> 211 </tr> 212 <tr> 213 <td width="100"> <span class="virtual_style" title="virtual">V</span> 214 </td> 215 <th> 216 <a href="../../../nw/font/ResFont/GetMaxCharWidth.html">GetMaxCharWidth</a> 217 </th> 218 <td>Gets the maximum character width included in the font.</td> 219 </tr> 220 <tr> 221 <td width="100"> <span class="virtual_style" title="virtual">V</span> 222 </td> 223 <th> 224 <a href="../../../nw/font/ResFont/GetType.html"><CODE>GetType</CODE></a> 225 </th> 226 <td>Gets the font type.</td> 227 </tr> 228 <tr> 229 <td width="100"> <span class="virtual_style" title="virtual">V</span> 230 </td> 231 <th> 232 <a href="../../../nw/font/ResFont/GetTextureFormat.html">GetTextureFormat</a> 233 </th> 234 <td>Gets the texture format of the font.</td> 235 </tr> 236 <tr> 237 <td width="100"> <span class="virtual_style" title="virtual">V</span> 238 </td> 239 <th> 240 <a href="../../../nw/font/ResFont/GetLineFeed.html">GetLineFeed</a> 241 </th> 242 <td>Gets the size of the font's linefeed.</td> 243 </tr> 244 <tr> 245 <td width="100"> <span class="virtual_style" title="virtual">V</span> 246 </td> 247 <th> 248 <a href="../../../nw/font/ResFont/GetDefaultCharWidths.html">GetDefaultCharWidths</a> 249 </th> 250 <td>Gets the font's default character width data.</td> 251 </tr> 252 <tr> 253 <th class="category" colspan="3">Setting Font Data</th> 254 </tr> 255 <tr> 256 <td width="100"> <span class="virtual_style" title="virtual">V</span> 257 </td> 258 <th> 259 <a href="../../../nw/font/ResFont/SetLineFeed.html">SetLineFeed</a> 260 </th> 261 <td>Sets the linefeed width of the font.</td> 262 </tr> 263 <tr> 264 <td width="100"> <span class="virtual_style" title="virtual">V</span> 265 </td> 266 <th> 267 <a href="../../../nw/font/ResFont/SetDefaultCharWidths.html">SetDefaultCharWidths</a> 268 </th> 269 <td>Sets the font's default character width data.</td> 270 </tr> 271 <tr> 272 <td width="100"> <span class="virtual_style" title="virtual">V</span> 273 </td> 274 <th> 275 <a href="../../../nw/font/ResFont/SetAlternateChar.html">SetAlternateChar</a> 276 </th> 277 <td>Changes the alternate character for the font.</td> 278 </tr> 279 <tr> 280 <th class="category" colspan="3">Getting Character Data</th> 281 </tr> 282 <tr> 283 <td width="100"> <span class="virtual_style" title="virtual">V</span> 284 </td> 285 <th> 286 <a href="../../../nw/font/ResFont/GetCharWidth.html">GetCharWidth</a> 287 </th> 288 <td>Gets the character width of a character.</td> 289 </tr> 290 <tr> 291 <td width="100"> <span class="virtual_style" title="virtual">V</span> 292 </td> 293 <th> 294 <a href="../../../nw/font/ResFont/GetCharWidths.html">GetCharWidths</a> 295 </th> 296 <td>Gets character width data for characters.</td> 297 </tr> 298 <tr> 299 <td width="100"> <span class="virtual_style" title="virtual">V</span> 300 </td> 301 <th> 302 <a href="../../../nw/font/ResFont/GetGlyph.html">GetGlyph</a> 303 </th> 304 <td>Gets glyph data.</td> 305 </tr> 306 <tr> 307 <td width="100"> <span class="virtual_style" title="virtual">V</span> 308 </td> 309 <th> 310 <a href="../../../nw/font/ResFont/HasGlyph.html">HasGlyph</a> 311 </th> 312 <td>Gets the existence (or nonexistence) of glyph data.</td> 313 </tr> 314 <tr> 315 <th class="category" colspan="3">Text Encoding</th> 316 </tr> 317 <tr> 318 <td width="100"> <span class="virtual_style" title="virtual">V</span> 319 </td> 320 <th> 321 <a href="../../../nw/font/ResFont/GetCharacterCode.html">GetCharacterCode</a> 322 </th> 323 <td>Gets the character code supported by the font.</td> 324 </tr> 325 <tr> 326 <td width="100"> </td> 327 <th> 328 <a href="../../../nw/font/Font/GetCharStrmReader.html">GetCharStrmReader</a> 329 </th> 330 <td>Gets <CODE><a href="../../../nw/font/CharStrmReader/Overview.html">CharStrmReader</a></CODE>, used to interpret text in the character code format the font supports.(Derived from <CODE><a href="../../../nw/font/Font/Overview.html">Font</a></CODE>)</td> 331 </tr> 332 <tr> 333 <th class="category" colspan="3">Getting Sheet Information</th> 334 </tr> 335 <tr> 336 <td width="100"> <span class="virtual_style" title="virtual">V</span> 337 </td> 338 <th> 339 <a href="../../../nw/font/ResFont/GetBaselinePos.html">GetBaselinePos</a> 340 </th> 341 <td>Gets the baseline position.</td> 342 </tr> 343 <tr> 344 <td width="100"> <span class="virtual_style" title="virtual">V</span> 345 </td> 346 <th> 347 <a href="../../../nw/font/ResFont/GetCellHeight.html">GetCellHeight</a> 348 </th> 349 <td>Gets the cell height.</td> 350 </tr> 351 <tr> 352 <td width="100"> <span class="virtual_style" title="virtual">V</span> 353 </td> 354 <th> 355 <a href="../../../nw/font/ResFont/GetCellWidth.html">GetCellWidth</a> 356 </th> 357 <td>Gets the cell width.</td> 358 </tr> 359 <tr> 360 <td width="100"> 361 <span class="protected_style" title="protected">protected</span> <span class="virtual_style" title="virtual">V</span> 362 </td> 363 <th> 364 <a href="../../../nw/font/ResFont/GetActiveSheetNum.html">GetActiveSheetNum</a> 365 </th> 366 <td>Gets the number of active sheets.</td> 367 </tr> 368 <tr> 369 <td width="100"> 370 <span class="protected_style" title="protected">protected</span> </td> 371 <th> 372 <a href="../../../nw/font/ResFontBase/GetTextureObjectsBufferPtr.html">GetTextureObjectsBufferPtr</a> 373 </th> 374 <td>Gets pointer to texture object buffer.(Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 375 </tr> 376 <tr> 377 <td width="100"> </td> 378 <th> 379 <a href="../../../nw/font/ResFontBase/SetTextureObjectsBufferPtr.html">SetTextureObjectsBufferPtr</a> 380 </th> 381 <td>Sets pointer to the texture object buffer.(Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 382 </tr> 383 <tr> 384 <td width="100"> </td> 385 <th> 386 <a href="../../../nw/font/ResFontBase/GenTextureNames.html">GenTextureNames</a> 387 </th> 388 <td>Generates the texture name.(Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 389 </tr> 390 <tr> 391 <td width="100"> </td> 392 <th> 393 <a href="../../../nw/font/ResFontBase/DeleteTextureNames.html">DeleteTextureNames</a> 394 </th> 395 <td> 396 (Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 397 </tr> 398 <tr> 399 <th class="category" colspan="3">Texture Interpolation</th> 400 </tr> 401 <tr> 402 <td width="100"> <span class="virtual_style" title="virtual">V</span> 403 </td> 404 <th> 405 <a href="../../../nw/font/ResFont/EnableLinearFilter.html">EnableLinearFilter</a> 406 </th> 407 <td>Specifies whether or not linear interpolation of textures is performed while characters are drawn.</td> 408 </tr> 409 <tr> 410 <td width="100"> <span class="virtual_style" title="virtual">V</span> 411 </td> 412 <th> 413 <a href="../../../nw/font/ResFont/IsLinearFilterEnableAtSmall.html">IsLinearFilterEnableAtSmall</a> 414 </th> 415 <td>Gets whether or not linear interpolation is to be carried out when small characters are displayed.</td> 416 </tr> 417 <tr> 418 <td width="100"> <span class="virtual_style" title="virtual">V</span> 419 </td> 420 <th> 421 <a href="../../../nw/font/ResFont/IsLinearFilterEnableAtLarge.html">IsLinearFilterEnableAtLarge</a> 422 </th> 423 <td>Gets whether or not linear interpolation is to be carried out when large characters are displayed.</td> 424 </tr> 425 <tr> 426 <td width="100"> <span class="virtual_style" title="virtual">V</span> 427 </td> 428 <th> 429 <a href="../../../nw/font/ResFont/GetTextureWrapFilterValue.html">GetTextureWrapFilterValue</a> 430 </th> 431 <td>Gets the values for the texture's wrap and filter settings.</td> 432 </tr> 433 <tr> 434 <th class="category" colspan="3">Other</th> 435 </tr> 436 <tr> 437 <td width="100"> 438 <span class="protected_style" title="protected">protected</span> </td> 439 <th> 440 <a href="../../../nw/font/ResFontBase/GetFINF.html">GetFINF</a> 441 </th> 442 <td> 443 (Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 444 </tr> 445 <tr> 446 <td width="100"> 447 <span class="protected_style" title="protected">protected</span> </td> 448 <th> 449 <a href="../../../nw/font/ResFontBase/IsManaging.html">IsManaging</a> 450 </th> 451 <td>Determines whether the resource font is associated.(Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 452 </tr> 453 <tr> 454 <td width="100"> 455 <span class="protected_style" title="protected">protected</span> </td> 456 <th> 457 <a href="../../../nw/font/ResFontBase/SetResourceBuffer.html">SetResourceBuffer</a> 458 </th> 459 <td>Sets pointers to the allocated buffer and the FINF block positioned there.(Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 460 </tr> 461 <tr> 462 <td width="100"> 463 <span class="protected_style" title="protected">protected</span> </td> 464 <th> 465 <a href="../../../nw/font/ResFontBase/RemoveResourceBuffer.html">RemoveResourceBuffer</a> 466 </th> 467 <td>Resets the parameter configured by <CODE>SetResourceBuffer</CODE> and returns the pointer to the allocated buffer.(Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 468 </tr> 469 <tr> 470 <td width="100"> 471 <span class="protected_style" title="protected">protected</span> </td> 472 <th> 473 <a href="../../../nw/font/ResFontBase/GetGlyphIndex.html">GetGlyphIndex</a> 474 </th> 475 <td>Gets the character glyph index.(Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 476 </tr> 477 <tr> 478 <td width="100"> 479 <span class="protected_style" title="protected">protected</span> </td> 480 <th> 481 <a href="../../../nw/font/ResFontBase/FindGlyphIndex.html">FindGlyphIndex</a> 482 </th> 483 <td>Gets the character glyph index.(Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 484 </tr> 485 <tr> 486 <td width="100"> 487 <span class="protected_style" title="protected">protected</span> </td> 488 <th> 489 <a href="../../../nw/font/ResFontBase/GetCharWidthsFromIndex.html">GetCharWidthsFromIndex</a> 490 </th> 491 <td>Gets the character width of the character corresponding to the glyph index.(Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 492 </tr> 493 <tr> 494 <td width="100"> 495 <span class="protected_style" title="protected">protected</span> </td> 496 <th> 497 <a href="../../../nw/font/ResFontBase/GetGlyphFromIndex.html">GetGlyphFromIndex</a> 498 </th> 499 <td>Gets the glyph data corresponding to the glyph index.(Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 500 </tr> 501 <tr> 502 <td width="100"> 503 <span class="protected_style" title="protected">protected</span> <span class="static_style" title="static">S</span> </td> 504 <th> 505 <a href="../../../nw/font/ResFontBase/SetGlyphMember.html">SetGlyphMember</a> 506 </th> 507 <td>Sets <CODE>Glyph</CODE>members based on the content of the <CODE>FontTextureGlyph</CODE> structure(Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 508 </tr> </table> 509 </div> 510 </a> 511 <h2>Class Hierarchy</h2> 512 <div class="section"> 513 <p class="hierarchy"><a href="../../../nw/font/Font/Overview.html">nw::font::Font</a><br /> <a href="../../../nw/font/ResFontBase/Overview.html">nw::font::ResFontBase</a><br /> <b>nw::font::ResFont</b> 514 </p> 515 </div> 516 <h2>Revision History</h2> 517 <div class="section"> 518 <dl class="history"> 519 <dt>2009/10/20</dt> 520 <dd>Initial version.<br /> 521 </dd> 522 </dl> 523 </div> 524 <hr><p>CONFIDENTIAL</p></body> 525</html> 526