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