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::TextWriterBase</title> 49 </head> 50 <body> 51 <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/font/Overview.html">font</a>::TextWriterBase</CODE> Class</h1> 52 <h2>Syntax</h2> 53 <div class="section"> 54 <pre class="definition">template <typename CharType> 55class TextWriterBase : public <a href="../../../nw/font/CharWriter/Overview.html">nw::font::CharWriter</a></pre> 56 </div> 57 <h2>Template Arguments</h2> 58 <div class="section"> 59 <table class="arguments"> 60 <thead> 61 <tr> 62 <th>Name</th> 63 <td>Description</td> 64 </tr> 65 </thead> 66 <tr> 67 <th>CharType</th> 68 <td>The character type.</td> 69 </tr> </table> 70 </div> 71 <h2>Description</h2> 72 <div class="section"> 73 <p>The class for drawing characters using the <CODE>nw::font::Font</CODE> class</p><p>Inherits the <a href="../../../nw/font/CharWriter/Overview.html">nw::font::CharWriter</a> class, so can use all features of <CODE><a href="../../../nw/font/CharWriter/Overview.html">nw::font::CharWriter</a>, starting with the drawing of characters. </p><p><CODE>TextWriter</CODE> is the <CODE>typedef</CODE> used for the <CODE>TextWriterBase</CODE> class when handling CP1252, ShiftJIS and UTF8. </p><p><CODE>WideTextWriter</CODE> is the <CODE>typedef</CODE> used for the <CODE>TextWriterBase</CODE> class when handling UTF16.</p></div> 74 <a name="enum" id="enum"> 75 <h2>Enumerated Types</h2> 76 <div class="section"> 77 <table class="members"> 78 <tr> 79 <td width="100"> </td> 80 <th> 81 <a href="../../../nw/font/TextWriterBase/PositionFlag.html">PositionFlag</a> 82 </th> 83 <td>Text drawing flags used with the <CODE><a href="../../../nw/font/TextWriterBase/SetDrawFlag.html">SetDrawFlag</a></CODE> function to position the text string.</td> 84 </tr> 85 <tr> 86 <td width="100"> </td> 87 <th> 88 <a href="../../../nw/font/TextWriterBase/ContextFlag.html">ContextFlag</a> 89 </th> 90 <td> 91 </td> 92 </tr> 93 <tr> 94 <td width="100"> </td> 95 <th> 96 <a href="../../../nw/font/CharWriter/GradationMode.html">GradationMode</a> 97 </th> 98 <td>The <CODE>enum</CODE> representing types of gradation.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 99 </tr> </table> 100 </div> 101 </a> <a name="constant" id="constant"> 102 <h2>Member Constants</h2> 103 <div class="section"> 104 <table class="members"> 105 <tr> 106 <td width="100"> 107 <span class="static_style" title="static">S</span> 108 </td> 109 <th> 110 <span class="argument"><a href="../../../nw/font/TextWriterBase/DEFAULT_DRAWFLAG.html">DEFAULT_DRAWFLAG</a></span> 111 </th> 112 <td width="100"><CODE>const <span>u32</span></CODE></td> 113 <td>Represents the default rendering flag set for the constructor.</td> 114 </tr> 115 <tr> 116 <td width="100"> 117 <span class="static_style" title="static">S</span> 118 </td> 119 <th> 120 <span class="argument"><a href="../../../nw/font/CharWriter/DEFAULT_COLOR_MAPPING_MIN.html">DEFAULT_COLOR_MAPPING_MIN</a></span> 121 </th> 122 <td width="100"><CODE>const <span>u32</span></CODE></td> 123 <td> 124 (Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 125 </tr> 126 <tr> 127 <td width="100"> 128 <span class="static_style" title="static">S</span> 129 </td> 130 <th> 131 <span class="argument"><a href="../../../nw/font/CharWriter/DEFAULT_COLOR_MAPPING_MAX.html">DEFAULT_COLOR_MAPPING_MAX</a></span> 132 </th> 133 <td width="100"><CODE>const <span>u32</span></CODE></td> 134 <td> 135 (Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 136 </tr> </table> 137 </div> 138 </a> <a name="function" id="function"> 139 <h2>Member Functions</h2> 140 <div class="section"> 141 <table class="members"> 142 <tr> 143 <th class="category" colspan="3">Constructors/Destructors</th> 144 </tr> 145 <tr> 146 <td width="100"> </td> 147 <th> 148 <a href="../../../nw/font/TextWriterBase/TextWriterBase.html">TextWriterBase</a> 149 </th> 150 <td>Constructor.</td> 151 </tr> 152 <tr> 153 <td width="100"> </td> 154 <th> 155 <a href="../../../nw/font/TextWriterBase/~TextWriterBase.html">~TextWriterBase</a> 156 </th> 157 <td>Destructor.</td> 158 </tr> 159 <tr> 160 <th class="category" colspan="3">Character Spacing, Leading, and Tab Width</th> 161 </tr> 162 <tr> 163 <td width="100"> </td> 164 <th> 165 <a href="../../../nw/font/TextWriterBase/SetLineSpace.html">SetLineSpace</a> 166 </th> 167 <td>Sets the line spacing.</td> 168 </tr> 169 <tr> 170 <td width="100"> </td> 171 <th> 172 <a href="../../../nw/font/TextWriterBase/GetLineSpace.html">GetLineSpace</a> 173 </th> 174 <td>Gets the leading.</td> 175 </tr> 176 <tr> 177 <td width="100"> </td> 178 <th> 179 <a href="../../../nw/font/TextWriterBase/SetLineHeight.html">SetLineHeight</a> 180 </th> 181 <td>Sets the height of a line.</td> 182 </tr> 183 <tr> 184 <td width="100"> </td> 185 <th> 186 <a href="../../../nw/font/TextWriterBase/GetLineHeight.html">GetLineHeight</a> 187 </th> 188 <td>Gets the height of a line.</td> 189 </tr> 190 <tr> 191 <td width="100"> </td> 192 <th> 193 <a href="../../../nw/font/TextWriterBase/SetCharSpace.html">SetCharSpace</a> 194 </th> 195 <td>Sets the space between characters.</td> 196 </tr> 197 <tr> 198 <td width="100"> </td> 199 <th> 200 <a href="../../../nw/font/TextWriterBase/GetCharSpace.html">GetCharSpace</a> 201 </th> 202 <td>Gets the space between characters.</td> 203 </tr> 204 <tr> 205 <td width="100"> </td> 206 <th> 207 <a href="../../../nw/font/TextWriterBase/SetTabWidth.html">SetTabWidth</a> 208 </th> 209 <td>Sets the tab width.</td> 210 </tr> 211 <tr> 212 <td width="100"> </td> 213 <th> 214 <a href="../../../nw/font/TextWriterBase/GetTabWidth.html">GetTabWidth</a> 215 </th> 216 <td>Gets the tab width.</td> 217 </tr> 218 <tr> 219 <th class="category" colspan="3">Automatic Wrapping of Strings</th> 220 </tr> 221 <tr> 222 <td width="100"> </td> 223 <th> 224 <a href="../../../nw/font/TextWriterBase/SetWidthLimit.html">SetWidthLimit</a> 225 </th> 226 <td>Specifies the width to wrap automatically.</td> 227 </tr> 228 <tr> 229 <td width="100"> </td> 230 <th> 231 <a href="../../../nw/font/TextWriterBase/GetWidthLimit.html">GetWidthLimit</a> 232 </th> 233 <td>Gets the set wrap width.</td> 234 </tr> 235 <tr> 236 <td width="100"> </td> 237 <th> 238 <a href="../../../nw/font/TextWriterBase/ResetWidthLimit.html">ResetWidthLimit</a> 239 </th> 240 <td>Disables the automatic wrapping feature.</td> 241 </tr> 242 <tr> 243 <th class="category" colspan="3">Set/Get the Text Drawing Flag</th> 244 </tr> 245 <tr> 246 <td width="100"> </td> 247 <th> 248 <a href="../../../nw/font/TextWriterBase/SetDrawFlag.html">SetDrawFlag</a> 249 </th> 250 <td>Sets the text drawing flag.</td> 251 </tr> 252 <tr> 253 <td width="100"> </td> 254 <th> 255 <a href="../../../nw/font/TextWriterBase/GetDrawFlag.html">GetDrawFlag</a> 256 </th> 257 <td>Gets the text drawing flag.</td> 258 </tr> 259 <tr> 260 <th class="category" colspan="3">Set/Get the Tag Processor</th> 261 </tr> 262 <tr> 263 <td width="100"> </td> 264 <th> 265 <a href="../../../nw/font/TextWriterBase/SetTagProcessor.html">SetTagProcessor</a> 266 </th> 267 <td>Sets the tag processor.</td> 268 </tr> 269 <tr> 270 <td width="100"> </td> 271 <th> 272 <a href="../../../nw/font/TextWriterBase/GetTagProcessor.html">GetTagProcessor</a> 273 </th> 274 <td>Gets the tag processor.</td> 275 </tr> 276 <tr> 277 <td width="100"> </td> 278 <th> 279 <a href="../../../nw/font/TextWriterBase/ResetTagProcessor.html">ResetTagProcessor</a> 280 </th> 281 <td>Restores the tag processor to default.</td> 282 </tr> 283 <tr> 284 <th class="category" colspan="3">Calculating the Drawn Size of the Text</th> 285 </tr> 286 <tr> 287 <td width="100"> </td> 288 <th> 289 <a href="../../../nw/font/TextWriterBase/CalcFormatStringWidth.html">CalcFormatStringWidth</a> 290 </th> 291 <td>Calculates the width of the text.</td> 292 </tr> 293 <tr> 294 <td width="100"> </td> 295 <th> 296 <a href="../../../nw/font/TextWriterBase/CalcStringWidth.html">CalcStringWidth</a> 297 </th> 298 <td>Calculates the width of the text.</td> 299 </tr> 300 <tr> 301 <td width="100"> </td> 302 <th> 303 <a href="../../../nw/font/TextWriterBase/CalcFormatStringHeight.html">CalcFormatStringHeight</a> 304 </th> 305 <td>Calculates the height of the text.</td> 306 </tr> 307 <tr> 308 <td width="100"> </td> 309 <th> 310 <a href="../../../nw/font/TextWriterBase/CalcStringHeight.html">CalcStringHeight</a> 311 </th> 312 <td>Calculates the height of the text.</td> 313 </tr> 314 <tr> 315 <td width="100"> </td> 316 <th> 317 <a href="../../../nw/font/TextWriterBase/CalcFormatStringRect.html">CalcFormatStringRect</a> 318 </th> 319 <td>Calculates the drawing rectangle for the text string.</td> 320 </tr> 321 <tr> 322 <td width="100"> </td> 323 <th> 324 <a href="../../../nw/font/TextWriterBase/CalcVStringRect.html">CalcVStringRect</a> 325 </th> 326 <td>Calculates the drawing rectangle for the text string.</td> 327 </tr> 328 <tr> 329 <td width="100"> </td> 330 <th> 331 <a href="../../../nw/font/TextWriterBase/CalcStringRect.html">CalcStringRect</a> 332 </th> 333 <td>Calculates the drawing rectangle for the text string.</td> 334 </tr> 335 <tr> 336 <th class="category" colspan="3">Text String Drawing</th> 337 </tr> 338 <tr> 339 <td width="100"> </td> 340 <th> 341 <a href="../../../nw/font/TextWriterBase/Printf.html">Printf</a> 342 </th> 343 <td>Draws a string.</td> 344 </tr> 345 <tr> 346 <td width="100"> </td> 347 <th> 348 <a href="../../../nw/font/TextWriterBase/VPrintf.html">VPrintf</a> 349 </th> 350 <td>Draws a string.</td> 351 </tr> 352 <tr> 353 <td width="100"> </td> 354 <th> 355 <a href="../../../nw/font/TextWriterBase/Print.html">Print</a> 356 </th> 357 <td>Draws a string.</td> 358 </tr> 359 <tr> 360 <th class="category" colspan="3">Fonts</th> 361 </tr> 362 <tr> 363 <td width="100"> </td> 364 <th> 365 <a href="../../../nw/font/CharWriter/SetFont.html">SetFont</a> 366 </th> 367 <td>Sets the font.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 368 </tr> 369 <tr> 370 <td width="100"> </td> 371 <th> 372 <a href="../../../nw/font/CharWriter/GetFont.html">GetFont</a> 373 </th> 374 <td>Gets the font.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 375 </tr> 376 <tr> 377 <th class="category" colspan="3">Character Drawing Preparation</th> 378 </tr> 379 <tr> 380 <td width="100"> </td> 381 <th> 382 <a href="../../../nw/font/CharWriter/SetupGX.html">SetupGX</a> 383 </th> 384 <td>Prepares to draw characters.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 385 </tr> 386 <tr> 387 <td width="100"> 388 <span class="static_style" title="static">S</span> </td> 389 <th> 390 <a href="../../../nw/font/CharWriter/FinalizeGX.html">FinalizeGX</a> 391 </th> 392 <td>Performs drawing configuration post-processing.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 393 </tr> 394 <tr> 395 <th class="category" colspan="3">Linear conversion of glyph color.</th> 396 </tr> 397 <tr> 398 <td width="100"> </td> 399 <th> 400 <a href="../../../nw/font/CharWriter/SetColorMapping.html"><CODE>SetColorMapping</CODE></a> 401 </th> 402 <td>Sets the linear conversion for glyph colors used while drawing characters.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 403 </tr> 404 <tr> 405 <td width="100"> </td> 406 <th> 407 <a href="../../../nw/font/CharWriter/GetColorMappingMin.html">GetColorMappingMin</a> 408 </th> 409 <td>Gets the value after conversion for 0 for each component used in linear conversion of the glyph color.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 410 </tr> 411 <tr> 412 <td width="100"> </td> 413 <th> 414 <a href="../../../nw/font/CharWriter/GetColorMappingMax.html">GetColorMappingMax</a> 415 </th> 416 <td>Gets the value after conversion for 255 for each component used in linear conversion of the glyph color.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 417 </tr> 418 <tr> 419 <td width="100"> </td> 420 <th> 421 <a href="../../../nw/font/CharWriter/ResetColorMapping.html">ResetColorMapping</a> 422 </th> 423 <td>Sets the system to not perform linear conversion of glyph colors while drawing characters.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 424 </tr> 425 <tr> 426 <th class="category" colspan="3">Character Color/Gradation</th> 427 </tr> 428 <tr> 429 <td width="100"> </td> 430 <th> 431 <a href="../../../nw/font/CharWriter/SetAlpha.html"><CODE>SetAlpha</CODE></a> 432 </th> 433 <td>Sets the alpha value to be added when drawing characters.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 434 </tr> 435 <tr> 436 <td width="100"> </td> 437 <th> 438 <a href="../../../nw/font/CharWriter/GetAlpha.html"><CODE>GetAlpha</CODE></a> 439 </th> 440 <td>Gets the alpha value to be added when drawing characters.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 441 </tr> 442 <tr> 443 <td width="100"> </td> 444 <th> 445 <a href="../../../nw/font/CharWriter/SetGradationMode.html">SetGradationMode</a> 446 </th> 447 <td>Sets the gradation mode.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 448 </tr> 449 <tr> 450 <td width="100"> </td> 451 <th> 452 <a href="../../../nw/font/CharWriter/GetGradationMode.html">GetGradationMode</a> 453 </th> 454 <td>Gets the gradation mode.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 455 </tr> 456 <tr> 457 <td width="100"> </td> 458 <th> 459 <a href="../../../nw/font/CharWriter/SetTextColor.html">SetTextColor</a> 460 </th> 461 <td>Sets the character and gradation color.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 462 </tr> 463 <tr> 464 <td width="100"> </td> 465 <th> 466 <a href="../../../nw/font/CharWriter/GetTextColor.html">GetTextColor</a> 467 </th> 468 <td>Gets the text character color.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 469 </tr> 470 <tr> 471 <td width="100"> </td> 472 <th> 473 <a href="../../../nw/font/CharWriter/GetGradationStartColor.html">GetGradationStartColor</a> 474 </th> 475 <td>Gets the gradation start color.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 476 </tr> 477 <tr> 478 <td width="100"> </td> 479 <th> 480 <a href="../../../nw/font/CharWriter/GetGradationEndColor.html">GetGradationEndColor</a> 481 </th> 482 <td>Gets the gradation end color.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 483 </tr> 484 <tr> 485 <th class="category" colspan="3">Enlarging/Reducing Characters</th> 486 </tr> 487 <tr> 488 <td width="100"> </td> 489 <th> 490 <a href="../../../nw/font/CharWriter/SetScale.html"><CODE>SetScale</CODE></a> 491 </th> 492 <td>Specifies the magnification ratio to use for a character.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 493 </tr> 494 <tr> 495 <td width="100"> </td> 496 <th> 497 <a href="../../../nw/font/CharWriter/GetScaleH.html">GetScaleH</a> 498 </th> 499 <td>Gets the horizontal magnification ratio of the character.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 500 </tr> 501 <tr> 502 <td width="100"> </td> 503 <th> 504 <a href="../../../nw/font/CharWriter/GetScaleV.html">GetScaleV</a> 505 </th> 506 <td>Gets the vertical magnification ratio of the character.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 507 </tr> 508 <tr> 509 <td width="100"> </td> 510 <th> 511 <a href="../../../nw/font/CharWriter/SetFontSize.html">SetFontSize</a> 512 </th> 513 <td>Specifies the character size.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 514 </tr> 515 <tr> 516 <td width="100"> </td> 517 <th> 518 <a href="../../../nw/font/CharWriter/GetFontWidth.html"><CODE>GetFontWidth</CODE></a> 519 </th> 520 <td>Returns the cell width after enlargement.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 521 </tr> 522 <tr> 523 <td width="100"> </td> 524 <th> 525 <a href="../../../nw/font/CharWriter/GetFontHeight.html"><CODE>GetFontHeight</CODE></a> 526 </th> 527 <td>Gets the cell height after enlargement.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 528 </tr> 529 <tr> 530 <td width="100"> </td> 531 <th> 532 <a href="../../../nw/font/CharWriter/GetFontAscent.html"><CODE>GetFontAscent</CODE></a> 533 </th> 534 <td>Gets the font ascent after enlargement.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 535 </tr> 536 <tr> 537 <td width="100"> </td> 538 <th> 539 <a href="../../../nw/font/CharWriter/GetFontDescent.html"><CODE>GetFontDescent</CODE></a> 540 </th> 541 <td>Gets the font descent after enlargement.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 542 </tr> 543 <tr> 544 <th class="category" colspan="3">Drawing Fixed-Width Characters</th> 545 </tr> 546 <tr> 547 <td width="100"> </td> 548 <th> 549 <a href="../../../nw/font/CharWriter/EnableFixedWidth.html">EnableFixedWidth</a> 550 </th> 551 <td>Setting to draw fixed-width characters.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 552 </tr> 553 <tr> 554 <td width="100"> </td> 555 <th> 556 <a href="../../../nw/font/CharWriter/IsWidthFixed.html">IsWidthFixed</a> 557 </th> 558 <td>Determines whether characters are drawn as fixed-width.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 559 </tr> 560 <tr> 561 <td width="100"> </td> 562 <th> 563 <a href="../../../nw/font/CharWriter/SetFixedWidth.html">SetFixedWidth</a> 564 </th> 565 <td>Specifies the character width to use when drawing fixed-width characters.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 566 </tr> 567 <tr> 568 <td width="100"> </td> 569 <th> 570 <a href="../../../nw/font/CharWriter/GetFixedWidth.html">GetFixedWidth</a> 571 </th> 572 <td>Specifies the character width to use when drawing fixed-width characters.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 573 </tr> 574 <tr> 575 <th class="category" colspan="3">Text Drawing</th> 576 </tr> 577 <tr> 578 <td width="100"> </td> 579 <th> 580 <a href="../../../nw/font/TextWriterBase/Print.html">Print</a> 581 </th> 582 <td>Draws the characters.</td> 583 </tr> 584 <tr> 585 <td width="100"> </td> 586 <th> 587 <a href="../../../nw/font/CharWriter/DrawGlyph.html">DrawGlyph</a> 588 </th> 589 <td>Draws glyphs.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 590 </tr> 591 <tr> 592 <th class="category" colspan="3">Cursor</th> 593 </tr> 594 <tr> 595 <td width="100"> </td> 596 <th> 597 <a href="../../../nw/font/CharWriter/SetCursor.html">SetCursor</a> 598 </th> 599 <td>Sets the cursor position to the new coordinate that has been specified.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 600 </tr> 601 <tr> 602 <td width="100"> </td> 603 <th> 604 <a href="../../../nw/font/CharWriter/MoveCursor.html">MoveCursor</a> 605 </th> 606 <td>Moves the cursor from its current position by the distance specified.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 607 </tr> 608 <tr> 609 <td width="100"> </td> 610 <th> 611 <a href="../../../nw/font/CharWriter/SetCursorX.html">SetCursorX</a> 612 </th> 613 <td>This function sets the x-coordinate of the cursor.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 614 </tr> 615 <tr> 616 <td width="100"> </td> 617 <th> 618 <a href="../../../nw/font/CharWriter/SetCursorY.html">SetCursorY</a> 619 </th> 620 <td>This function sets the y-coordinate of the cursor.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 621 </tr> 622 <tr> 623 <td width="100"> </td> 624 <th> 625 <a href="../../../nw/font/CharWriter/SetCursorZ.html">SetCursorZ</a> 626 </th> 627 <td>This function sets the z-coordinate of the cursor.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 628 </tr> 629 <tr> 630 <td width="100"> </td> 631 <th> 632 <a href="../../../nw/font/CharWriter/MoveCursorX.html">MoveCursorX</a> 633 </th> 634 <td>Moves the cursor from its current position by the distance specified.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 635 </tr> 636 <tr> 637 <td width="100"> </td> 638 <th> 639 <a href="../../../nw/font/CharWriter/MoveCursorY.html">MoveCursorY</a> 640 </th> 641 <td>Moves the cursor from its current position by the distance specified.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 642 </tr> 643 <tr> 644 <td width="100"> </td> 645 <th> 646 <a href="../../../nw/font/CharWriter/MoveCursorZ.html">MoveCursorZ</a> 647 </th> 648 <td>Moves the cursor from its current position by the distance specified.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 649 </tr> 650 <tr> 651 <td width="100"> </td> 652 <th> 653 <a href="../../../nw/font/CharWriter/GetCursorX.html">GetCursorX</a> 654 </th> 655 <td>This function gets the x-coordinate of the cursor.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 656 </tr> 657 <tr> 658 <td width="100"> </td> 659 <th> 660 <a href="../../../nw/font/CharWriter/GetCursorY.html">GetCursorY</a> 661 </th> 662 <td>This function gets the y-coordinate of the cursor.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 663 </tr> 664 <tr> 665 <td width="100"> </td> 666 <th> 667 <a href="../../../nw/font/CharWriter/GetCursorZ.html">GetCursorZ</a> 668 </th> 669 <td>This function gets the z-coordinate of the cursor.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 670 </tr> 671 <tr> 672 <th class="category" colspan="3">Set/Get Shader-related</th> 673 </tr> 674 <tr> 675 <td width="100"> </td> 676 <th> 677 <a href="../../../nw/font/CharWriter/GetTextWriterResource.html">GetTextWriterResource</a> 678 </th> 679 <td>Gets the <CODE>TextWriterResource</CODE> instance.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 680 </tr> 681 <tr> 682 <td width="100"> </td> 683 <th> 684 <a href="../../../nw/font/CharWriter/SetTextWriterResource.html">SetTextWriterResource</a> 685 </th> 686 <td>Sets the <CODE>TextWriterResource</CODE>instance.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 687 </tr> 688 <tr> 689 <th class="category" colspan="3">Buffer for character string display</th> 690 </tr> 691 <tr> 692 <td width="100"> </td> 693 <th> 694 <a href="../../../nw/font/CharWriter/GetDispStringBuffer.html">GetDispStringBuffer</a> 695 </th> 696 <td>Gets the buffer for displaying a string.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 697 </tr> 698 <tr> 699 <td width="100"> </td> 700 <th> 701 <a href="../../../nw/font/CharWriter/SetDispStringBuffer.html">SetDispStringBuffer</a> 702 </th> 703 <td>Sets the buffer for displaying a string. When <CODE>NULL</CODE> is set, the string display buffer is no longer in use(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 704 </tr> 705 <tr> 706 <td width="100"> </td> 707 <th> 708 <a href="../../../nw/font/CharWriter/StartPrint.html">StartPrint</a> 709 </th> 710 <td>Starts drawing of the character string. Used when a buffer has been configured for string display.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 711 </tr> 712 <tr> 713 <td width="100"> </td> 714 <th> 715 <a href="../../../nw/font/CharWriter/EndPrint.html">EndPrint</a> 716 </th> 717 <td>Ends drawing of the character string. Used when a buffer has been configured for string display.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 718 </tr> 719 <tr> 720 <td width="100"> </td> 721 <th> 722 <a href="../../../nw/font/CharWriter/UseCommandBuffer.html">UseCommandBuffer</a> 723 </th> 724 <td>Adds the string display-use command buffer to the current command list.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 725 </tr> 726 <tr> 727 <td width="100"> 728 <span class="static_style" title="static">S</span> </td> 729 <th> 730 <a href="../../../nw/font/CharWriter/GetDispStringBufferSize.html">GetDispStringBufferSize</a> 731 </th> 732 <td>Calculates the size of the buffer for string display.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 733 </tr> 734 <tr> 735 <td width="100"> 736 <span class="static_style" title="static">S</span> </td> 737 <th> 738 <a href="../../../nw/font/CharWriter/InitDispStringBuffer.html">InitDispStringBuffer</a> 739 </th> 740 <td>Initializes a buffer for string display.(Derived from <CODE><a href="../../../nw/font/CharWriter/Overview.html">CharWriter</a></CODE>)</td> 741 </tr> 742 <tr> 743 <th class="category" colspan="3">Format Expansion Buffer</th> 744 </tr> 745 <tr> 746 <td width="100"> 747 <span class="static_style" title="static">S</span> </td> 748 <th> 749 <a href="../../../nw/font/TextWriterBase/SetBuffer.html"><CODE>SetBuffer</CODE></a> 750 </th> 751 <td>Allocates a buffer for extracting formatted text.</td> 752 </tr> 753 <tr> 754 <td width="100"> 755 <span class="static_style" title="static">S</span> </td> 756 <th> 757 <a href="../../../nw/font/TextWriterBase/GetBuffer.html"><CODE>GetBuffer</CODE></a> 758 </th> 759 <td>Gets a pointer to the buffer used to expand the formatted character string.</td> 760 </tr> 761 <tr> 762 <td width="100"> 763 <span class="static_style" title="static">S</span> </td> 764 <th> 765 <a href="../../../nw/font/TextWriterBase/GetBufferSize.html"><CODE>GetBufferSize</CODE></a> 766 </th> 767 <td>Gets the size of the buffer for extracting formatted text.</td> 768 </tr> 769 <tr> 770 <th class="category" colspan="3">Other</th> 771 </tr> 772 <tr> 773 <td width="100"> 774 <span class="static_style" title="static">S</span> </td> 775 <th> 776 <a href="../../../nw/font/TextWriterBase/VSNPrintf.html">VSNPrintf</a> 777 </th> 778 <td> 779 </td> 780 </tr> 781 <tr> 782 <td width="100"> 783 <span class="static_style" title="static">S</span> </td> 784 <th> 785 <a href="../../../nw/font/TextWriterBase/StrLen.html">StrLen</a> 786 </th> 787 <td> 788 </td> 789 </tr> </table> 790 </div> 791 </a> 792 <h2>Class Hierarchy</h2> 793 <div class="section"> 794 <p class="hierarchy"><a href="../../../nw/font/CharWriter/Overview.html">nw::font::CharWriter</a><br /> <b>nw::font::TextWriterBase</b> 795 </p> 796 </div> 797 <h2>Revision History</h2> 798 <div class="section"> 799 <dl class="history"> 800 <dt>2009/10/20</dt> 801 <dd>Initial version.<br /> 802 </dd> 803 </dl> 804 </div> 805 <hr><p>CONFIDENTIAL</p></body> 806</html> 807