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