A basic rendering primitive used to draw text using a 16x16 character map at a given location on-screen. More...

Inheritance diagram for GameAPI.BudgetBoy.Text:

Public Member Functions
	Text (Image charMap, SwatchIndex swatchIndex, Vector2F position=default(Vector2F))
	Constructs a renderable text display using an image of 256 characters arranged in a 16x16 grid. More...

override void	Render (Graphics graphics)
	Render to screen. More...

Public Member Functions inherited from GameAPI.BudgetBoy.Sprite
	Sprite (Image image, SwatchIndex swatchIndex, Vector2F position=default(Vector2F))
	Constructs a new sprite using the specified Image and SwatchIndex. More...

Properties
int	WrapWidth `[get, set]`
	Maximum number of characters in a line before it wraps. More...

int	TabAlignment `[get, set]`
	Number of characters between each tab level. More...

Vector2I	CharSize `[get]`
	Size of each monospaced character. More...

String	Value `[get, set]`
	The text to display. If null, nothing will be displayed. More...

override Vector2I	Size `[get]`
	Bounds of the displayed text. More...

Properties inherited from GameAPI.BudgetBoy.Sprite
Image	Image `[get, set]`
	The Image used for this sprite. More...

Vector2F	Position `[get, set]`
	World space position. More...

float	X `[get, set]`
	World space x-position. More...

float	Y `[get, set]`
	World space y-position. More...

virtual Vector2I	Size `[get]`
	Width and Height of this sprite's Image. More...

int	Width `[get]`
	Width of this sprite's Image. More...

int	Height `[get]`
	Height of this sprite's Image. More...

bool	FlipX `[get, set]`
	Determines whether this sprite's Image is drawn flipped along the x-axis. More...

bool	FlipY `[get, set]`
	Determines whether this sprite's Image is drawn flipped along the y-axis. More...

int	Orientation `[get, set]`
	Local integer rotation. (0 = no rotation, 1 = 90° counter-clockwise, 2 = 180°, 3 = 90° clockwise) More...

bool	IsVisible `[get, set]`
	Is this sprite visible? More...

SwatchIndex	SwatchIndex `[get, set]`
	Swatch index from the palette to render with. More...

Additional Inherited Members
Protected Member Functions inherited from GameAPI.BudgetBoy.Sprite
void	GetGlare (Graphics graphics, out Color24 avgColor, out float coverage)

Detailed Description

A basic rendering primitive used to draw text using a 16x16 character map at a given location on-screen.

Constructor & Destructor Documentation

inline

Constructs a renderable text display using an image of 256 characters arranged in a 16x16 grid.

Parameters

charMap	The font Image.
swatchIndex	The swatch colors to use when displaying the text.
position	The initial position of this text.

override void GameAPI.BudgetBoy.Text.Render ( Graphics graphics )

inlinevirtual

Render to screen.

Parameters

graphics The Graphics context to render with.

Vector2I GameAPI.BudgetBoy.Text.CharSize

get

Size of each monospaced character.

override Vector2I GameAPI.BudgetBoy.Text.Size

get

Bounds of the displayed text.

int GameAPI.BudgetBoy.Text.TabAlignment

getset

Number of characters between each tab level.

String GameAPI.BudgetBoy.Text.Value

getset

The text to display. If null, nothing will be displayed.

int GameAPI.BudgetBoy.Text.WrapWidth

getset

Maximum number of characters in a line before it wraps.