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::CharWriter</title> 49 </head> 50 <body> 51 <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/font/Overview.html">font</a>::CharWriter</CODE> Class</h1> 52 <h2>Syntax</h2> 53 <div class="section"> 54 <pre class="definition">class CharWriter</pre> 55 </div> 56 <h2>Description</h2> 57 <div class="section"> 58 <p>The class for drawing characters using the <CODE>Font </CODE>class</p><p>The <CODE><a href="../../../nw/font/TextWriter.html">nw::font::TextWriter</a></CODE> class is used when also drawing strings.</p></div> 59 <a name="enum" id="enum"> 60 <h2>Enumerated Types</h2> 61 <div class="section"> 62 <table class="members"> 63 <tr> 64 <td width="100"> </td> 65 <th> 66 <a href="../../../nw/font/CharWriter/GradationMode.html">GradationMode</a> 67 </th> 68 <td>The <CODE>enum</CODE> representing types of gradation.</td> 69 </tr> </table> 70 </div> 71 </a> <a name="constant" id="constant"> 72 <h2>Member Constants</h2> 73 <div class="section"> 74 <table class="members"> 75 <tr> 76 <td width="100"> 77 <span class="static_style" title="static">S</span> 78 </td> 79 <th> 80 <span class="argument"><a href="../../../nw/font/CharWriter/DEFAULT_COLOR_MAPPING_MIN.html">DEFAULT_COLOR_MAPPING_MIN</a></span> 81 </th> 82 <td width="100">const <span>u32</span></td> 83 <td> 84 </td> 85 </tr> 86 <tr> 87 <td width="100"> 88 <span class="static_style" title="static">S</span> 89 </td> 90 <th> 91 <span class="argument"><a href="../../../nw/font/CharWriter/DEFAULT_COLOR_MAPPING_MAX.html">DEFAULT_COLOR_MAPPING_MAX</a></span> 92 </th> 93 <td width="100">const <span>u32</span></td> 94 <td> 95 </td> 96 </tr> </table> 97 </div> 98 </a> <a name="function" id="function"> 99 <h2>Member Functions</h2> 100 <div class="section"> 101 <table class="members"> 102 <tr> 103 <th class="category" colspan="3">Constructors and Destructors</th> 104 </tr> 105 <tr> 106 <td width="100"> </td> 107 <th> 108 <a href="../../../nw/font/CharWriter/CharWriter.html">CharWriter</a> 109 </th> 110 <td>Constructor.</td> 111 </tr> 112 <tr> 113 <td width="100"> </td> 114 <th> 115 <a href="../../../nw/font/CharWriter/~CharWriter.html">~CharWriter</a> 116 </th> 117 <td>Destructor.</td> 118 </tr> 119 <tr> 120 <th class="category" colspan="3">Fonts</th> 121 </tr> 122 <tr> 123 <td width="100"> </td> 124 <th> 125 <a href="../../../nw/font/CharWriter/SetFont.html">SetFont</a> 126 </th> 127 <td>Sets the font.</td> 128 </tr> 129 <tr> 130 <td width="100"> </td> 131 <th> 132 <a href="../../../nw/font/CharWriter/GetFont.html">GetFont</a> 133 </th> 134 <td>Gets the font.</td> 135 </tr> 136 <tr> 137 <th class="category" colspan="3">Character Drawing Preparation</th> 138 </tr> 139 <tr> 140 <td width="100"> </td> 141 <th> 142 <a href="../../../nw/font/CharWriter/SetupGX.html">SetupGX</a> 143 </th> 144 <td>Prepares to draw characters.</td> 145 </tr> 146 <tr> 147 <td width="100"> 148 <span class="static_style" title="static">S</span> </td> 149 <th> 150 <a href="../../../nw/font/CharWriter/FinalizeGX.html">FinalizeGX</a> 151 </th> 152 <td>Performs drawing configuration post-processing.</td> 153 </tr> 154 <tr> 155 <th class="category" colspan="3">Linear conversion of glyph color.</th> 156 </tr> 157 <tr> 158 <td width="100"> </td> 159 <th> 160 <a href="../../../nw/font/CharWriter/SetColorMapping.html">SetColorMapping</a> 161 </th> 162 <td>Sets the linear conversion for glyph colors used while drawing characters.</td> 163 </tr> 164 <tr> 165 <td width="100"> </td> 166 <th> 167 <a href="../../../nw/font/CharWriter/GetColorMappingMin.html">GetColorMappingMin</a> 168 </th> 169 <td>Gets the value after conversion for 0 for each component used in linear conversion of the glyph color.</td> 170 </tr> 171 <tr> 172 <td width="100"> </td> 173 <th> 174 <a href="../../../nw/font/CharWriter/GetColorMappingMax.html">GetColorMappingMax</a> 175 </th> 176 <td>Gets the value after conversion for 255 for each component used in linear conversion of the glyph color.</td> 177 </tr> 178 <tr> 179 <td width="100"> </td> 180 <th> 181 <a href="../../../nw/font/CharWriter/ResetColorMapping.html">ResetColorMapping</a> 182 </th> 183 <td>Sets the system to not perform linear conversion of glyph colors while drawing characters.</td> 184 </tr> 185 <tr> 186 <th class="category" colspan="3">Character Color/Gradation</th> 187 </tr> 188 <tr> 189 <td width="100"> </td> 190 <th> 191 <a href="../../../nw/font/CharWriter/SetAlpha.html"><CODE>SetAlpha</CODE></a> 192 </th> 193 <td>Sets the alpha value to be added when drawing characters.</td> 194 </tr> 195 <tr> 196 <td width="100"> </td> 197 <th> 198 <a href="../../../nw/font/CharWriter/GetAlpha.html"><CODE>GetAlpha</CODE></a> 199 </th> 200 <td>Gets the alpha value to be added when drawing characters.</td> 201 </tr> 202 <tr> 203 <td width="100"> </td> 204 <th> 205 <a href="../../../nw/font/CharWriter/SetGradationMode.html">SetGradationMode</a> 206 </th> 207 <td>Sets the gradation mode.</td> 208 </tr> 209 <tr> 210 <td width="100"> </td> 211 <th> 212 <a href="../../../nw/font/CharWriter/GetGradationMode.html">GetGradationMode</a> 213 </th> 214 <td>Gets the gradation mode.</td> 215 </tr> 216 <tr> 217 <td width="100"> </td> 218 <th> 219 <a href="../../../nw/font/CharWriter/SetTextColor.html">SetTextColor</a> 220 </th> 221 <td>Sets the character and gradation color.</td> 222 </tr> 223 <tr> 224 <td width="100"> </td> 225 <th> 226 <a href="../../../nw/font/CharWriter/GetTextColor.html">GetTextColor</a> 227 </th> 228 <td>Gets the text character color.</td> 229 </tr> 230 <tr> 231 <td width="100"> </td> 232 <th> 233 <a href="../../../nw/font/CharWriter/GetGradationStartColor.html">GetGradationStartColor</a> 234 </th> 235 <td>Gets the gradation start color.</td> 236 </tr> 237 <tr> 238 <td width="100"> </td> 239 <th> 240 <a href="../../../nw/font/CharWriter/GetGradationEndColor.html">GetGradationEndColor</a> 241 </th> 242 <td>Gets the gradation end color.</td> 243 </tr> 244 <tr> 245 <th class="category" colspan="3">Enlarging/Reducing Characters</th> 246 </tr> 247 <tr> 248 <td width="100"> </td> 249 <th> 250 <a href="../../../nw/font/CharWriter/SetScale.html">SetScale</a> 251 </th> 252 <td>Specifies the magnification ratio to use for a character.</td> 253 </tr> 254 <tr> 255 <td width="100"> </td> 256 <th> 257 <a href="../../../nw/font/CharWriter/GetScaleH.html">GetScaleH</a> 258 </th> 259 <td>Gets the horizontal magnification ratio of the character.</td> 260 </tr> 261 <tr> 262 <td width="100"> </td> 263 <th> 264 <a href="../../../nw/font/CharWriter/GetScaleV.html">GetScaleV</a> 265 </th> 266 <td>Gets the vertical magnification ratio of the character.</td> 267 </tr> 268 <tr> 269 <td width="100"> </td> 270 <th> 271 <a href="../../../nw/font/CharWriter/SetFontSize.html">SetFontSize</a> 272 </th> 273 <td>Specifies the character size.</td> 274 </tr> 275 <tr> 276 <td width="100"> </td> 277 <th> 278 <a href="../../../nw/font/CharWriter/GetFontWidth.html">GetFontWidth</a> 279 </th> 280 <td>Returns the cell width after enlargement.</td> 281 </tr> 282 <tr> 283 <td width="100"> </td> 284 <th> 285 <a href="../../../nw/font/CharWriter/GetFontHeight.html">GetFontHeight</a> 286 </th> 287 <td>Gets the cell height after enlargement.</td> 288 </tr> 289 <tr> 290 <td width="100"> </td> 291 <th> 292 <a href="../../../nw/font/CharWriter/GetFontAscent.html">GetFontAscent</a> 293 </th> 294 <td>Gets the font ascent after magnification.</td> 295 </tr> 296 <tr> 297 <td width="100"> </td> 298 <th> 299 <a href="../../../nw/font/CharWriter/GetFontDescent.html">GetFontDescent</a> 300 </th> 301 <td>Gets the font descent after magnification.</td> 302 </tr> 303 <tr> 304 <th class="category" colspan="3">Drawing Fixed-Width Characters</th> 305 </tr> 306 <tr> 307 <td width="100"> </td> 308 <th> 309 <a href="../../../nw/font/CharWriter/EnableFixedWidth.html">EnableFixedWidth</a> 310 </th> 311 <td>Setting to draw fixed-width characters.</td> 312 </tr> 313 <tr> 314 <td width="100"> </td> 315 <th> 316 <a href="../../../nw/font/CharWriter/IsWidthFixed.html">IsWidthFixed</a> 317 </th> 318 <td>Determines whether characters are drawn as fixed-width.</td> 319 </tr> 320 <tr> 321 <td width="100"> </td> 322 <th> 323 <a href="../../../nw/font/CharWriter/SetFixedWidth.html">SetFixedWidth</a> 324 </th> 325 <td>Specifies the character width to use when drawing fixed-width characters.</td> 326 </tr> 327 <tr> 328 <td width="100"> </td> 329 <th> 330 <a href="../../../nw/font/CharWriter/GetFixedWidth.html">GetFixedWidth</a> 331 </th> 332 <td>Specifies the character width to use when drawing fixed-width characters.</td> 333 </tr> 334 <tr> 335 <th class="category" colspan="3">Text Drawing</th> 336 </tr> 337 <tr> 338 <td width="100"> </td> 339 <th> 340 <a href="../../../nw/font/CharWriter/Print.html">Print</a> 341 </th> 342 <td>Draws the characters.</td> 343 </tr> 344 <tr> 345 <td width="100"> </td> 346 <th> 347 <a href="../../../nw/font/CharWriter/DrawGlyph.html">DrawGlyph</a> 348 </th> 349 <td>Draws glyphs.</td> 350 </tr> 351 <tr> 352 <th class="category" colspan="3">Cursor</th> 353 </tr> 354 <tr> 355 <td width="100"> </td> 356 <th> 357 <a href="../../../nw/font/CharWriter/SetCursor.html">SetCursor</a> 358 </th> 359 <td>Sets the cursor position to the new coordinate that has been specified.</td> 360 </tr> 361 <tr> 362 <td width="100"> </td> 363 <th> 364 <a href="../../../nw/font/CharWriter/MoveCursor.html">MoveCursor</a> 365 </th> 366 <td>Moves the cursor from its current position by the distance specified.</td> 367 </tr> 368 <tr> 369 <td width="100"> </td> 370 <th> 371 <a href="../../../nw/font/CharWriter/SetCursorX.html">SetCursorX</a> 372 </th> 373 <td>This function sets the x-coordinate of the cursor.</td> 374 </tr> 375 <tr> 376 <td width="100"> </td> 377 <th> 378 <a href="../../../nw/font/CharWriter/SetCursorY.html">SetCursorY</a> 379 </th> 380 <td>This function sets the y-coordinate of the cursor.</td> 381 </tr> 382 <tr> 383 <td width="100"> </td> 384 <th> 385 <a href="../../../nw/font/CharWriter/SetCursorZ.html">SetCursorZ</a> 386 </th> 387 <td>This function sets the z-coordinate of the cursor.</td> 388 </tr> 389 <tr> 390 <td width="100"> </td> 391 <th> 392 <a href="../../../nw/font/CharWriter/MoveCursorX.html">MoveCursorX</a> 393 </th> 394 <td>Moves the cursor from its current position by the distance specified.</td> 395 </tr> 396 <tr> 397 <td width="100"> </td> 398 <th> 399 <a href="../../../nw/font/CharWriter/MoveCursorY.html">MoveCursorY</a> 400 </th> 401 <td>Moves the cursor from its current position by the distance specified.</td> 402 </tr> 403 <tr> 404 <td width="100"> </td> 405 <th> 406 <a href="../../../nw/font/CharWriter/MoveCursorZ.html">MoveCursorZ</a> 407 </th> 408 <td>Moves the cursor from its current position by the distance specified.</td> 409 </tr> 410 <tr> 411 <td width="100"> </td> 412 <th> 413 <a href="../../../nw/font/CharWriter/GetCursorX.html">GetCursorX</a> 414 </th> 415 <td>This function gets the x-coordinate of the cursor.</td> 416 </tr> 417 <tr> 418 <td width="100"> </td> 419 <th> 420 <a href="../../../nw/font/CharWriter/GetCursorY.html">GetCursorY</a> 421 </th> 422 <td>This function gets the y-coordinate of the cursor.</td> 423 </tr> 424 <tr> 425 <td width="100"> </td> 426 <th> 427 <a href="../../../nw/font/CharWriter/GetCursorZ.html">GetCursorZ</a> 428 </th> 429 <td>This function gets the z-coordinate of the cursor.</td> 430 </tr> 431 <tr> 432 <th class="category" colspan="3">Set/Get Shader-related</th> 433 </tr> 434 <tr> 435 <td width="100"> </td> 436 <th> 437 <a href="../../../nw/font/CharWriter/GetTextWriterResource.html">GetTextWriterResource</a> 438 </th> 439 <td>Gets the <CODE>TextWriterResource</CODE> instance.</td> 440 </tr> 441 <tr> 442 <td width="100"> </td> 443 <th> 444 <a href="../../../nw/font/CharWriter/SetTextWriterResource.html">SetTextWriterResource</a> 445 </th> 446 <td>Sets the <CODE>TextWriterResource</CODE>instance.</td> 447 </tr> 448 <tr> 449 <th class="category" colspan="3">Buffer for character string display</th> 450 </tr> 451 <tr> 452 <td width="100"> </td> 453 <th> 454 <a href="../../../nw/font/CharWriter/GetDispStringBuffer.html">GetDispStringBuffer</a> 455 </th> 456 <td>Gets the buffer for displaying a string.</td> 457 </tr> 458 <tr> 459 <td width="100"> </td> 460 <th> 461 <a href="../../../nw/font/CharWriter/SetDispStringBuffer.html">SetDispStringBuffer</a> 462 </th> 463 <td>Sets the buffer for displaying a string. When <CODE>NULL</CODE> is set, the string display buffer is no longer in use</td> 464 </tr> 465 <tr> 466 <td width="100"> </td> 467 <th> 468 <a href="../../../nw/font/CharWriter/StartPrint.html">StartPrint</a> 469 </th> 470 <td>Starts drawing of the character string. Used when a buffer has been configured for string display.</td> 471 </tr> 472 <tr> 473 <td width="100"> </td> 474 <th> 475 <a href="../../../nw/font/CharWriter/EndPrint.html">EndPrint</a> 476 </th> 477 <td>Ends drawing of the character string. Used when a buffer has been configured for string display.</td> 478 </tr> 479 <tr> 480 <td width="100"> </td> 481 <th> 482 <a href="../../../nw/font/CharWriter/UseCommandBuffer.html">UseCommandBuffer</a> 483 </th> 484 <td>Adds the string display-use command buffer to the current command list.</td> 485 </tr> 486 <tr> 487 <td width="100"> 488 <span class="static_style" title="static">S</span> </td> 489 <th> 490 <a href="../../../nw/font/CharWriter/GetDispStringBufferSize.html">GetDispStringBufferSize</a> 491 </th> 492 <td>Calculates the size of the buffer for string display.</td> 493 </tr> 494 <tr> 495 <td width="100"> 496 <span class="static_style" title="static">S</span> </td> 497 <th> 498 <a href="../../../nw/font/CharWriter/InitDispStringBuffer.html">InitDispStringBuffer</a> 499 </th> 500 <td>Initializes a buffer for string display.</td> 501 </tr> </table> 502 </div> 503 </a> 504 <h2>Revision History</h2> 505 <div class="section"> 506 <dl class="history"> 507 <dt>2009/11/09</dt> 508 <dd>Initial version.<br /> 509 </dd> 510 </dl> 511 </div> 512 <hr><p>CONFIDENTIAL</p></body> 513</html> 514