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>nw::font::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="3">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> 101 (Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 102 </tr> 103 <tr> 104 <td width="100"> 105 <span class="static_style" title="static">S</span> 106 </td> 107 <th> 108 <span class="argument"><a href="../../../nw/font/Font/INVALID_CHARACTER_CODE.html">INVALID_CHARACTER_CODE</a></span> 109 </th> 110 <td> 111 (Derived from <CODE><a href="../../../nw/font/Font/Overview.html">Font</a></CODE>)</td> 112 </tr> </table> 113 </div> 114 </a> <a name="function" id="function"> 115 <h2>Member Functions</h2> 116 <div class="section"> 117 <table class="members"> 118 <tr> 119 <th class="category" colspan="3">Constructors/Destructors</th> 120 </tr> 121 <tr> 122 <td width="100"> </td> 123 <th> 124 <a href="../../../nw/font/ResFont/ResFont.html">ResFont</a> 125 </th> 126 <td>Constructor.</td> 127 </tr> 128 <tr> 129 <td width="100"> <span class="virtual_style" title="virtual">V</span> 130 </td> 131 <th> 132 <a href="../../../nw/font/ResFont/~ResFont.html">~ResFont</a> 133 </th> 134 <td>Destructor.</td> 135 </tr> 136 <tr> 137 <th class="category" colspan="3">Binding/Releasing Resources</th> 138 </tr> 139 <tr> 140 <td width="100"> </td> 141 <th> 142 <a href="../../../nw/font/ResFont/SetResource.html">SetResource</a> 143 </th> 144 <td>Enables the use of a font by associating the font resource.</td> 145 </tr> 146 <tr> 147 <td width="100"> </td> 148 <th> 149 <a href="../../../nw/font/ResFont/RemoveResource.html">RemoveResource</a> 150 </th> 151 <td>Deallocates the font resource.</td> 152 </tr> 153 <tr> 154 <td width="100"> </td> 155 <th> 156 <a href="../../../nw/font/ResFont/GetDrawBuffer.html">GetDrawBuffer</a> 157 </th> 158 <td>Gets the pointer to the buffer required for drawing.</td> 159 </tr> 160 <tr> 161 <td width="100"> </td> 162 <th> 163 <a href="../../../nw/font/ResFont/SetDrawBuffer.html">SetDrawBuffer</a> 164 </th> 165 <td>Sets the buffer required for drawing. The size of the buffer being set is obtained with the <CODE>GetDrawBufferSize</CODE> function. </td> 166 </tr> 167 <tr> 168 <td width="100"> 169 <span class="static_style" title="static">S</span> </td> 170 <th> 171 <a href="../../../nw/font/ResFont/GetDrawBufferSize.html">GetDrawBufferSize</a> 172 </th> 173 <td>Calculates the buffer size required for drawing.</td> 174 </tr> 175 <tr> 176 <th class="category" colspan="3">Getting Font Data</th> 177 </tr> 178 <tr> 179 <td width="100"> <span class="virtual_style" title="virtual">V</span> 180 </td> 181 <th> 182 <a href="../../../nw/font/ResFont/GetWidth.html">GetWidth</a> 183 </th> 184 <td>Gets the width of the font.</td> 185 </tr> 186 <tr> 187 <td width="100"> <span class="virtual_style" title="virtual">V</span> 188 </td> 189 <th> 190 <a href="../../../nw/font/ResFont/GetHeight.html">GetHeight</a> 191 </th> 192 <td>Gets the font height.</td> 193 </tr> 194 <tr> 195 <td width="100"> <span class="virtual_style" title="virtual">V</span> 196 </td> 197 <th> 198 <a href="../../../nw/font/ResFont/GetAscent.html">GetAscent</a> 199 </th> 200 <td>Gets the ascent of the font.</td> 201 </tr> 202 <tr> 203 <td width="100"> <span class="virtual_style" title="virtual">V</span> 204 </td> 205 <th> 206 <a href="../../../nw/font/ResFont/GetDescent.html">GetDescent</a> 207 </th> 208 <td>Gets the font descent.</td> 209 </tr> 210 <tr> 211 <td width="100"> <span class="virtual_style" title="virtual">V</span> 212 </td> 213 <th> 214 <a href="../../../nw/font/ResFont/GetMaxCharWidth.html">GetMaxCharWidth</a> 215 </th> 216 <td>Gets the maximum character width included in the font.</td> 217 </tr> 218 <tr> 219 <td width="100"> <span class="virtual_style" title="virtual">V</span> 220 </td> 221 <th> 222 <a href="../../../nw/font/ResFont/GetType.html"><CODE>GetType</CODE></a> 223 </th> 224 <td>Gets the font type.</td> 225 </tr> 226 <tr> 227 <td width="100"> <span class="virtual_style" title="virtual">V</span> 228 </td> 229 <th> 230 <a href="../../../nw/font/ResFont/GetTextureFormat.html">GetTextureFormat</a> 231 </th> 232 <td>Gets the texture format of the font.</td> 233 </tr> 234 <tr> 235 <td width="100"> <span class="virtual_style" title="virtual">V</span> 236 </td> 237 <th> 238 <a href="../../../nw/font/ResFont/GetLineFeed.html">GetLineFeed</a> 239 </th> 240 <td>Gets the size of the font's linefeed.</td> 241 </tr> 242 <tr> 243 <td width="100"> <span class="virtual_style" title="virtual">V</span> 244 </td> 245 <th> 246 <a href="../../../nw/font/ResFont/GetDefaultCharWidths.html">GetDefaultCharWidths</a> 247 </th> 248 <td>Gets the font's default character width data.</td> 249 </tr> 250 <tr> 251 <th class="category" colspan="3">Setting Font Data</th> 252 </tr> 253 <tr> 254 <td width="100"> <span class="virtual_style" title="virtual">V</span> 255 </td> 256 <th> 257 <a href="../../../nw/font/ResFont/SetLineFeed.html">SetLineFeed</a> 258 </th> 259 <td>Sets the linefeed width of the font.</td> 260 </tr> 261 <tr> 262 <td width="100"> <span class="virtual_style" title="virtual">V</span> 263 </td> 264 <th> 265 <a href="../../../nw/font/ResFont/SetDefaultCharWidths.html">SetDefaultCharWidths</a> 266 </th> 267 <td>Sets the font's default character width data.</td> 268 </tr> 269 <tr> 270 <td width="100"> <span class="virtual_style" title="virtual">V</span> 271 </td> 272 <th> 273 <a href="../../../nw/font/ResFont/SetAlternateChar.html">SetAlternateChar</a> 274 </th> 275 <td>Changes the alternate character for the font.</td> 276 </tr> 277 <tr> 278 <th class="category" colspan="3">Getting Character Data</th> 279 </tr> 280 <tr> 281 <td width="100"> <span class="virtual_style" title="virtual">V</span> 282 </td> 283 <th> 284 <a href="../../../nw/font/ResFont/GetCharWidth.html">GetCharWidth</a> 285 </th> 286 <td>Gets the character width of a character.</td> 287 </tr> 288 <tr> 289 <td width="100"> <span class="virtual_style" title="virtual">V</span> 290 </td> 291 <th> 292 <a href="../../../nw/font/ResFont/GetCharWidths.html">GetCharWidths</a> 293 </th> 294 <td>Gets character width data for characters.</td> 295 </tr> 296 <tr> 297 <td width="100"> <span class="virtual_style" title="virtual">V</span> 298 </td> 299 <th> 300 <a href="../../../nw/font/ResFont/GetGlyph.html">GetGlyph</a> 301 </th> 302 <td>Gets glyph data.</td> 303 </tr> 304 <tr> 305 <td width="100"> <span class="virtual_style" title="virtual">V</span> 306 </td> 307 <th> 308 <a href="../../../nw/font/ResFont/HasGlyph.html">HasGlyph</a> 309 </th> 310 <td>Gets the existence (or nonexistence) of glyph data.</td> 311 </tr> 312 <tr> 313 <th class="category" colspan="3">Text Encoding</th> 314 </tr> 315 <tr> 316 <td width="100"> <span class="virtual_style" title="virtual">V</span> 317 </td> 318 <th> 319 <a href="../../../nw/font/ResFont/GetCharacterCode.html">GetCharacterCode</a> 320 </th> 321 <td>Gets the character code supported by the font.</td> 322 </tr> 323 <tr> 324 <td width="100"> </td> 325 <th> 326 <a href="../../../nw/font/Font/GetCharStrmReader.html">GetCharStrmReader</a> 327 </th> 328 <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> 329 </tr> 330 <tr> 331 <th class="category" colspan="3">Getting Sheet Information</th> 332 </tr> 333 <tr> 334 <td width="100"> <span class="virtual_style" title="virtual">V</span> 335 </td> 336 <th> 337 <a href="../../../nw/font/ResFont/GetBaselinePos.html">GetBaselinePos</a> 338 </th> 339 <td>Gets the baseline position.</td> 340 </tr> 341 <tr> 342 <td width="100"> <span class="virtual_style" title="virtual">V</span> 343 </td> 344 <th> 345 <a href="../../../nw/font/ResFont/GetCellHeight.html">GetCellHeight</a> 346 </th> 347 <td>Gets the cell height.</td> 348 </tr> 349 <tr> 350 <td width="100"> <span class="virtual_style" title="virtual">V</span> 351 </td> 352 <th> 353 <a href="../../../nw/font/ResFont/GetCellWidth.html">GetCellWidth</a> 354 </th> 355 <td>Gets the cell width.</td> 356 </tr> 357 <tr> 358 <td width="100"> 359 <span class="protected_style" title="protected">protected</span> <span class="virtual_style" title="virtual">V</span> 360 </td> 361 <th> 362 <a href="../../../nw/font/ResFont/GetActiveSheetNum.html">GetActiveSheetNum</a> 363 </th> 364 <td>Gets the number of active sheets.</td> 365 </tr> 366 <tr> 367 <td width="100"> 368 <span class="protected_style" title="protected">protected</span> </td> 369 <th> 370 <a href="../../../nw/font/ResFontBase/GetTextureObjectsBufferPtr.html">GetTextureObjectsBufferPtr</a> 371 </th> 372 <td>Gets pointer to texture object buffer.(Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 373 </tr> 374 <tr> 375 <td width="100"> </td> 376 <th> 377 <a href="../../../nw/font/ResFontBase/SetTextureObjectsBufferPtr.html">SetTextureObjectsBufferPtr</a> 378 </th> 379 <td>Sets pointer to the texture object buffer.(Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 380 </tr> 381 <tr> 382 <td width="100"> </td> 383 <th> 384 <a href="../../../nw/font/ResFontBase/GenTextureNames.html">GenTextureNames</a> 385 </th> 386 <td>Generates the texture name.(Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 387 </tr> 388 <tr> 389 <td width="100"> </td> 390 <th> 391 <a href="../../../nw/font/ResFontBase/DeleteTextureNames.html">DeleteTextureNames</a> 392 </th> 393 <td> 394 (Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 395 </tr> 396 <tr> 397 <th class="category" colspan="3">Texture Interpolation</th> 398 </tr> 399 <tr> 400 <td width="100"> <span class="virtual_style" title="virtual">V</span> 401 </td> 402 <th> 403 <a href="../../../nw/font/ResFont/EnableLinearFilter.html">EnableLinearFilter</a> 404 </th> 405 <td>Specifies whether or not linear interpolation of textures is performed while characters are drawn.</td> 406 </tr> 407 <tr> 408 <td width="100"> <span class="virtual_style" title="virtual">V</span> 409 </td> 410 <th> 411 <a href="../../../nw/font/ResFont/IsLinearFilterEnableAtSmall.html">IsLinearFilterEnableAtSmall</a> 412 </th> 413 <td>Gets whether or not linear interpolation is to be carried out when small characters are displayed.</td> 414 </tr> 415 <tr> 416 <td width="100"> <span class="virtual_style" title="virtual">V</span> 417 </td> 418 <th> 419 <a href="../../../nw/font/ResFont/IsLinearFilterEnableAtLarge.html">IsLinearFilterEnableAtLarge</a> 420 </th> 421 <td>Gets whether or not linear interpolation is to be carried out when large characters are displayed.</td> 422 </tr> 423 <tr> 424 <td width="100"> <span class="virtual_style" title="virtual">V</span> 425 </td> 426 <th> 427 <a href="../../../nw/font/ResFont/GetTextureWrapFilterValue.html">GetTextureWrapFilterValue</a> 428 </th> 429 <td>Gets the values for the texture's wrap and filter settings.</td> 430 </tr> 431 <tr> 432 <th class="category" colspan="3">Other</th> 433 </tr> 434 <tr> 435 <td width="100"> 436 <span class="protected_style" title="protected">protected</span> </td> 437 <th> 438 <a href="../../../nw/font/ResFontBase/GetFINF.html">GetFINF</a> 439 </th> 440 <td> 441 (Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 442 </tr> 443 <tr> 444 <td width="100"> 445 <span class="protected_style" title="protected">protected</span> </td> 446 <th> 447 <a href="../../../nw/font/ResFontBase/IsManaging.html">IsManaging</a> 448 </th> 449 <td>Determines whether the resource font is associated.(Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 450 </tr> 451 <tr> 452 <td width="100"> 453 <span class="protected_style" title="protected">protected</span> </td> 454 <th> 455 <a href="../../../nw/font/ResFontBase/SetResourceBuffer.html">SetResourceBuffer</a> 456 </th> 457 <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> 458 </tr> 459 <tr> 460 <td width="100"> 461 <span class="protected_style" title="protected">protected</span> </td> 462 <th> 463 <a href="../../../nw/font/ResFontBase/RemoveResourceBuffer.html">RemoveResourceBuffer</a> 464 </th> 465 <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> 466 </tr> 467 <tr> 468 <td width="100"> 469 <span class="protected_style" title="protected">protected</span> </td> 470 <th> 471 <a href="../../../nw/font/ResFontBase/GetGlyphIndex.html">GetGlyphIndex</a> 472 </th> 473 <td>Gets the character glyph index.(Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 474 </tr> 475 <tr> 476 <td width="100"> 477 <span class="protected_style" title="protected">protected</span> </td> 478 <th> 479 <a href="../../../nw/font/ResFontBase/FindGlyphIndex.html">FindGlyphIndex</a> 480 </th> 481 <td>Gets the character glyph index.(Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 482 </tr> 483 <tr> 484 <td width="100"> 485 <span class="protected_style" title="protected">protected</span> </td> 486 <th> 487 <a href="../../../nw/font/ResFontBase/GetCharWidthsFromIndex.html">GetCharWidthsFromIndex</a> 488 </th> 489 <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> 490 </tr> 491 <tr> 492 <td width="100"> 493 <span class="protected_style" title="protected">protected</span> </td> 494 <th> 495 <a href="../../../nw/font/ResFontBase/GetGlyphFromIndex.html">GetGlyphFromIndex</a> 496 </th> 497 <td>Gets the glyph data corresponding to the glyph index.(Derived from <a href="../../../nw/font/ResFontBase/Overview.html">ResFontBase</a>)</td> 498 </tr> 499 <tr> 500 <td width="100"> 501 <span class="protected_style" title="protected">protected</span> <span class="static_style" title="static">S</span> </td> 502 <th> 503 <a href="../../../nw/font/ResFontBase/SetGlyphMember.html">SetGlyphMember</a> 504 </th> 505 <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> 506 </tr> </table> 507 </div> 508 </a> 509 <h2>Class Hierarchy</h2> 510 <div class="section"> 511 <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> 512 </p> 513 </div> 514 <h2>Revision History</h2> 515 <div class="section"> 516 <dl class="history"> 517 <dt>2009/10/20</dt> 518 <dd>Initial version.<br /> 519 </dd> 520 </dl> 521 </div> 522 <hr><p>CONFIDENTIAL</p></body> 523</html> 524