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