ScummVM API documentation
Ultima::Ultima2::Gfx::TextFont Class Reference

#include <text.h>

Inheritance diagram for Ultima::Ultima2::Gfx::TextFont:
Graphics::DosFont Graphics::Font

Public Member Functions

void drawChar (Graphics::Surface *dst, uint32 chr, int x, int y, uint32 color) const override
 
- Public Member Functions inherited from Graphics::DosFont
int getFontHeight () const override
 
int getMaxCharWidth () const override
 
int getCharWidth (uint32 chr) const override
 
void drawChar (Graphics::Surface *dst, uint32 chr, int x, int y, uint32 color) const override
 
void drawChar (Graphics::ManagedSurface *dst, uint32 chr, int x, int y, uint32 color) const override
 
- Public Member Functions inherited from Graphics::Font
virtual int getFontHeight () const =0
 
virtual Common::String getFontName () const
 
virtual int getFontAscent () const
 
virtual int getFontDescent () const
 
virtual int getFontLeading () const
 
virtual int getMaxCharWidth () const =0
 
virtual int getCharWidth (uint32 chr) const =0
 
virtual int getKerningOffset (uint32 left, uint32 right) const
 
virtual Common::Rect getBoundingBox (uint32 chr) const
 
Common::Rect getBoundingBox (const Common::String &str, int x=0, int y=0, const int w=0, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false, bool allowCharClipping=false) const
 
Common::Rect getBoundingBox (const Common::U32String &str, int x=0, int _y=0, const int w=0, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false, bool allowCharClipping=false) const
 
virtual void drawChar (Surface *dst, uint32 chr, int x, int y, uint32 color) const =0
 
virtual void drawChar (ManagedSurface *dst, uint32 chr, int x, int y, uint32 color) const
 
virtual void drawAlphaChar (Surface *dst, uint32 chr, int x, int y, uint32 color) const
 
virtual void drawAlphaChar (ManagedSurface *dst, uint32 chr, int x, int y, uint32 color) const
 
void drawString (Surface *dst, const Common::String &str, int x, int y, int w, uint32 color, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false, bool allowCharClipping=false) const
 
void drawString (Surface *dst, const Common::U32String &str, int x, int y, int w, uint32 color, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false, bool allowCharClipping=false) const
 
void drawString (ManagedSurface *dst, const Common::String &str, int x, int _y, int w, uint32 color, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false, bool allowCharClipping=false) const
 
void drawString (ManagedSurface *dst, const Common::U32String &str, int x, int y, int w, uint32 color, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false, bool allowCharClipping=false) const
 
void drawAlphaString (Surface *dst, const Common::String &str, int x, int y, int w, uint32 color, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false, bool allowCharClipping=false) const
 
void drawAlphaString (Surface *dst, const Common::U32String &str, int x, int y, int w, uint32 color, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false, bool allowCharClipping=false) const
 
void drawAlphaString (ManagedSurface *dst, const Common::String &str, int x, int _y, int w, uint32 color, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false, bool allowCharClipping=false) const
 
void drawAlphaString (ManagedSurface *dst, const Common::U32String &str, int x, int y, int w, uint32 color, TextAlign align=kTextAlignLeft, int deltax=0, bool useEllipsis=false, bool allowCharClipping=false) const
 
int getStringWidth (const Common::String &str) const
 
int getStringWidth (const Common::U32String &str) const
 
int wordWrapText (const Common::String &str, int maxWidth, Common::Array< Common::String > &lines, int initWidth=0, uint32 mode=kWordWrapOnExplicitNewLines) const
 
int wordWrapText (const Common::U32String &str, int maxWidth, Common::Array< Common::U32String > &lines, int initWidth=0, uint32 mode=kWordWrapOnExplicitNewLines) const
 
int wordWrapText (const Common::U32String &str, int maxWidth, Common::Array< Common::U32String > &lines, Common::Array< bool > &lineContinuation, int initWidth=0, uint32 mode=kWordWrapOnExplicitNewLines) const
 
void scaleSingleGlyph (Surface *scaleSurface, int *grayScaleMap, int grayScaleMapSize, int width, int height, int xOffset, int yOffset, int grayLevel, int chr, int srcheight, int srcwidth, float scale) const
 

Additional Inherited Members

- Static Public Attributes inherited from Graphics::DosFont
static const uint8 fontData_PCBIOS [256 *8]
 
static const uint8 fontData_ExtendedRussian [128 *8]
 

Detailed Description

The font the game's text is drawn with, which shows letters in capitals unless the upgrade's mixed case text is on

Member Function Documentation

◆ drawChar()

void Ultima::Ultima2::Gfx::TextFont::drawChar ( Graphics::Surface *  dst,
uint32  chr,
int  x,
int  y,
uint32  color 
) const
overridevirtual

Draw a character at a specific point on the surface.

Note that the point describes the top left edge point where to draw the character. This can be different from the top left edge point of the character's bounding box. For example, TTF fonts sometimes move characters like 't' by one (or more) pixels to the left to create better visual results. To query the actual bounding box of a character, use getBoundingBox.

See also
getBoundingBox

The Font implementation should take care of not drawing outside of the specified surface.

Parameters
dstThe surface to draw on.
chrThe character to draw.
xThe x coordinate where to draw the character.
yThe y coordinate where to draw the character.
colorThe color of the character.

Implements Graphics::Font.


The documentation for this class was generated from the following file: