nn::font::CTR::CharWriter Class

Syntax

class CharWriter

Description

A class that draws characters using the Font class.

Enumerated Types

GradationMode An enum indicating types of gradation.

Member Functions

Constructors and Destructors
CharWriter Constructor.
~CharWriter Destructor.
Fonts
SetFont Sets the font.
GetFont Gets the font.
Character Drawing Preparation
SetupGX Prepares to draw characters.
S FinalizeGX Runs post-processing for drawing settings.
Linear Transformation of Glyph Colors
SetColorMapping Sets the linear conversion for glyph colors used while drawing characters.
GetColorMappingMin Gets the converted value for 0 in each component when a linear transformation is applied to the glyph color.
GetColorMappingMax Gets the converted value for 255 in each component when a linear transformation is applied to the glyph color.
ResetColorMapping Sets the system to not perform linear conversion of glyph colors while drawing characters.
Character Color / Gradation
SetAlpha Sets the alpha value to be added when drawing characters.
GetAlpha Gets the alpha value to be added when drawing characters.
SetGradationMode Sets the gradation mode.
GetGradationMode Gets the gradation mode.
SetTextColor Sets the character and gradation color.
GetTextColor Gets the text character color.
GetGradationStartColor Gets the gradation start color.
GetGradationEndColor Gets the gradation end color.
Enlarging/Reducing Characters
SetScale Specifies the enlargement factor to use for a character.
GetScaleH Returns the enlargement factor for the horizontal axis of the character.
GetScaleV Returns the enlargement factor for the vertical axis of the character.
SetFontSize Specifies the character size.
GetFontWidth Returns the cell width after enlargement.
GetFontHeight Gets the cell height after enlargement.
GetFontAscent Gets the font ascent after enlargment.
GetFontDescent Gets the font descent after enlargement.
Drawing Fixed-Width Characters
EnableFixedWidth Setting to draw fixed-width characters.
IsWidthFixed Determines whether characters are drawn as fixed-width.
SetFixedWidth Specifies the character width to use when drawing fixed-width characters.
GetFixedWidth Specifies the character width to use when drawing fixed-width characters.
Text Drawing
Print Draws a character.
DrawGlyph Draws a glyph.
Cursor
SetCursor Sets the cursor position to the new coordinate that has been specified.
MoveCursor Moves the cursor from its current position by the distance specified.
SetCursorX This function sets the x-coordinate of the cursor.
SetCursorY This function sets the y-coordinate of the cursor.
SetCursorZ This function sets the z-coordinate of the cursor.
MoveCursorX Moves the cursor from its current position by the distance specified.
MoveCursorY Moves the cursor from its current position by the distance specified.
MoveCursorZ Moves the cursor from its current position by the distance specified.
GetCursorX This function gets the x-coordinate of the cursor.
GetCursorY This function gets the y-coordinate of the cursor.
GetCursorZ This function gets the z-coordinate of the cursor.
Shader-Related Getters and Setters
GetTextWriterResource Gets a TextWriterResource instance.
SetTextWriterResource Sets a TextWriterResource instance.
A buffer used to display strings.
GetDispStringBuffer Gets the buffer used to display strings.
SetDispStringBuffer Sets the buffer used to display strings. If a value of NULL is set, the buffer is no longer used to display strings.
StartPrint Starts drawing a string. This is used when a buffer has been set for displaying strings.
EndPrint Stops drawing a string. This is used when a buffer has been set for displaying strings.
UseCommandBuffer Adds the command buffer for string rendering to the current command list.
S GetDispStringBufferSize Calculates the size of the buffer to use for displaying strings.
S InitDispStringBuffer Initializes the buffer used to display strings.

Revision History

2010/11/10
Initial version.

CONFIDENTIAL